com.adobe.cq.social.group.api

Interface GroupService

public interface GroupService

GroupService provides a service managing community groups.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REPLICATE_NODE_NAME
static java.lang.String	REPLICATE_NODE_TYPE
static java.lang.String	REPLICATE_PROPERTY_ACTION
static java.lang.String	REPLICATE_PROPERTY_PATH

Method Summary

Modifier and Type	Method and Description
void	addGroupMember(ResourceResolver resolver, java.lang.String groupName, java.lang.String authorizableId) Add an authorizable to a group.
void	addGroupMembers(ResourceResolver idResolver, java.lang.String groupName, java.lang.String[] authorizableIds) Add authorizables to a group.
void	copyAccessControlPolicy(ResourceResolver msmResolver, ResourceResolver userManagerResolver, ResourceResolver aclResolver, java.lang.String sourcePath, java.lang.String langs, java.lang.String destPath, java.lang.String groupId, java.lang.String type) Copy Access Control List from blueprint to the community group.
void	copyAccessControlPolicy(ResourceResolver resolver, java.lang.String sourcePath, java.lang.String langs, java.lang.String destPath, java.lang.String groupId, java.lang.String type) Copy Access Control List from blueprint to the community group.
Group	createGroup(ResourceResolver userAdminResolver, ResourceResolver msmResolver, java.lang.String groupName, java.lang.String intermediatePath, java.lang.String liveCopyPath, java.lang.String liveCopyName, java.lang.String type) Returns a user group.
Group	createGroup(SlingRepository repository, ResourceResolver adminResolver, java.lang.String groupName, java.lang.String intermediatePath, java.lang.String liveCopyPath, java.lang.String liveCopyName, java.lang.String type) Deprecated.
AccessControlList	getACL(AccessControlManager acManager, java.lang.String path) Get access control list of the given path.
void	removeGroupMember(ResourceResolver resolver, java.lang.String groupName, java.lang.String authorizableId) Remove an authorizable from a group.
void	removeGroupMembers(ResourceResolver resolver, java.lang.String groupName, java.lang.String[] authorizableIds) Remove authorizables from a group.

Field Detail

REPLICATE_NODE_TYPE

static final java.lang.String REPLICATE_NODE_TYPE

See Also:

Constant Field Values

REPLICATE_NODE_NAME

static final java.lang.String REPLICATE_NODE_NAME

See Also:

Constant Field Values

REPLICATE_PROPERTY_PATH

static final java.lang.String REPLICATE_PROPERTY_PATH

See Also:

Constant Field Values

REPLICATE_PROPERTY_ACTION

static final java.lang.String REPLICATE_PROPERTY_ACTION

See Also:

Constant Field Values

Method Detail

createGroup

@Deprecated
Group createGroup(SlingRepository repository,
                              ResourceResolver adminResolver,
                              java.lang.String groupName,
                              java.lang.String intermediatePath,
                              java.lang.String liveCopyPath,
                              java.lang.String liveCopyName,
                              java.lang.String type)
                       throws GroupException,
                              RepositoryException

Deprecated.

Returns a user group.

Parameters:

repository - sling repository, no longer used, may be null.

adminResolver - a resource resolver with full repository access.

groupName - user group name.

intermediatePath - user group intermediate path.

liveCopyPath - live copy site path.

liveCopyName - live copy node name.

type - administrative group or member group.

Returns:

the user group.

Throws:

GroupException - - thrown if unable to create the group.

RepositoryException - - thrown if unable to create the group.

createGroup

Group createGroup(ResourceResolver userAdminResolver,
                  ResourceResolver msmResolver,
                  java.lang.String groupName,
                  java.lang.String intermediatePath,
                  java.lang.String liveCopyPath,
                  java.lang.String liveCopyName,
                  java.lang.String type)
           throws GroupException,
                  RepositoryException

Returns a user group.

Parameters:

userAdminResolver - User Admin resource resolver.

msmResolver - MSM resource resolver

groupName - user group name.

intermediatePath - user group intermediate path.

