com.liferay.portal.service.http
Class UserGroupServiceHttp

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

public class UserGroupServiceHttp
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a HTTP utility for the com.liferay.portal.service.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 com.liferay.portal.security.auth.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:
HttpPrincipal, UserGroupServiceUtil, UserGroupServiceSoap

Constructor Summary
UserGroupServiceHttp()
           
 
Method Summary
static void addGroupUserGroups(HttpPrincipal httpPrincipal, long groupId, long[] userGroupIds)
           
static com.liferay.portal.model.UserGroup addUserGroup(HttpPrincipal httpPrincipal, java.lang.String name, java.lang.String description)
           
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 com.liferay.portal.model.UserGroup updateUserGroup(HttpPrincipal httpPrincipal, long userGroupId, java.lang.String name, java.lang.String description)
           
 
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.SystemException,
                                      com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addUserGroup

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

deleteUserGroup

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

getUserGroup

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

getUserGroup

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

getUserUserGroups

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

unsetGroupUserGroups

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

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.SystemException,
                                                                 com.liferay.portal.PortalException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException