Class UserGroupServiceHttp

Object
com.liferay.portal.service.http.UserGroupServiceHttp

public class UserGroupServiceHttp extends Object
Provides the HTTP utility for the UserGroupServiceUtil 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 void
    addGroupUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds)
     
    static com.liferay.portal.kernel.model.UserGroup
    addOrUpdateUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static void
    addTeamUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long teamId, long[] userGroupIds)
     
    static com.liferay.portal.kernel.model.UserGroup
    addUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     
    static void
    deleteUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId)
     
    static com.liferay.portal.kernel.model.UserGroup
    fetchUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId)
     
    static com.liferay.portal.kernel.model.UserGroup
    fetchUserGroupByExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String externalReferenceCode)
     
    static List<com.liferay.portal.kernel.model.UserGroup>
    getGtUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long gtUserGroupId, long companyId, long parentUserGroupId, int size)
     
    static com.liferay.portal.kernel.model.UserGroup
    getUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId)
     
    static com.liferay.portal.kernel.model.UserGroup
    getUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String name)
     
    static com.liferay.portal.kernel.model.UserGroup
    getUserGroupByExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, long companyId)
     
    static List<com.liferay.portal.kernel.model.UserGroup>
    getUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId)
     
    static List<com.liferay.portal.kernel.model.UserGroup>
    getUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, int start, int end)
     
    static int
    getUserGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name)
     
    static List<com.liferay.portal.kernel.model.UserGroup>
    getUserUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId)
     
    static List<com.liferay.portal.kernel.model.UserGroup>
    search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, 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.UserGroup> orderByComparator)
     
    static List<com.liferay.portal.kernel.model.UserGroup>
    search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.UserGroup> orderByComparator)
     
    static int
    searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)
     
    static int
    searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String keywords, LinkedHashMap<String,Object> params)
     
    static void
    unsetGroupUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds)
     
    static void
    unsetTeamUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long teamId, long[] userGroupIds)
     
    static com.liferay.portal.kernel.model.UserGroup
    updateExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, com.liferay.portal.kernel.model.UserGroup userGroup, String externalReferenceCode)
     
    static com.liferay.portal.kernel.model.UserGroup
    updateUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • UserGroupServiceHttp

      public UserGroupServiceHttp()
  • Method Details

    • addGroupUserGroups

      public static void addGroupUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateUserGroup

      public static com.liferay.portal.kernel.model.UserGroup addOrUpdateUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String externalReferenceCode, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addTeamUserGroups

      public static void addTeamUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long teamId, long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addUserGroup

      public static com.liferay.portal.kernel.model.UserGroup addUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteUserGroup

      public static void deleteUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchUserGroup

      public static com.liferay.portal.kernel.model.UserGroup fetchUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchUserGroupByExternalReferenceCode

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

      public static List<com.liferay.portal.kernel.model.UserGroup> getGtUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long gtUserGroupId, long companyId, long parentUserGroupId, int size)
    • getUserGroup

      public static com.liferay.portal.kernel.model.UserGroup getUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroup

      public static com.liferay.portal.kernel.model.UserGroup getUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroupByExternalReferenceCode

      public static com.liferay.portal.kernel.model.UserGroup getUserGroupByExternalReferenceCode(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
    • getUserGroups

      public static List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getUserGroups

      public static List<com.liferay.portal.kernel.model.UserGroup> getUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name, int start, int end)
    • getUserGroupsCount

      public static int getUserGroupsCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String name)
    • getUserUserGroups

      public static List<com.liferay.portal.kernel.model.UserGroup> getUserUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static List<com.liferay.portal.kernel.model.UserGroup> search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.portal.kernel.model.UserGroup> orderByComparator)
    • search

      public static List<com.liferay.portal.kernel.model.UserGroup> search(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, 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.UserGroup> orderByComparator)
    • searchCount

      public static int searchCount(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long companyId, 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, LinkedHashMap<String,Object> params, boolean andOperator)
    • unsetGroupUserGroups

      public static void unsetGroupUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsetTeamUserGroups

      public static void unsetTeamUserGroups(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long teamId, long[] userGroupIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static com.liferay.portal.kernel.model.UserGroup updateExternalReferenceCode(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, com.liferay.portal.kernel.model.UserGroup userGroup, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateUserGroup

      public static com.liferay.portal.kernel.model.UserGroup updateUserGroup(com.liferay.portal.kernel.security.auth.HttpPrincipal httpPrincipal, long userGroupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException