com.adobe.cq.social.enablement.site.api

Interface EnablementSiteService

public interface EnablementSiteService

Provides methods to call when a Community Site needs to be enhanced with Enablement-specific functionality (i.e. creation of additional groups and folders). Methods are called typically after the Site has been created or updated.

Method Summary

Modifier and Type	Method and Description
void	applyACLs(Resource resource, CommunityContext context, Session session) Apply Enablement-specific ACLs on Community Site resources.
void	applyACLs(Resource site, CommunityContext context, Session aclSession, Session userManagerSession) Apply Enablement-specific ACLs on Community Site resources.
void	createGroupFolders(Resource site, Session session, ResourceResolver userManagerResolver, java.util.Map<java.lang.String,java.lang.Object> properties) Create default Enablement-specific folders for a Community Group.
void	createSiteFolders(Resource site, CommunityContext context, Session session, java.util.Map<java.lang.String,java.lang.Object> properties) Deprecated.
void	createSiteFolders(Resource site, CommunityContext context, Session session, ResourceResolver userManagerResolver, java.util.Map<java.lang.String,java.lang.Object> properties) Create default Enablement-specific folders for a Community Site.
void	createSiteUGCPath(Resource resource, CommunityContext context, Session session) Create Enablement-specific site UGC nodes (i.e.
void	createSiteUGCPath(Resource site, CommunityContext context, Session aclSession, Session userManagerSession) Create Enablement-specific site UGC nodes (i.e.
void	createSiteUserGroups(Resource site, CommunityContext context, Session session, java.util.Map<java.lang.String,java.lang.Object> properties) Create default Enablement-specific user groups for a Community Site.
java.lang.String	getGroupAssetsPath(CommunityContext context, ResourceResolver resolver) Gets the Enablement Assets DAM path for the given community group.
java.lang.String	getSiteAssetsPath(CommunityContext context) Gets the Enablement Assets path for the given Site.
java.lang.String	getSiteResourceGroupsPath(CommunityContext context) Gets the Enablement Resource-groups path for the given context.
java.lang.String	getSiteResourcesPath(CommunityContext context) Gets the Enablement Resources path for the given context.
boolean	isPublishMode() Checks whether the current instance is running in Publisher mode.
void	updateSiteUserGroups(Resource site, CommunityContext context, Session session, java.util.Map<java.lang.String,java.lang.Object> properties) Update Enablement-specific user groups for a Community Site.

Method Detail

createSiteUserGroups

void createSiteUserGroups(Resource site,
                          CommunityContext context,
                          Session session,
                          java.util.Map<java.lang.String,java.lang.Object> properties)
                   throws RepositoryException,
                          OperationException

Create default Enablement-specific user groups for a Community Site.

Parameters:

site - the site's root resource

context - community Context

session - user session

properties - request parameters

Throws:

OperationException - - thrown if unable to create site user groups

RepositoryException - - thrown if unable to create site user groups

applyACLs

void applyACLs(Resource resource,
               CommunityContext context,
               Session session)
        throws OperationException,
               RepositoryException

Apply Enablement-specific ACLs on Community Site resources.

Parameters:

resource - the site's root resource

context - community Context

session - user session

Throws:

OperationException - - thrown if unable to apply ACLs

RepositoryException - - thrown if unable to apply ACLs

applyACLs

void applyACLs(Resource site,
               CommunityContext context,
               Session aclSession,
               Session userManagerSession)
        throws RepositoryException,
               OperationException

Apply Enablement-specific ACLs on Community Site resources.

Parameters:

site - - resource the site's root resource

context - community Context

aclSession - session with ACL management permissions on site content.

userManagerSession - session with permissions to lookup site users and groups.

Throws:

OperationException - - thrown if unable to apply ACLs

RepositoryException - - thrown if unable to apply ACLs

createSiteFolders

@Deprecated
void createSiteFolders(Resource site,
                                   CommunityContext context,
                                   Session session,
                                   java.util.Map<java.lang.String,java.lang.Object> properties)
                            throws RepositoryException,
                                   OperationException

Deprecated.

Create default Enablement-specific folders for a Community Site.

Parameters:

site - the site's root resource

context - community Context

session - user session

properties - request parameters

Throws:

OperationException - - thrown if unable to create site folders

RepositoryException - - thrown if unable to create site folders.

createSiteFolders

void createSiteFolders(Resource site,
                       CommunityContext context,
                       Session session,
                       ResourceResolver userManagerResolver,
                       java.util.Map<java.lang.String,java.lang.Object> properties)
                throws RepositoryException,
                       OperationException

Create default Enablement-specific folders for a Community Site.

Parameters:

site - the site's root resource

context - community Context

session - user session, a session with read/write and replicate access to /content.

userManagerResolver - a resolver for a user with access to manage users.

properties - request parameters

Throws:

OperationException - - thrown if unable to create site folders

RepositoryException - - thrown if unable to create site folders.

createGroupFolders

void createGroupFolders(Resource site,
                        Session session,
                        ResourceResolver userManagerResolver,
                        java.util.Map<java.lang.String,java.lang.Object> properties)
                 throws RepositoryException,
                        OperationException

Create default Enablement-specific folders for a Community Group.

Parameters:

site - the group's root resource

session - user session, a session with read/write and replicate access to /content.

userManagerResolver - a resolver for a user with access to manage users.

properties - request parameters

Throws:

OperationException - - thrown if unable to create group folders

RepositoryException - - thrown if unable to create group folders.

createSiteUGCPath

void createSiteUGCPath(Resource resource,
                       CommunityContext context,
                       Session session)
                throws OperationException,
                       RepositoryException

Create Enablement-specific site UGC nodes (i.e. /content/usergenerated/content/siteId/resources/langId) and set the corresponding ACLs

Parameters:

resource - site's root resource

context - community context

session - session with permissions to post to the site, read/write UGC nodes and change/add ACLs on site UGC nodes.

Throws:

OperationException - - thrown if unable to create site UGC node(s)

RepositoryException - - thrown if unable to create site UGC node(s)

createSiteUGCPath

void createSiteUGCPath(Resource site,
                       CommunityContext context,
                       Session aclSession,
                       Session userManagerSession)
                throws OperationException,
                       RepositoryException

Create Enablement-specific site UGC nodes (i.e. /content/usergenerated/content/siteId/resources/langId) and set the corresponding ACLs

Parameters:

site - - site's root resource must be from a resolver with permissions to post to the site and read/write site UGC nodes

context - community context

aclSession - session with permissions to change/add ACLs to the site UGC nodes

userManagerSession - session with permissions to lookup site groups and members

Throws:

OperationException - - thrown if unable to create site UGC node(s)

RepositoryException - - thrown if unable to create site UGC node(s)

updateSiteUserGroups

void updateSiteUserGroups(Resource site,
                          CommunityContext context,
                          Session session,
                          java.util.Map<java.lang.String,java.lang.Object> properties)
                   throws RepositoryException,
                          OperationException

Update Enablement-specific user groups for a Community Site.

Parameters:

site - site's root resource

context - community Context

session - user session

properties - request parameters

Throws:

OperationException - - thrown if unable to create site user groups

RepositoryException - - thrown if unable to create site user groups

isPublishMode

boolean isPublishMode()

Checks whether the current instance is running in Publisher mode.

Returns:

whether running in Publisher mode

getSiteAssetsPath

java.lang.String getSiteAssetsPath(CommunityContext context)

Gets the Enablement Assets path for the given Site.

Parameters:

context - CommunityContext

Returns:

Enablement Assets path

getGroupAssetsPath

java.lang.String getGroupAssetsPath(CommunityContext context,
                                    ResourceResolver resolver)

Gets the Enablement Assets DAM path for the given community group.

Parameters:

context - - CommunityContext

resolver - - ResourceResolver

Returns:

Enablement Assets path

getSiteResourcesPath

java.lang.String getSiteResourcesPath(CommunityContext context)

Gets the Enablement Resources path for the given context.

Parameters:

context - CommunityContext

Returns:

Enablement Resources path

getSiteResourceGroupsPath

java.lang.String getSiteResourceGroupsPath(CommunityContext context)

Gets the Enablement Resource-groups path for the given context.

Parameters:

context - CommunityContext

Returns:

Enablement Resource-groups path