Liferay 7.0-ce-b4

com.liferay.portal.service.http
Class GroupServiceHttp

java.lang.Object
  extended by com.liferay.portal.service.http.GroupServiceHttp

@ProviderType
public class GroupServiceHttp
extends Object

Provides the HTTP utility for the GroupServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

See Also:
GroupServiceSoap, HttpPrincipal, GroupServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
GroupServiceHttp()
           
 
Method Summary
static Group addGroup(HttpPrincipal httpPrincipal, long parentGroupId, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
static Group addGroup(HttpPrincipal httpPrincipal, long parentGroupId, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
           
static Group addGroup(HttpPrincipal httpPrincipal, long parentGroupId, long liveGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
           
static void addRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
           
static void checkRemoteStagingGroup(HttpPrincipal httpPrincipal, long groupId)
           
static void deleteGroup(HttpPrincipal httpPrincipal, long groupId)
           
static void disableStaging(HttpPrincipal httpPrincipal, long groupId)
           
static void enableStaging(HttpPrincipal httpPrincipal, long groupId)
           
static Group getCompanyGroup(HttpPrincipal httpPrincipal, long companyId)
           
static Group getGroup(HttpPrincipal httpPrincipal, long groupId)
           
static Group getGroup(HttpPrincipal httpPrincipal, long companyId, String groupKey)
           
static String getGroupDisplayURL(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, boolean secureConnection)
           
static List<Group> getGroups(HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site)
           
static List<Group> getManageableSiteGroups(HttpPrincipal httpPrincipal, Collection<Portlet> portlets, int max)
           
static List<Group> getOrganizationsGroups(HttpPrincipal httpPrincipal, List<Organization> organizations)
           
static Group getUserGroup(HttpPrincipal httpPrincipal, long companyId, long userId)
           
static List<Group> getUserGroupsGroups(HttpPrincipal httpPrincipal, List<UserGroup> userGroups)
           
static List<Group> getUserOrganizationsGroups(HttpPrincipal httpPrincipal, long userId, int start, int end)
           
static List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal)
           
static List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal, long userId, String[] classNames, int max)
           
static List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal, String[] classNames, int max)
           
static int getUserSitesGroupsCount(HttpPrincipal httpPrincipal)
           
static boolean hasUserGroup(HttpPrincipal httpPrincipal, long userId, long groupId)
           
static List<Group> search(HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
           
static List<Group> search(HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)
           
static List<Group> search(HttpPrincipal httpPrincipal, long companyId, String name, String description, String[] params, int start, int end)
           
static int searchCount(HttpPrincipal httpPrincipal, long companyId, String name, String description, String[] params)
           
static void setRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
           
static void unsetRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
           
static Group updateFriendlyURL(HttpPrincipal httpPrincipal, long groupId, String friendlyURL)
           
static Group updateGroup(HttpPrincipal httpPrincipal, long groupId, long parentGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
static Group updateGroup(HttpPrincipal httpPrincipal, long groupId, long parentGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
static Group updateGroup(HttpPrincipal httpPrincipal, long groupId, String typeSettings)
           
static void updateStagedPortlets(HttpPrincipal httpPrincipal, long groupId, Map<String,String> stagedPortletIds)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupServiceHttp

public GroupServiceHttp()
Method Detail

addGroup

public static Group addGroup(HttpPrincipal httpPrincipal,
                             long parentGroupId,
                             long liveGroupId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             String friendlyURL,
                             boolean site,
                             boolean inheritContent,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

addGroup

public static Group addGroup(HttpPrincipal httpPrincipal,
                             long parentGroupId,
                             long liveGroupId,
                             Map<Locale,String> nameMap,
                             Map<Locale,String> descriptionMap,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

addGroup

public static Group addGroup(HttpPrincipal httpPrincipal,
                             long parentGroupId,
                             long liveGroupId,
                             String name,
                             String description,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

addRoleGroups

public static void addRoleGroups(HttpPrincipal httpPrincipal,
                                 long roleId,
                                 long[] groupIds)
                          throws PortalException
Throws:
PortalException

checkRemoteStagingGroup

public static void checkRemoteStagingGroup(HttpPrincipal httpPrincipal,
                                           long groupId)
                                    throws PortalException
Throws:
PortalException

deleteGroup

public static void deleteGroup(HttpPrincipal httpPrincipal,
                               long groupId)
                        throws PortalException
Throws:
PortalException

disableStaging

public static void disableStaging(HttpPrincipal httpPrincipal,
                                  long groupId)
                           throws PortalException
Throws:
PortalException

enableStaging

public static void enableStaging(HttpPrincipal httpPrincipal,
                                 long groupId)
                          throws PortalException
Throws:
PortalException

getCompanyGroup

public static Group getCompanyGroup(HttpPrincipal httpPrincipal,
                                    long companyId)
                             throws PortalException
Throws:
PortalException

getGroup

public static Group getGroup(HttpPrincipal httpPrincipal,
                             long groupId)
                      throws PortalException
Throws:
PortalException

getGroup

public static Group getGroup(HttpPrincipal httpPrincipal,
                             long companyId,
                             String groupKey)
                      throws PortalException
Throws:
PortalException

getGroupDisplayURL

public static String getGroupDisplayURL(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        boolean privateLayout,
                                        boolean secureConnection)
                                 throws PortalException
Throws:
PortalException

getGroups

public static List<Group> getGroups(HttpPrincipal httpPrincipal,
                                    long companyId,
                                    long parentGroupId,
                                    boolean site)
                             throws PortalException
Throws:
PortalException

getManageableSiteGroups

public static List<Group> getManageableSiteGroups(HttpPrincipal httpPrincipal,
                                                  Collection<Portlet> portlets,
                                                  int max)
                                           throws PortalException
Throws:
PortalException

getOrganizationsGroups

public static List<Group> getOrganizationsGroups(HttpPrincipal httpPrincipal,
                                                 List<Organization> organizations)
                                          throws PortalException
Throws:
PortalException

getUserGroup

public static Group getUserGroup(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 long userId)
                          throws PortalException
Throws:
PortalException

getUserGroupsGroups

public static List<Group> getUserGroupsGroups(HttpPrincipal httpPrincipal,
                                              List<UserGroup> userGroups)
                                       throws PortalException
Throws:
PortalException

getUserOrganizationsGroups

public static List<Group> getUserOrganizationsGroups(HttpPrincipal httpPrincipal,
                                                     long userId,
                                                     int start,
                                                     int end)
                                              throws PortalException
Throws:
PortalException

getUserSitesGroups

public static List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal)
                                      throws PortalException
Throws:
PortalException

getUserSitesGroups

public static List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal,
                                             long userId,
                                             String[] classNames,
                                             int max)
                                      throws PortalException
Throws:
PortalException

getUserSitesGroups

public static List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal,
                                             String[] classNames,
                                             int max)
                                      throws PortalException
Throws:
PortalException

getUserSitesGroupsCount

public static int getUserSitesGroupsCount(HttpPrincipal httpPrincipal)
                                   throws PortalException
Throws:
PortalException

hasUserGroup

public static boolean hasUserGroup(HttpPrincipal httpPrincipal,
                                   long userId,
                                   long groupId)
                            throws PortalException
Throws:
PortalException

search

public static List<Group> search(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 long[] classNameIds,
                                 String keywords,
                                 LinkedHashMap<String,Object> params,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
                          throws PortalException
Throws:
PortalException

search

public static List<Group> search(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 long[] classNameIds,
                                 String name,
                                 String description,
                                 LinkedHashMap<String,Object> params,
                                 boolean andOperator,
                                 int start,
                                 int end,
                                 OrderByComparator<Group> obc)
                          throws PortalException
Throws:
PortalException

search

public static List<Group> search(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 String name,
                                 String description,
                                 String[] params,
                                 int start,
                                 int end)
                          throws PortalException
Throws:
PortalException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              String name,
                              String description,
                              String[] params)

setRoleGroups

public static void setRoleGroups(HttpPrincipal httpPrincipal,
                                 long roleId,
                                 long[] groupIds)
                          throws PortalException
Throws:
PortalException

unsetRoleGroups

public static void unsetRoleGroups(HttpPrincipal httpPrincipal,
                                   long roleId,
                                   long[] groupIds)
                            throws PortalException
Throws:
PortalException

updateFriendlyURL

public static Group updateFriendlyURL(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      String friendlyURL)
                               throws PortalException
Throws:
PortalException

updateGroup

public static Group updateGroup(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentGroupId,
                                Map<Locale,String> nameMap,
                                Map<Locale,String> descriptionMap,
                                int type,
                                boolean manualMembership,
                                int membershipRestriction,
                                String friendlyURL,
                                boolean inheritContent,
                                boolean active,
                                ServiceContext serviceContext)
                         throws PortalException
Throws:
PortalException

updateGroup

public static Group updateGroup(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentGroupId,
                                String name,
                                String description,
                                int type,
                                boolean manualMembership,
                                int membershipRestriction,
                                String friendlyURL,
                                boolean inheritContent,
                                boolean active,
                                ServiceContext serviceContext)
                         throws PortalException
Throws:
PortalException

updateGroup

public static Group updateGroup(HttpPrincipal httpPrincipal,
                                long groupId,
                                String typeSettings)
                         throws PortalException
Throws:
PortalException

updateStagedPortlets

public static void updateStagedPortlets(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        Map<String,String> stagedPortletIds)
                                 throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4