com.adobe.cq.social.members.api

Interface MembersUtils

public interface MembersUtils

Method Summary

Modifier and Type	Method and Description
CommunityMemberGroup	getCommunityGroup(java.lang.String id, ResourceResolver resolver, ClientUtilities clientUtils, java.lang.String resourceType)
CommunityMemberGroupProfile	getCommunityGroupProfile(Resource resource, ClientUtilities clientUtils, java.lang.String resourceType)
java.lang.String	getGroupRootPath()
java.lang.String	getUserRootPath()
boolean	isCommunityAdmin(ResourceResolver resourceResolver) Check if the current session has community administrator permission.
boolean	isEnablementGroup(Authorizable authorizable)
boolean	isValidGroupMember(Resource authorizableResource)
boolean	isValidMember(Authorizable authorizable)
boolean	isValidMember(CommunityMemberUserProfile userProfile)
boolean	isValidMember(java.lang.String path, boolean isGroup)

Method Detail

isCommunityAdmin

boolean isCommunityAdmin(ResourceResolver resourceResolver)
                  throws OperationException

Check if the current session has community administrator permission.

Parameters:

resourceResolver - resourceResolver

Returns:

check if community admin

Throws:

OperationException - operationException

getCommunityGroup

CommunityMemberGroup getCommunityGroup(java.lang.String id,
                                       ResourceResolver resolver,
                                       ClientUtilities clientUtils,
                                       java.lang.String resourceType)

Parameters:

id - id

resolver - resolver

clientUtils - clientUtils

resourceType - resourceType

Returns:

Get the CommunityMemberGroup for the specified user id with the specified resource type.

getCommunityGroupProfile

CommunityMemberGroupProfile getCommunityGroupProfile(Resource resource,
                                                     ClientUtilities clientUtils,
                                                     java.lang.String resourceType)

Parameters:

resource - resource

clientUtils - clientUtils

resourceType - resourceType

Returns:

Get the CommunityMemberGroupProfile for the specified user id with the specified resource type.

isValidMember

boolean isValidMember(CommunityMemberUserProfile userProfile)

Parameters:

userProfile - userProfile

Returns:

Checks if the member, represented as CommunityMemberUserProfile satisfies social-members repo user/group policy.

isValidMember

boolean isValidMember(Authorizable authorizable)
               throws OperationException

Parameters:

authorizable - authorizable

Returns:

Checks if the member, represented as Authorizable satisfies social-members repo user/group policy.

Throws:

OperationException - operationException

isValidMember

boolean isValidMember(java.lang.String path,
                      boolean isGroup)

Parameters:

path - path

isGroup - isGroup

Returns:

Checks if the member path satisfies social-members repo user/group policy.

isValidGroupMember

boolean isValidGroupMember(Resource authorizableResource)

Parameters:

authorizableResource - authorizableResource

Returns:

Checks if the member of group, represented as Resource satisfies social-members repo user/group policy.

getUserRootPath

java.lang.String getUserRootPath()

Returns:

the configured path of the user root node.

getGroupRootPath

java.lang.String getGroupRootPath()

Returns:

the configured path of the group root node.

isEnablementGroup

boolean isEnablementGroup(Authorizable authorizable)

Parameters:

authorizable - authorizable

Returns:

Checks if the authorizable is enablement group.