com.adobe.cq.social.community.api

Interface CommunityContext

@ProviderType
public interface CommunityContext

Method Summary

Modifier and Type	Method and Description
boolean	checkIfUserIsAdmin(UserManager um, java.lang.String userId) Check if the specified user id belong to the community administrator group.
boolean	checkIfUserIsGroupAdmin(UserManager um, java.lang.String userId) Check if the specified user id belong to the group admin or not.
boolean	checkIfUserIsModerator(UserManager um, java.lang.String userId) Check if the specified user id belongs to the moderator group
java.lang.String	getActivityStreamRootPath() Get activity stream root path
java.lang.String	getCommunityGroupId() Return the community group name of this context.
java.lang.String	getCommunityGroupPath() Get the community group path
java.lang.String	getCommunityGroupResourcesPath() Get the community group resources path.
java.lang.String	getCommunityGroupRootPath()
java.lang.String	getCommunityGroupUniqueId() Return the community group unique id of this context.
java.lang.String	getCommunityUserRootPath()
java.lang.String	getContentRootPath() Get the content root path for the site in this context.
java.lang.String	getDesignRootPath() Get the design root path
java.lang.String	getFullyQualifiedGroupName(java.lang.String groupName) Get the fully qualified group name based on this context
java.lang.String	getPageThemePath()
java.lang.String	getSiteBannerPath() Get the site banner path for the specified siteId
java.lang.String	getSiteContentFragmentAssociatedMediaDamRootPath() Get the current site's content fragment associated media dam root path.
java.lang.String	getSiteContentFragmentDamRootPath() Get the current site's content fragment dam root path.
java.util.List<java.lang.String>	getSiteContentPaths() Get the site's content paths.
java.lang.String	getSiteDamCollectionPath() Get the current site's content fragment collection path.
java.lang.String	getSiteDamRootPath() Get the current site's dam root path.
java.lang.String	getSiteId() Return the site id of this context.
java.lang.String	getSiteName() Get the current site name if not empty, else return siteId.
java.lang.String	getSitePagePath() This method returns the path of the root page path of the site.
java.lang.String	getSitePath() Get the site path
java.lang.String	getSitePayloadPath() Get the location where the site payload is created and replicated
java.lang.String	getSiteResourcesPath() Get the site's resources path.
java.lang.String	getSiteRootPath() Get the current site's root path.
java.lang.String	getSiteRootPath(java.lang.String siteId) Get the site root path of the current tenant's site with the given siteId.
java.lang.String	getSiteThemePath()
java.lang.String	getSiteUserGroupName(CommunityUserGroup userGroup)
SocialResourceConfiguration	getStorageConfig() Return the social configuration associated with the tenant.
java.lang.String	getStorageConfigurationPath() Deprecated.
Tenant	getTenant() Get {link Tenant}
java.lang.String	getTenantConfigPath() Get the configuration path
java.lang.String	getTenantGroupRootPath()
java.lang.String	getTenantId() Get the tenant id
java.lang.String	getTenantUserGroupName(java.lang.String groupName) Get the tenant user group name for the specified group
java.lang.String	getTenantUserRootPath()
java.lang.String	getUgcPath() Get the ugc root path.
java.lang.String	getUgcSitePath() Get the ugc site path.
java.lang.String	getUserGroupPath(java.lang.String userGroupName) Get the user group path of a tenant.
java.lang.String	getUserGroupRootPath() Get the user group root path of this context.
java.lang.String	getUserRootPath() Get the user root path of this context.
boolean	isMultiTenantSupported() Check if the multitenant deployment is supported.
boolean	isUserAdmin(UserManager um, java.lang.String userId) Check if the specified user id is an administrator base on this context.

Method Detail

getTenant

Tenant getTenant()

Get {link Tenant}

Returns:

Tenant the tenant

getTenantId

java.lang.String getTenantId()

Get the tenant id

Returns:

the tenant id, or null if the context does not belong to a tenant.

getSiteId

java.lang.String getSiteId()

Return the site id of this context.

Returns:

the site id, or null if the context does not belong to a site.

getCommunityGroupId

java.lang.String getCommunityGroupId()

Return the community group name of this context.

Returns:

the group id, or null if the context does not belong to a group.

getCommunityGroupUniqueId

java.lang.String getCommunityGroupUniqueId()

Return the community group unique id of this context.

Returns:

the group id, or null if the context does not belong to a group.

getContentRootPath

java.lang.String getContentRootPath()

Get the content root path for the site in this context.

Returns:

the context root path

getTenantConfigPath

java.lang.String getTenantConfigPath()

Get the configuration path

Returns:

/content/social/tenants/tenantid/components configuration path.

getSitePayloadPath

java.lang.String getSitePayloadPath()

Get the location where the site payload is created and replicated

Returns:

site payload path

getSitePagePath

java.lang.String getSitePagePath()

This method returns the path of the root page path of the site. One of its children node is the configuration node

Returns:

the site page path

getDesignRootPath

java.lang.String getDesignRootPath()

Get the design root path

Returns:

the design root path

getSiteThemePath

java.lang.String getSiteThemePath()

getPageThemePath

java.lang.String getPageThemePath()

getSitePath

java.lang.String getSitePath()

Get the site path

Returns:

site path

getCommunityGroupPath

java.lang.String getCommunityGroupPath()

Get the community group path

Returns:

community group path

getSiteBannerPath

java.lang.String getSiteBannerPath()

Get the site banner path for the specified siteId

Returns:

the site banner path

isMultiTenantSupported

boolean isMultiTenantSupported()

Check if the multitenant deployment is supported.

Returns:

true/false if multitenancy is supported or not

getUgcPath

java.lang.String getUgcPath()

Get the ugc root path.

Returns:

the ugc root path based on the tenant

getUgcSitePath

java.lang.String getUgcSitePath()

Get the ugc site path.

Returns:

the ugc path or null if the context does not belong to a site

getActivityStreamRootPath

java.lang.String getActivityStreamRootPath()

Get activity stream root path

Returns:

the activitystream root path, or null if this context does not belong to a site

getTenantUserGroupName

java.lang.String getTenantUserGroupName(java.lang.String groupName)

Get the tenant user group name for the specified group

Parameters:

groupName - is name of the group

Returns:

tenant user group name

getSiteUserGroupName

java.lang.String getSiteUserGroupName(CommunityUserGroup userGroup)

getFullyQualifiedGroupName

java.lang.String getFullyQualifiedGroupName(java.lang.String groupName)

Get the fully qualified group name based on this context

Parameters:

groupName - is name of the group

Returns:

fully qualified group name

getUserGroupRootPath

java.lang.String getUserGroupRootPath()

Get the user group root path of this context.

Returns:

user group root path

getUserRootPath

java.lang.String getUserRootPath()

Get the user root path of this context.

Returns:

user root path

getUserGroupPath

java.lang.String getUserGroupPath(java.lang.String userGroupName)

Get the user group path of a tenant. This is applicable to Admin and User group

Parameters:

userGroupName - is user group name

Returns:

user group root path

checkIfUserIsAdmin

boolean checkIfUserIsAdmin(UserManager um,
                           java.lang.String userId)
                    throws RepositoryException

Check if the specified user id belong to the community administrator group.

Parameters:

um - is user manager

userId - is user id

Returns:

true/false if user is community admin user or not

Throws:

RepositoryException - is unexpected repository exception

See Also:

to verify if the specified user is a group administrator.

checkIfUserIsGroupAdmin

boolean checkIfUserIsGroupAdmin(UserManager um,
                                java.lang.String userId)
                         throws RepositoryException

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

Parameters:

um - is user manager

userId - is user id

Returns:

true/false if user is group admin or not

Throws:

RepositoryException - is unexpected repository exception

isUserAdmin

boolean isUserAdmin(UserManager um,
                    java.lang.String userId)
             throws RepositoryException

Check if the specified user id is an administrator base on this context. If the context has a group, it checks if the user is a group administrator, otherwise, it checks if the user is a community administrator.

Parameters:

um - is user manager

userId - is user id

Returns:

true/false if user is admin user or not

Throws:

RepositoryException - is unexpected repository exception

getStorageConfigurationPath

@Deprecated
java.lang.String getStorageConfigurationPath()

Deprecated.

Get the storage configuration path.

Returns:

the storage configuration path.

getStorageConfig

SocialResourceConfiguration getStorageConfig()

Return the social configuration associated with the tenant.

Returns:

the configuration. If in a tenant, the tenant configuration, otherwise the site (default)

checkIfUserIsModerator

boolean checkIfUserIsModerator(UserManager um,
                               java.lang.String userId)
                        throws RepositoryException

Check if the specified user id belongs to the moderator group

Parameters:

um - is user manager

userId - is user id

Returns:

true/false if user is moderator or not

Throws:

RepositoryException - is unexpected repository exception

getTenantGroupRootPath

java.lang.String getTenantGroupRootPath()

getTenantUserRootPath

java.lang.String getTenantUserRootPath()

getCommunityGroupRootPath

java.lang.String getCommunityGroupRootPath()

getCommunityUserRootPath

java.lang.String getCommunityUserRootPath()

getSiteResourcesPath

java.lang.String getSiteResourcesPath()

Get the site's resources path.

Returns:

site resoruces path

getCommunityGroupResourcesPath

java.lang.String getCommunityGroupResourcesPath()

Get the community group resources path.

Returns:

community group resources path

getSiteContentPaths

java.util.List<java.lang.String> getSiteContentPaths()

Get the site's content paths.

Returns:

list of site's content paths

getSiteRootPath

java.lang.String getSiteRootPath()

Get the current site's root path.

Returns:

site root path

getSiteRootPath

java.lang.String getSiteRootPath(java.lang.String siteId)

Get the site root path of the current tenant's site with the given siteId.

Parameters:

siteId - given siteId

Returns:

root path of the site with the given siteId

getSiteName

java.lang.String getSiteName()

Get the current site name if not empty, else return siteId.

Returns:

site name

getSiteDamRootPath

java.lang.String getSiteDamRootPath()

Get the current site's dam root path.

Returns:

site dam root path or null if on a non-communities site

getSiteContentFragmentDamRootPath

java.lang.String getSiteContentFragmentDamRootPath()

Get the current site's content fragment dam root path.

Returns:

site content fragment dam root path or null if on a non-communities site

getSiteContentFragmentAssociatedMediaDamRootPath

java.lang.String getSiteContentFragmentAssociatedMediaDamRootPath()

Get the current site's content fragment associated media dam root path.

Returns:

site content fragment associated media dam root path or null if on a non-communities site

getSiteDamCollectionPath

java.lang.String getSiteDamCollectionPath()

Get the current site's content fragment collection path.

Returns:

site content fragment collection path or null if on a non-communities site