Class GroupServiceHttp

Object
com.liferay.portal.service.http.GroupServiceHttp

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.

Author:
Brian Wing Shun Chan
{$generated.description}
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static com.liferay.portal.kernel.model.Group
    addGroup(com.liferay.portal.kernel.security.auth.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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static com.liferay.portal.kernel.model.Group
    addGroup(com.liferay.portal.kernel.security.auth.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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static com.liferay.portal.kernel.model.Group
    addOrUpdateGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, 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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static void
    addRoleGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
     
    static void
    checkRemoteStagingGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId)
     
    static void
    deleteGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId)
     
    static void
    disableStaging(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId)
     
    static void
    enableStaging(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId)
     
    static com.liferay.portal.kernel.model.Group
    fetchGroupByExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, long companyId)
     
    static com.liferay.portal.kernel.model.Group
    getCompanyGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId)
     
    static com.liferay.portal.kernel.model.Group
    getGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId)
     
    static com.liferay.portal.kernel.model.Group
    getGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String groupKey)
     
    static String
    getGroupDisplayURL(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, boolean secureConnection)
     
    static List<com.liferay.portal.kernel.model.Group>
    getGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site)
     
    static List<com.liferay.portal.kernel.model.Group>
    getGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site, int start, int end)
     
    static List<com.liferay.portal.kernel.model.Group>
    getGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, String name, boolean site, int start, int end)
     
    static int
    getGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site)
     
    static int
    getGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, String name, boolean site)
     
    static int
    getGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String className, long parentGroupId)
     
    static List<com.liferay.portal.kernel.model.Group>
    getGtGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long gtGroupId, long companyId, long parentGroupId, boolean site, int size)
     
    static List<com.liferay.portal.kernel.model.Group>
    getManageableSiteGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, Collection<com.liferay.portal.kernel.model.Portlet> portlets, int max)
     
    static List<com.liferay.portal.kernel.model.Group>
    getOrganizationsGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, List<com.liferay.portal.kernel.model.Organization> organizations)
     
    static com.liferay.portal.kernel.model.Group
    getUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long userId)
     
    static List<com.liferay.portal.kernel.model.Group>
    getUserGroupsGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, List<com.liferay.portal.kernel.model.UserGroup> userGroups)
     
    static List<com.liferay.portal.kernel.model.Group>
    getUserOrganizationsGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, int start, int end)
     
    static List<com.liferay.portal.kernel.model.Group>
    getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal)
     
    static List<com.liferay.portal.kernel.model.Group>
    getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, int start, int end)
     
    static List<com.liferay.portal.kernel.model.Group>
    getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, String[] classNames, int max)
     
    static List<com.liferay.portal.kernel.model.Group>
    getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String[] classNames, int max)
     
    static int
    getUserSitesGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal)
     
    static boolean
    hasUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, long groupId)
     
    static List<com.liferay.portal.kernel.model.Group>
    search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> orderByComparator)
     
    static List<com.liferay.portal.kernel.model.Group>
    search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> orderByComparator)
     
    static List<com.liferay.portal.kernel.model.Group>
    search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, String description, String[] params, int start, int end)
     
    static int
    searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params)
     
    static int
    searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, String description, String[] params)
     
    static void
    setRoleGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
     
    static void
    unsetRoleGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
     
    static com.liferay.portal.kernel.model.Group
    updateFriendlyURL(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, String friendlyURL)
     
    static com.liferay.portal.kernel.model.Group
    updateGroup(com.liferay.portal.kernel.security.auth.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, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static com.liferay.portal.kernel.model.Group
    updateGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, String typeSettings)
     
    static void
    updateStagedPortlets(com.liferay.portal.kernel.security.auth.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 Details

    • GroupServiceHttp

      public GroupServiceHttp()
  • Method Details

    • addGroup

      public static com.liferay.portal.kernel.model.Group addGroup(com.liferay.portal.kernel.security.auth.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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addGroup

      public static com.liferay.portal.kernel.model.Group addGroup(com.liferay.portal.kernel.security.auth.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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateGroup

      public static com.liferay.portal.kernel.model.Group addOrUpdateGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, 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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws Exception
      Throws:
      Exception
    • addRoleGroups

      public static void addRoleGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long roleId, long[] groupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkRemoteStagingGroup

      public static void checkRemoteStagingGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteGroup

      public static void deleteGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • disableStaging

      public static void disableStaging(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • enableStaging

      public static void enableStaging(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchGroupByExternalReferenceCode

      public static com.liferay.portal.kernel.model.Group fetchGroupByExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCompanyGroup

      public static com.liferay.portal.kernel.model.Group getCompanyGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroup

      public static com.liferay.portal.kernel.model.Group getGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroup

      public static com.liferay.portal.kernel.model.Group getGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String groupKey) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroupDisplayURL

      public static String getGroupDisplayURL(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, boolean secureConnection) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroups

      public static List<com.liferay.portal.kernel.model.Group> getGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroups

      public static List<com.liferay.portal.kernel.model.Group> getGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroups

      public static List<com.liferay.portal.kernel.model.Group> getGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, String name, boolean site, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroupsCount

      public static int getGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroupsCount

      public static int getGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long parentGroupId, String name, boolean site) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGroupsCount

      public static int getGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String className, long parentGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getGtGroups

      public static List<com.liferay.portal.kernel.model.Group> getGtGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long gtGroupId, long companyId, long parentGroupId, boolean site, int size) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getManageableSiteGroups

      public static List<com.liferay.portal.kernel.model.Group> getManageableSiteGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, Collection<com.liferay.portal.kernel.model.Portlet> portlets, int max) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getOrganizationsGroups

      public static List<com.liferay.portal.kernel.model.Group> getOrganizationsGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, List<com.liferay.portal.kernel.model.Organization> organizations) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroup

      public static com.liferay.portal.kernel.model.Group getUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroupsGroups

      public static List<com.liferay.portal.kernel.model.Group> getUserGroupsGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, List<com.liferay.portal.kernel.model.UserGroup> userGroups) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserOrganizationsGroups

      public static List<com.liferay.portal.kernel.model.Group> getUserOrganizationsGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserSitesGroups

      public static List<com.liferay.portal.kernel.model.Group> getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserSitesGroups

      public static List<com.liferay.portal.kernel.model.Group> getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserSitesGroups

      public static List<com.liferay.portal.kernel.model.Group> getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, String[] classNames, int max) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserSitesGroups

      public static List<com.liferay.portal.kernel.model.Group> getUserSitesGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String[] classNames, int max) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserSitesGroupsCount

      public static int getUserSitesGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • hasUserGroup

      public static boolean hasUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static List<com.liferay.portal.kernel.model.Group> search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static List<com.liferay.portal.kernel.model.Group> search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.Group> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static List<com.liferay.portal.kernel.model.Group> search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, String description, String[] params, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchCount

      public static int searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params)
    • searchCount

      public static int searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, String description, String[] params)
    • setRoleGroups

      public static void setRoleGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long roleId, long[] groupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetRoleGroups

      public static void unsetRoleGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long roleId, long[] groupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFriendlyURL

      public static com.liferay.portal.kernel.model.Group updateFriendlyURL(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, String friendlyURL) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateGroup

      public static com.liferay.portal.kernel.model.Group updateGroup(com.liferay.portal.kernel.security.auth.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, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateGroup

      public static com.liferay.portal.kernel.model.Group updateGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, String typeSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStagedPortlets

      public static void updateStagedPortlets(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, Map<String,String> stagedPortletIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException