com.liferay.portal.service.http

Class UserGroupServiceHttp

java.lang.Object

com.liferay.portal.service.http.UserGroupServiceHttp

public class UserGroupServiceHttp
extends java.lang.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

See Also:

UserGroupServiceSoap, HttpPrincipal, UserGroupServiceUtil

Generated:

Constructor Summary

Constructors

Constructor and Description
UserGroupServiceHttp()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addGroupUserGroups(HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds)
static void	addTeamUserGroups(HttpPrincipal httpPrincipal, long teamId, long[] userGroupIds)
static com.liferay.portal.model.UserGroup	addUserGroup(HttpPrincipal httpPrincipal, java.lang.String name, java.lang.String description)
static com.liferay.portal.model.UserGroup	addUserGroup(HttpPrincipal httpPrincipal, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteUserGroup(HttpPrincipal httpPrincipal, long userGroupId)
static com.liferay.portal.model.UserGroup	getUserGroup(HttpPrincipal httpPrincipal, long userGroupId)
static com.liferay.portal.model.UserGroup	getUserGroup(HttpPrincipal httpPrincipal, java.lang.String name)
static java.util.List<com.liferay.portal.model.UserGroup>	getUserUserGroups(HttpPrincipal httpPrincipal, long userId)
static void	unsetGroupUserGroups(HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds)
static void	unsetTeamUserGroups(HttpPrincipal httpPrincipal, long teamId, long[] userGroupIds)
static com.liferay.portal.model.UserGroup	updateUserGroup(HttpPrincipal httpPrincipal, long userGroupId, java.lang.String name, java.lang.String description)
static com.liferay.portal.model.UserGroup	updateUserGroup(HttpPrincipal httpPrincipal, long userGroupId, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserGroupServiceHttp

public UserGroupServiceHttp()

Method Detail

addGroupUserGroups

public static void addGroupUserGroups(HttpPrincipal httpPrincipal,
                      long groupId,
                      long[] userGroupIds)
                               throws com.liferay.portal.kernel.exception.PortalException,
                                      com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addTeamUserGroups

public static void addTeamUserGroups(HttpPrincipal httpPrincipal,
                     long teamId,
                     long[] userGroupIds)
                              throws com.liferay.portal.kernel.exception.PortalException,
                                     com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addUserGroup

public static com.liferay.portal.model.UserGroup addUserGroup(HttpPrincipal httpPrincipal,
                                              java.lang.String name,
                                              java.lang.String description)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

addUserGroup

public static com.liferay.portal.model.UserGroup addUserGroup(HttpPrincipal httpPrincipal,
                                              java.lang.String name,
                                              java.lang.String description,
                                              com.liferay.portal.service.ServiceContext serviceContext)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteUserGroup

public static void deleteUserGroup(HttpPrincipal httpPrincipal,
                   long userGroupId)
                            throws com.liferay.portal.kernel.exception.PortalException,
                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getUserGroup

public static com.liferay.portal.model.UserGroup getUserGroup(HttpPrincipal httpPrincipal,
                                              long userGroupId)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getUserGroup

public static com.liferay.portal.model.UserGroup getUserGroup(HttpPrincipal httpPrincipal,
                                              java.lang.String name)
                                                       throws com.liferay.portal.kernel.exception.PortalException,
                                                              com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getUserUserGroups

public static java.util.List<com.liferay.portal.model.UserGroup> getUserUserGroups(HttpPrincipal httpPrincipal,
                                                                   long userId)
                                                                            throws com.liferay.portal.kernel.exception.PortalException,
                                                                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

unsetGroupUserGroups

public static void unsetGroupUserGroups(HttpPrincipal httpPrincipal,
                        long groupId,
                        long[] userGroupIds)
                                 throws com.liferay.portal.kernel.exception.PortalException,
                                        com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

unsetTeamUserGroups

public static void unsetTeamUserGroups(HttpPrincipal httpPrincipal,
                       long teamId,
                       long[] userGroupIds)
                                throws com.liferay.portal.kernel.exception.PortalException,
                                       com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updateUserGroup

public static com.liferay.portal.model.UserGroup updateUserGroup(HttpPrincipal httpPrincipal,
                                                 long userGroupId,
                                                 java.lang.String name,
                                                 java.lang.String description)
                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                 com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updateUserGroup

public static com.liferay.portal.model.UserGroup updateUserGroup(HttpPrincipal httpPrincipal,
                                                 long userGroupId,
                                                 java.lang.String name,
                                                 java.lang.String description,
                                                 com.liferay.portal.service.ServiceContext serviceContext)
                                                          throws com.liferay.portal.kernel.exception.PortalException,
                                                                 com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException