com.liferay.portal.service.http
Class GroupServiceHttp

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

public class GroupServiceHttp
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.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 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, GroupServiceUtil, GroupServiceSoap

Constructor Summary

GroupServiceHttp()

Method Summary

static com.liferay.portal.model.Group	addGroup(HttpPrincipal httpPrincipal, long liveGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
static com.liferay.portal.model.Group	addGroup(HttpPrincipal httpPrincipal, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
static void	addRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
static void	deleteGroup(HttpPrincipal httpPrincipal, long groupId)
static com.liferay.portal.model.Group	getGroup(HttpPrincipal httpPrincipal, long groupId)
static com.liferay.portal.model.Group	getGroup(HttpPrincipal httpPrincipal, long companyId, java.lang.String name)
static java.util.List<com.liferay.portal.model.Group>	getManageableGroups(HttpPrincipal httpPrincipal, long userId, java.lang.String actionId)
static java.util.List<com.liferay.portal.model.Group>	getOrganizationsGroups(HttpPrincipal httpPrincipal, java.util.List<com.liferay.portal.model.Organization> organizations)
static com.liferay.portal.model.Group	getUserGroup(HttpPrincipal httpPrincipal, long companyId, long userId)
static java.util.List<com.liferay.portal.model.Group>	getUserGroupsGroups(HttpPrincipal httpPrincipal, java.util.List<com.liferay.portal.model.UserGroup> userGroups)
static java.util.List<com.liferay.portal.model.Group>	getUserOrganizationsGroups(HttpPrincipal httpPrincipal, long userId, int start, int end)
static boolean	hasUserGroup(HttpPrincipal httpPrincipal, long userId, long groupId)
static java.util.List<com.liferay.portal.model.Group>	search(HttpPrincipal httpPrincipal, long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, int start, int end)
static int	searchCount(HttpPrincipal httpPrincipal, long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params)
static void	setRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
static void	unsetRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
static com.liferay.portal.model.Group	updateFriendlyURL(HttpPrincipal httpPrincipal, long groupId, java.lang.String friendlyURL)
static com.liferay.portal.model.Group	updateGroup(HttpPrincipal httpPrincipal, long groupId, java.lang.String typeSettings)
static com.liferay.portal.model.Group	updateGroup(HttpPrincipal httpPrincipal, long groupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
static com.liferay.portal.model.Group	updateWorkflow(HttpPrincipal httpPrincipal, long groupId, boolean workflowEnabled, int workflowStages, java.lang.String workflowRoleNames)

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 com.liferay.portal.model.Group addGroup(HttpPrincipal httpPrincipal,
                                                      java.lang.String name,
                                                      java.lang.String description,
                                                      int type,
                                                      java.lang.String friendlyURL,
                                                      boolean active)
                                               throws com.liferay.portal.PortalException,
                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addGroup

public static com.liferay.portal.model.Group addGroup(HttpPrincipal httpPrincipal,
                                                      long liveGroupId,
                                                      java.lang.String name,
                                                      java.lang.String description,
                                                      int type,
                                                      java.lang.String friendlyURL,
                                                      boolean active)
                                               throws com.liferay.portal.PortalException,
                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

addRoleGroups

public static void addRoleGroups(HttpPrincipal httpPrincipal,
                                 long roleId,
                                 long[] groupIds)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteGroup

public static void deleteGroup(HttpPrincipal httpPrincipal,
                               long groupId)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroup

public static com.liferay.portal.model.Group getGroup(HttpPrincipal httpPrincipal,
                                                      long groupId)
                                               throws com.liferay.portal.PortalException,
                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getGroup

public static com.liferay.portal.model.Group getGroup(HttpPrincipal httpPrincipal,
                                                      long companyId,
                                                      java.lang.String name)
                                               throws com.liferay.portal.PortalException,
                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getManageableGroups

public static java.util.List<com.liferay.portal.model.Group> getManageableGroups(HttpPrincipal httpPrincipal,
                                                                                 long userId,
                                                                                 java.lang.String actionId)
                                                                          throws com.liferay.portal.PortalException,
                                                                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getOrganizationsGroups

public static java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(HttpPrincipal httpPrincipal,
                                                                                    java.util.List<com.liferay.portal.model.Organization> organizations)
                                                                             throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getUserGroup

public static com.liferay.portal.model.Group getUserGroup(HttpPrincipal httpPrincipal,
                                                          long companyId,
                                                          long userId)
                                                   throws com.liferay.portal.PortalException,
                                                          com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserGroupsGroups

public static java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(HttpPrincipal httpPrincipal,
                                                                                 java.util.List<com.liferay.portal.model.UserGroup> userGroups)
                                                                          throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getUserOrganizationsGroups

public static java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups(HttpPrincipal httpPrincipal,
                                                                                        long userId,
                                                                                        int start,
                                                                                        int end)
                                                                                 throws com.liferay.portal.PortalException,
                                                                                        com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

hasUserGroup

public static boolean hasUserGroup(HttpPrincipal httpPrincipal,
                                   long userId,
                                   long groupId)
                            throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

search

public static java.util.List<com.liferay.portal.model.Group> search(HttpPrincipal httpPrincipal,
                                                                    long companyId,
                                                                    java.lang.String name,
                                                                    java.lang.String description,
                                                                    java.lang.String[] params,
                                                                    int start,
                                                                    int end)
                                                             throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.String[] params)
                       throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

setRoleGroups

public static void setRoleGroups(HttpPrincipal httpPrincipal,
                                 long roleId,
                                 long[] groupIds)
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

unsetRoleGroups

public static void unsetRoleGroups(HttpPrincipal httpPrincipal,
                                   long roleId,
                                   long[] groupIds)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateFriendlyURL

public static com.liferay.portal.model.Group updateFriendlyURL(HttpPrincipal httpPrincipal,
                                                               long groupId,
                                                               java.lang.String friendlyURL)
                                                        throws com.liferay.portal.PortalException,
                                                               com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateGroup

public static com.liferay.portal.model.Group updateGroup(HttpPrincipal httpPrincipal,
                                                         long groupId,
                                                         java.lang.String name,
                                                         java.lang.String description,
                                                         int type,
                                                         java.lang.String friendlyURL,
                                                         boolean active)
                                                  throws com.liferay.portal.PortalException,
                                                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateGroup

public static com.liferay.portal.model.Group updateGroup(HttpPrincipal httpPrincipal,
                                                         long groupId,
                                                         java.lang.String typeSettings)
                                                  throws com.liferay.portal.PortalException,
                                                         com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

updateWorkflow

public static com.liferay.portal.model.Group updateWorkflow(HttpPrincipal httpPrincipal,
                                                            long groupId,
                                                            boolean workflowEnabled,
                                                            int workflowStages,
                                                            java.lang.String workflowRoleNames)
                                                     throws com.liferay.portal.PortalException,
                                                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException