com.adobe.cq.social.group.api

Class GroupUtil

java.lang.Object

com.adobe.cq.social.group.api.GroupUtil

@ProviderType
public class GroupUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_WAIT_TIME
static int	DEFAULT_WAIT_BETWEEN_RETRIES
static int	WARN_RETRY_DELAY
static int	WARN_WAIT_TIME

Constructor Summary

Constructors

Constructor and Description
GroupUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	canAccessCommunityGroup(ResourceResolver resolver, CommunityGroup group)
static boolean	canEveryoneCreateGroup(Resource resource)
static boolean	canInviteGroupMember(ResourceResolver resolver, CommunityContext context, ServiceUserWrapper serviceUserWrapper, SlingRepository repository, UserManager um) Check if logged in user can invite group members.
static boolean	canLeaveGroup(ResourceResolver resolver, CommunityContext context, ServiceUserWrapper serviceUserWrapper, SlingRepository repository, UserManager um) Check if logged in user can invite group members.
static boolean	canPromoteGroupMember(ResourceResolver resolver, CommunityContext context, ServiceUserWrapper serviceUserWrapper, SlingRepository repository, UserManager um) Check if logged in user can promote group members.
static java.lang.String	getMemberGroupName(ResourceResolver resourceResolver, java.lang.String groupPath)
static int	getNumberOfMembers(UserPropertiesService userPropertiesService, ResourceResolver resourceResolver, java.lang.String groupId) Returns the number of the group members.
static boolean	isGroupAdmin(Session session, Resource resource) Deprecated.
static boolean	isMember(java.lang.String groupId, java.lang.String userId, ServiceUserWrapper serviceUserWrapper, SlingRepository repository)
static boolean	isMember(UserManager um, java.lang.String groupId, java.lang.String userId) Check if the specified user id belong to the group admin or not.
static boolean	isMember(UserPropertiesService userPropertiesService, ResourceResolver resourceResolver, java.lang.String authId, java.lang.String groupId) Returns true if an authorizable is a group member.
static boolean	isPublicGroup(ResourceResolver resourceResolver, java.lang.String groupPath)
static java.lang.Object	toObject(java.lang.String value, java.lang.Class clazz)
static boolean	validateGroupName(ResourceResolver resolver, java.lang.String name, java.lang.String groupRoot) Validate if a community group name is unique.
static void	waitForPageCreation(ResourceResolver resolver, java.lang.String pagePath, long maxWaitTime, long waitInterval) wait for page content creation to complete.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_WAIT_TIME

public static final int DEFAULT_MAX_WAIT_TIME

See Also:

Constant Field Values

DEFAULT_WAIT_BETWEEN_RETRIES

public static final int DEFAULT_WAIT_BETWEEN_RETRIES

See Also:

Constant Field Values

WARN_WAIT_TIME

public static final int WARN_WAIT_TIME

See Also:

Constant Field Values

WARN_RETRY_DELAY

public static final int WARN_RETRY_DELAY

See Also:

Constant Field Values

Constructor Detail

GroupUtil

public GroupUtil()

Method Detail

canEveryoneCreateGroup

public static boolean canEveryoneCreateGroup(Resource resource)

validateGroupName

public static boolean validateGroupName(ResourceResolver resolver,
                                        java.lang.String name,
                                        java.lang.String groupRoot)

Validate if a community group name is unique.

Parameters:

resolver - resource resolver.

name - community group name.

groupRoot - community group site path.

Returns:

true if a community group name is unique.

getNumberOfMembers

public static int getNumberOfMembers(UserPropertiesService userPropertiesService,
                                     ResourceResolver resourceResolver,
                                     java.lang.String groupId)

Returns the number of the group members.

Parameters:

userPropertiesService - user properties service.

resourceResolver - resource resolver.

groupId - group id.

Returns:

Number of the members of this Group. This includes both declared members and all authorizables that are indirect group members.

isMember

public static boolean isMember(UserPropertiesService userPropertiesService,
                               ResourceResolver resourceResolver,
                               java.lang.String authId,
                               java.lang.String groupId)

Returns true if an authorizable is a group member.

Parameters:

userPropertiesService - user properties service.

resourceResolver - resource resolver.

authId - authorizable id.

groupId - group id.

Returns:

true if an authorizable is a group member.

waitForPageCreation

public static void waitForPageCreation(ResourceResolver resolver,
                                       java.lang.String pagePath,
                                       long maxWaitTime,
                                       long waitInterval)
                                throws RepositoryException

wait for page content creation to complete. wait no more than 1 second.

Parameters:

resolver - resource resolver.

pagePath - page path

maxWaitTime - time out in millisecond

waitInterval - wait interval in millisecond

Throws:

RepositoryException - - thrown if unable to wait for page creation.

toObject

public static java.lang.Object toObject(java.lang.String value,
                                        java.lang.Class clazz)

isMember

public static boolean isMember(UserManager um,
                               java.lang.String groupId,
                               java.lang.String userId)
                        throws RepositoryException

Check if the specified user id belong to the group admin or not.

Parameters:

um - user manager

groupId - Id of the group

userId - Id of the user

Returns:

the status

Throws:

RepositoryException - - thrown if get member status.

isMember

public static boolean isMember(java.lang.String groupId,
                               java.lang.String userId,
                               ServiceUserWrapper serviceUserWrapper,
                               SlingRepository repository)
                        throws RepositoryException

Throws:

RepositoryException

isGroupAdmin

@Deprecated
public static boolean isGroupAdmin(Session session,
                                               Resource resource)
                                        throws OperationException

Deprecated.

Throws:

OperationException

canInviteGroupMember

public static boolean canInviteGroupMember(ResourceResolver resolver,
                                           CommunityContext context,
                                           ServiceUserWrapper serviceUserWrapper,
                                           SlingRepository repository,
                                           UserManager um)

Check if logged in user can invite group members. when group creation permission type is everyone, only group owner and real admins can invite/promote/demote members

Parameters:

resolver - a resource resolver.

context - CommunityContext.

serviceUserWrapper - ServiceUserWrapper.

repository - sling repository.

um - user manager.

Returns:

true if logged in user can invite group members

canLeaveGroup

public static boolean canLeaveGroup(ResourceResolver resolver,
                                    CommunityContext context,
                                    ServiceUserWrapper serviceUserWrapper,
                                    SlingRepository repository,
                                    UserManager um)

Check if logged in user can invite group members. when group creation permission type is everyone, only group owner and real admins can invite/promote/demote members

Parameters:

resolver - a resource resolver.

context - CommunityContext.

serviceUserWrapper - ServiceUserWrapper.

repository - sling repository.

um - user manager.

Returns:

true if logged in user can invite group members

canPromoteGroupMember

public static boolean canPromoteGroupMember(ResourceResolver resolver,
                                            CommunityContext context,
                                            ServiceUserWrapper serviceUserWrapper,
                                            SlingRepository repository,
                                            UserManager um)

Check if logged in user can promote group members. this is disabled when group creation permission type is everyone.

Parameters:

resolver - a resource resolver.

context - CommunityContext.

serviceUserWrapper - ServiceUserWrapper.

repository - sling repository.

um - user manager.

Returns:

true if logged in user can promote group members

canAccessCommunityGroup

public static boolean canAccessCommunityGroup(ResourceResolver resolver,
                                              CommunityGroup group)

isPublicGroup

public static boolean isPublicGroup(ResourceResolver resourceResolver,
                                    java.lang.String groupPath)

getMemberGroupName

public static java.lang.String getMemberGroupName(ResourceResolver resourceResolver,
                                                  java.lang.String groupPath)