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) Get the CommunityMemberGroup for the specified user id with the specified resource type.
CommunityMemberGroupProfile	getCommunityGroupProfile(Resource resource, ClientUtilities clientUtils, java.lang.String resourceType) Get the CommunityMemberGroupProfile for the specified user id with the specified resource type.
java.lang.String	getGroupRootPath()
java.lang.String	getUserRootPath()
boolean	isCommunityAdmin(ResourceResolver resourceResolver) Check if the current session has community administrator permission.
boolean	isValidGroupMember(Resource authorizableResource) Checks if the member of group, represented as Resource satisfies social-members repo user/group policy.
boolean	isValidMember(Authorizable authorizable) Checks if the member, represented as Authorizable satisfies social-members repo user/group policy.
boolean	isValidMember(CommunityMemberUserProfile userProfile) Checks if the member, represented as CommunityMemberUserProfile satisfies social-members repo user/group policy.
boolean	isValidMember(java.lang.String path, boolean isGroup) Checks if the member path satisfies social-members repo user/group policy.

Method Detail

isCommunityAdmin

boolean isCommunityAdmin(ResourceResolver resourceResolver)
                  throws OperationException

Check if the current session has community administrator permission.

Throws:

OperationException

getCommunityGroup

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

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

getCommunityGroupProfile

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

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

isValidMember

boolean isValidMember(CommunityMemberUserProfile userProfile)

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

isValidMember

boolean isValidMember(Authorizable authorizable)
               throws OperationException

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

Throws:

OperationException

isValidMember

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

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

isValidGroupMember

boolean isValidGroupMember(Resource authorizableResource)

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.