liveCopyPath - live copy site path.

liveCopyName - live copy node name.

type - administrative group or member group.

Returns:

the user group.

Throws:

GroupException - - thrown if unable to create the group.

RepositoryException - - thrown if unable to create the group.

addGroupMember

void addGroupMember(ResourceResolver resolver,
                    java.lang.String groupName,
                    java.lang.String authorizableId)
             throws GroupException,
                    RepositoryException

Add an authorizable to a group.

Parameters:

resolver - resource resolver.

groupName - user group name.

authorizableId - authorizable ID.

Throws:

GroupException - - thrown if unable to add the authorizable.

RepositoryException - - thrown if unable to add the authorizable.

addGroupMembers

void addGroupMembers(ResourceResolver idResolver,
                     java.lang.String groupName,
                     java.lang.String[] authorizableIds)
              throws GroupException,
                     RepositoryException

Add authorizables to a group.

Parameters:

idResolver - resource resolver.

groupName - user group name.

authorizableIds - a string array of authorizable IDs.

Throws:

GroupException - - thrown if unable to add the authorizables.

RepositoryException - - thrown if unable to add the authorizables.

removeGroupMember

void removeGroupMember(ResourceResolver resolver,
                       java.lang.String groupName,
                       java.lang.String authorizableId)
                throws GroupException,
                       RepositoryException

Remove an authorizable from a group.

Parameters:

resolver - resource resolver.

groupName - user group name.

authorizableId - authorizable ID.

Throws:

GroupException - - thrown if unable to remove the authorizable.

RepositoryException - - thrown if unable to remove the authorizable.

removeGroupMembers

void removeGroupMembers(ResourceResolver resolver,
                        java.lang.String groupName,
                        java.lang.String[] authorizableIds)
                 throws GroupException,
                        RepositoryException

Remove authorizables from a group.

Parameters:

resolver - resource resolver.

groupName - user group name.

authorizableIds - a string array of authorizable IDs.

Throws:

GroupException - - thrown if unable to remove the authorizables.

RepositoryException - - thrown if unable to remove the authorizables.

copyAccessControlPolicy

void copyAccessControlPolicy(ResourceResolver resolver,
                             java.lang.String sourcePath,
                             java.lang.String langs,
                             java.lang.String destPath,
                             java.lang.String groupId,
                             java.lang.String type)
                      throws GroupException,
                             RepositoryException,
                             java.security.AccessControlException

Copy Access Control List from blueprint to the community group.

Parameters:

resolver - resource resolver.

sourcePath - blueprint site path.

langs - live copy languages.

destPath - live copy site path.

groupId - group id.

type - community group privacy type.

Throws:

GroupException - - thrown if unable to copy ACL.

RepositoryException - - thrown if unable to copy ACL.

java.security.AccessControlException - - thrown if unable to copy ACL.

copyAccessControlPolicy

void copyAccessControlPolicy(ResourceResolver msmResolver,
                             ResourceResolver userManagerResolver,
                             ResourceResolver aclResolver,
                             java.lang.String sourcePath,
                             java.lang.String langs,
                             java.lang.String destPath,
                             java.lang.String groupId,
                             java.lang.String type)
                      throws GroupException,
                             RepositoryException,
                             java.security.AccessControlException

Copy Access Control List from blueprint to the community group.

Parameters:

msmResolver - resource resolver with read/write access to /content

userManagerResolver - resource resolver with all access to users/groups and their content.

aclResolver - resource resolver with read/write ACL and node type management access to /content.

sourcePath - blueprint site path.

langs - live copy languages.

destPath - live copy site path.

groupId - group id.

type - community group privacy type.

Throws:

GroupException - - thrown if unable to copy ACL.

RepositoryException - - thrown if unable to copy ACL.

java.security.AccessControlException - - thrown if unable to copy ACL.

getACL

AccessControlList getACL(AccessControlManager acManager,
                         java.lang.String path)

Get access control list of the given path.

Parameters:

acManager - Access Control Manager.

path - path.

Returns:

access control list.