com.liferay.portal.service.http

Class GroupServiceHttp

java.lang.Object

com.liferay.portal.service.http.GroupServiceHttp

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

See Also:

GroupServiceSoap

Constructor Summary

Constructors

Constructor and Description
GroupServiceHttp()

Method Summary

Modifier and Type	Method and Description
static Group	addGroup(HttpPrincipal httpPrincipal, long parentGroupId, long liveGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext)
static Group	addGroup(HttpPrincipal httpPrincipal, long parentGroupId, long liveGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
static void	addRoleGroups(HttpPrincipal httpPrincipal, long roleId, long[] groupIds)
static void	checkRemoteStagingGroup(HttpPrincipal httpPrincipal, long groupId)
static void	deleteGroup(HttpPrincipal httpPrincipal, long groupId)
static void	disableStaging(HttpPrincipal httpPrincipal, long groupId)
static void	enableStaging(HttpPrincipal httpPrincipal, long groupId)
static Group	getCompanyGroup(HttpPrincipal httpPrincipal, long companyId)
static Group	getGroup(HttpPrincipal httpPrincipal, long groupId)
static Group	getGroup(HttpPrincipal httpPrincipal, long companyId, java.lang.String groupKey)
static java.lang.String	getGroupDisplayURL(HttpPrincipal httpPrincipal, long groupId, boolean privateLayout, boolean secureConnection)
static java.util.List<Group>	getGroups(HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site)
static java.util.List<Group>	getGroups(HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site, int start, int end)
static java.util.List<Group>	getGroups(HttpPrincipal httpPrincipal, long companyId, long parentGroupId, java.lang.String name, boolean site, int start, int end)
static int	getGroupsCount(HttpPrincipal httpPrincipal, long companyId, long parentGroupId, boolean site)
static int	getGroupsCount(HttpPrincipal httpPrincipal, long companyId, long parentGroupId, java.lang.String name, boolean site)
static int	getGroupsCount(HttpPrincipal httpPrincipal, long companyId, java.lang.String className, long parentGroupId)
static java.util.List<Group>	getGtGroups(HttpPrincipal httpPrincipal, long gtGroupId, long companyId, long parentGroupId, boolean site, int size)
static java.util.List<Group>	getManageableSiteGroups(HttpPrincipal httpPrincipal, java.util.Collection<Portlet> portlets, int max)
static java.util.List<Group>	getOrganizationsGroups(HttpPrincipal httpPrincipal, java.util.List<Organization> organizations)
static Group	getUserGroup(HttpPrincipal httpPrincipal, long companyId, long userId)
static java.util.List<Group>	getUserGroupsGroups(HttpPrincipal httpPrincipal, java.util.List<UserGroup> userGroups)
static java.util.List<Group>	getUserOrganizationsGroups(HttpPrincipal httpPrincipal, long userId, int start, int end)
static java.util.List<Group>	getUserSitesGroups(HttpPrincipal httpPrincipal)
static java.util.List<Group>	getUserSitesGroups(HttpPrincipal httpPrincipal, long userId, java.lang.String[] classNames, int max)
static java.util.List<Group>	getUserSitesGroups(HttpPrincipal httpPrincipal, java.lang.String[] classNames, int max)
static int	getUserSitesGroupsCount(HttpPrincipal httpPrincipal)
static boolean	hasUserGroup(HttpPrincipal httpPrincipal, long userId, long groupId)
static java.util.List<Group>	search(HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator<Group> orderByComparator)
static java.util.List<Group>	search(HttpPrincipal httpPrincipal, long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> orderByComparator)
static java.util.List<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, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
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 Group	updateFriendlyURL(HttpPrincipal httpPrincipal, long groupId, java.lang.String friendlyURL)
static Group	updateGroup(HttpPrincipal httpPrincipal, long groupId, long parentGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
static Group	updateGroup(HttpPrincipal httpPrincipal, long groupId, java.lang.String typeSettings)
static void	updateStagedPortlets(HttpPrincipal httpPrincipal, long groupId, java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)

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 Group addGroup(HttpPrincipal httpPrincipal,
                             long parentGroupId,
                             long liveGroupId,
                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             java.lang.String friendlyURL,
                             boolean site,
                             boolean inheritContent,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

addGroup

public static Group addGroup(HttpPrincipal httpPrincipal,
                             long parentGroupId,
                             long liveGroupId,
                             java.util.Map<java.util.Locale,java.lang.String> nameMap,
                             java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                             int type,
                             boolean manualMembership,
                             int membershipRestriction,
                             java.lang.String friendlyURL,
                             boolean site,
                             boolean active,
                             ServiceContext serviceContext)
                      throws PortalException

Throws:

PortalException

addRoleGroups

public static void addRoleGroups(HttpPrincipal httpPrincipal,
                                 long roleId,
                                 long[] groupIds)
                          throws PortalException

Throws:

PortalException

checkRemoteStagingGroup

public static void checkRemoteStagingGroup(HttpPrincipal httpPrincipal,
                                           long groupId)
                                    throws PortalException

Throws:

PortalException

deleteGroup

public static void deleteGroup(HttpPrincipal httpPrincipal,
                               long groupId)
                        throws PortalException

Throws:

PortalException

disableStaging

public static void disableStaging(HttpPrincipal httpPrincipal,
                                  long groupId)
                           throws PortalException

Throws:

PortalException

enableStaging

public static void enableStaging(HttpPrincipal httpPrincipal,
                                 long groupId)
                          throws PortalException

Throws:

PortalException

getCompanyGroup

public static Group getCompanyGroup(HttpPrincipal httpPrincipal,
                                    long companyId)
                             throws PortalException

Throws:

PortalException

getGroup

public static Group getGroup(HttpPrincipal httpPrincipal,
                             long groupId)
                      throws PortalException

Throws:

PortalException

getGroup

public static Group getGroup(HttpPrincipal httpPrincipal,
                             long companyId,
                             java.lang.String groupKey)
                      throws PortalException

Throws:

PortalException

getGroupDisplayURL

public static java.lang.String getGroupDisplayURL(HttpPrincipal httpPrincipal,
                                                  long groupId,
                                                  boolean privateLayout,
                                                  boolean secureConnection)
                                           throws PortalException

Throws:

PortalException

getGroups

public static java.util.List<Group> getGroups(HttpPrincipal httpPrincipal,
                                              long companyId,
                                              long parentGroupId,
                                              boolean site)
                                       throws PortalException

Throws:

PortalException

getGroups

public static java.util.List<Group> getGroups(HttpPrincipal httpPrincipal,
                                              long companyId,
                                              long parentGroupId,
                                              boolean site,
                                              int start,
                                              int end)
                                       throws PortalException

Throws:

PortalException

getGroups

public static java.util.List<Group> getGroups(HttpPrincipal httpPrincipal,
                                              long companyId,
                                              long parentGroupId,
                                              java.lang.String name,
                                              boolean site,
                                              int start,
                                              int end)
                                       throws PortalException

Throws:

PortalException

getGroupsCount

public static int getGroupsCount(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 long parentGroupId,
                                 boolean site)
                          throws PortalException

Throws:

PortalException

getGroupsCount

public static int getGroupsCount(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 long parentGroupId,
                                 java.lang.String name,
                                 boolean site)
                          throws PortalException

Throws:

PortalException

getGroupsCount

public static int getGroupsCount(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 java.lang.String className,
                                 long parentGroupId)
                          throws PortalException

Throws:

PortalException

getGtGroups

public static java.util.List<Group> getGtGroups(HttpPrincipal httpPrincipal,
                                                long gtGroupId,
                                                long companyId,
                                                long parentGroupId,
                                                boolean site,
                                                int size)
                                         throws PortalException

Throws:

PortalException

getManageableSiteGroups

public static java.util.List<Group> getManageableSiteGroups(HttpPrincipal httpPrincipal,
                                                            java.util.Collection<Portlet> portlets,
                                                            int max)
                                                     throws PortalException

Throws:

PortalException

getOrganizationsGroups

public static java.util.List<Group> getOrganizationsGroups(HttpPrincipal httpPrincipal,
                                                           java.util.List<Organization> organizations)
                                                    throws PortalException

Throws:

PortalException

getUserGroup

public static Group getUserGroup(HttpPrincipal httpPrincipal,
                                 long companyId,
                                 long userId)
                          throws PortalException

Throws:

PortalException

getUserGroupsGroups

public static java.util.List<Group> getUserGroupsGroups(HttpPrincipal httpPrincipal,
                                                        java.util.List<UserGroup> userGroups)
                                                 throws PortalException

Throws:

PortalException

getUserOrganizationsGroups

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

Throws:

PortalException

getUserSitesGroups

public static java.util.List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal)
                                                throws PortalException

Throws:

PortalException

getUserSitesGroups

public static java.util.List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal,
                                                       long userId,
                                                       java.lang.String[] classNames,
                                                       int max)
                                                throws PortalException

Throws:

PortalException

getUserSitesGroups

public static java.util.List<Group> getUserSitesGroups(HttpPrincipal httpPrincipal,
                                                       java.lang.String[] classNames,
                                                       int max)
                                                throws PortalException

Throws:

PortalException

getUserSitesGroupsCount

public static int getUserSitesGroupsCount(HttpPrincipal httpPrincipal)
                                   throws PortalException

Throws:

PortalException

hasUserGroup

public static boolean hasUserGroup(HttpPrincipal httpPrincipal,
                                   long userId,
                                   long groupId)
                            throws PortalException

Throws:

PortalException

search

public static java.util.List<Group> search(HttpPrincipal httpPrincipal,
                                           long companyId,
                                           long[] classNameIds,
                                           java.lang.String keywords,
                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                           int start,
                                           int end,
                                           OrderByComparator<Group> orderByComparator)
                                    throws PortalException

Throws:

PortalException

search

public static java.util.List<Group> search(HttpPrincipal httpPrincipal,
                                           long companyId,
                                           long[] classNameIds,
                                           java.lang.String name,
                                           java.lang.String description,
                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                           boolean andOperator,
                                           int start,
                                           int end,
                                           OrderByComparator<Group> orderByComparator)
                                    throws PortalException

Throws:

PortalException

search

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

Throws:

PortalException

searchCount

public static int searchCount(HttpPrincipal httpPrincipal,
                              long companyId,
                              long[] classNameIds,
                              java.lang.String keywords,
                              java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

searchCount

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

setRoleGroups

public static void setRoleGroups(HttpPrincipal httpPrincipal,
                                 long roleId,
                                 long[] groupIds)
                          throws PortalException

Throws:

PortalException

unsetRoleGroups

public static void unsetRoleGroups(HttpPrincipal httpPrincipal,
                                   long roleId,
                                   long[] groupIds)
                            throws PortalException

Throws:

PortalException

updateFriendlyURL

public static Group updateFriendlyURL(HttpPrincipal httpPrincipal,
                                      long groupId,
                                      java.lang.String friendlyURL)
                               throws PortalException

Throws:

PortalException

updateGroup

public static Group updateGroup(HttpPrincipal httpPrincipal,
                                long groupId,
                                long parentGroupId,
                                java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                int type,
                                boolean manualMembership,
                                int membershipRestriction,
                                java.lang.String friendlyURL,
                                boolean inheritContent,
                                boolean active,
                                ServiceContext serviceContext)
                         throws PortalException

Throws:

PortalException

updateGroup

public static Group updateGroup(HttpPrincipal httpPrincipal,
                                long groupId,
                                java.lang.String typeSettings)
                         throws PortalException

Throws:

PortalException

updateStagedPortlets

public static void updateStagedPortlets(HttpPrincipal httpPrincipal,
                                        long groupId,
                                        java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)
                                 throws PortalException

Throws:

PortalException