com.adobe.cq.social.ugcbase

Interface SocialUtils

public interface SocialUtils

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SocialUtils.AVATAR_SIZE enum for avartar's size.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_TYPE Property name for bucket resource type.
static String	CC_ASIPATH
static String	CC_CONSUMER_KEY
static String	CC_HOST_URL
static String	CC_REPORT_SUITE
static String	CC_SECRET_KEY
static String	CLOUD_SERVICE_REQUEST_LIST
static String	COMMENT_CS_RESOURCE_TYPE The resource type for the comments component.
static String	COMMENT_NODE_TYPE The comment node type.
static String	COMMENTID_SEPARATOR
static String	DEFAULT_AVATAR Default avatar URL.
static String	GROUP_MEMBERGROUP Property name for group's member group.
static String	NN_COMMENT_ATTACHMENTS The property name for the Comment Attachments folder.
static String	PATH_UGC The path to the user-generated content.
static String	PN_ATTACHMENT_LIST
static String	PN_BASETYPE
static String	PN_COMMENT_RESOURCETYPE
static String	PN_CS_ROOT
static String	PN_DATE
static String	PN_DS_KEY
static String	PN_ENTITY
static String	PN_IS_REPLY
static String	PN_PARENTID
static String	PN_POST_RESOURCETYPE
static String	PN_REMOTE_UGC_LOCATION Property name for pointing a Social component to remote piece of UGC.
static String	PN_SLING_RESOURCETYPE
static String	PN_TOPIC_RESOURCETYPE
static String	PROP_COMPONENT The property name for the path to the comments component.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAddNode(Session session, String path) Checks whether the given session has the permission to add a node below the given path.
Boolean	checkPermission(ResourceResolver resolver, String path, String action) Checks a path and an action based on the passed in resolver.
Node	createNode(ResourceResolver resolver, String path, String nodeType) Create node.
String	createUniqueNameHint(String message)
String	createUniqueNameHint(String message, int numRandomChars)
String	generateRandomString(int length) Generates a (secure) random string with the given length.
String	getAvatar(UserProperties userProperties) Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.
String	getAvatar(UserProperties userProperties, int size) Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.
String	getAvatar(UserProperties userProperties, String absoluteDefaultAvatar) Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.
String	getAvatar(UserProperties userProperties, String absoluteDefaultAvatar, SocialUtils.AVATAR_SIZE size) Returns the userProperties avatar URL or absoluteDefaultAvatar if profile has no avatar defined.
SocialResourceProvider	getConfiguredProvider(Resource resource) A simple way of getting the configured SocialResourceProvider for a resource.
Page	getContainingPage(Resource resource) Finds the page which contains the given resource
Page	getPage(String path, ResourceResolver resolver)
String	getPagePath(Resource resource) Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.
String	getResourceTypeForIncludedResource(Resource component, String defaultResourceType, String designPropertyName) Returns the resource type of a Component when it is included dynamically via cq:include.
String	getResourceTypeFromDesign(Resource resource, String styleProperty, String defaultValue)
String	getSocialProfileURL(String username, ResourceResolver resolver, Page page) Gets the social profile url for a user based on the page being passed in.
Configuration	getStorageCloudServiceConfig(Resource resource) From a resource get the cloud configuration for the social data service.
Resource	getUGCResource(Resource userResource, ResourceResolverFactory rrf) Gets the base UGC Resource from a SocialResource.
Resource	getUGCResource(Resource userResource, ResourceResolverFactory rrf, String resourceTypeHint) Gets the base UGC Resource from a SocialResource.
UserProperties	getUserProperties(ResourceResolver resolver, String userId) Returns the user properties denoted by the given userId.
boolean	hasModeratePermissions(Resource resource) Check if the login user can moderate a given resource.
boolean	mayAccessUGC(ResourceResolver resolver) May access ugc.
boolean	mayPost(ResourceResolver resolver, Resource resource) Indicates whether the user within the given resource resolver has enough permissions to post to the given resource component.
String	prepareUserGeneratedContent(ResourceResolver resolver, String path) Prepare user generated content for the specified path.
String	resourceToUGCPath(Resource resource) This method maps the given resource to its equivalent path in /usergenerated, e.g.
String	UGCToResourcePath(Resource resource) This method maps the given resource in /content/usergenerated to its equivalent path in the normal content tree, e.g.
String	UGCToResourcePath(String ugcPath, ResourceResolver resolver) This method maps the given resource in /content/usergenerated to its equivalent path in the normal content tree, e.g.

Field Detail

PN_PARENTID

static final String PN_PARENTID

See Also:

Constant Field Values

PN_DATE

static final String PN_DATE

See Also:

Constant Field Values

PN_COMMENT_RESOURCETYPE

static final String PN_COMMENT_RESOURCETYPE

See Also:

Constant Field Values

PN_TOPIC_RESOURCETYPE

static final String PN_TOPIC_RESOURCETYPE

See Also:

Constant Field Values

PN_POST_RESOURCETYPE

static final String PN_POST_RESOURCETYPE

See Also:

Constant Field Values

PN_SLING_RESOURCETYPE

static final String PN_SLING_RESOURCETYPE

PN_DS_KEY

static final String PN_DS_KEY

See Also:

Constant Field Values

PN_CS_ROOT

static final String PN_CS_ROOT

See Also:

Constant Field Values

PN_BASETYPE

static final String PN_BASETYPE

See Also:

Constant Field Values

PN_ATTACHMENT_LIST

static final String PN_ATTACHMENT_LIST

See Also:

Constant Field Values

PN_IS_REPLY

static final String PN_IS_REPLY

See Also:

Constant Field Values

PN_ENTITY

static final String PN_ENTITY

See Also:

Constant Field Values

CC_ASIPATH

static final String CC_ASIPATH

See Also:

Constant Field Values

CC_HOST_URL

static final String CC_HOST_URL

See Also:

Constant Field Values

CC_REPORT_SUITE

static final String CC_REPORT_SUITE

See Also:

Constant Field Values

CC_CONSUMER_KEY

static final String CC_CONSUMER_KEY

See Also:

Constant Field Values

CC_SECRET_KEY

static final String CC_SECRET_KEY

See Also:

Constant Field Values

COMMENTID_SEPARATOR

static final String COMMENTID_SEPARATOR

See Also:

Constant Field Values

CLOUD_SERVICE_REQUEST_LIST

static final String CLOUD_SERVICE_REQUEST_LIST

See Also:

Constant Field Values

PROP_COMPONENT

static final String PROP_COMPONENT

The property name for the path to the comments component.

See Also:

Constant Field Values

COMMENT_CS_RESOURCE_TYPE

static final String COMMENT_CS_RESOURCE_TYPE

The resource type for the comments component.

See Also:

Constant Field Values

PATH_UGC

static final String PATH_UGC

The path to the user-generated content.

See Also:

Constant Field Values

PN_REMOTE_UGC_LOCATION

static final String PN_REMOTE_UGC_LOCATION

Property name for pointing a Social component to remote piece of UGC.

See Also:

Constant Field Values

BUCKET_TYPE

static final String BUCKET_TYPE

Property name for bucket resource type.

See Also:

Constant Field Values

GROUP_MEMBERGROUP

static final String GROUP_MEMBERGROUP

Property name for group's member group.

See Also:

Constant Field Values

COMMENT_NODE_TYPE

static final String COMMENT_NODE_TYPE

The comment node type.

See Also:

Constant Field Values

DEFAULT_AVATAR

static final String DEFAULT_AVATAR

Default avatar URL.

See Also:

Constant Field Values

NN_COMMENT_ATTACHMENTS

static final String NN_COMMENT_ATTACHMENTS

The property name for the Comment Attachments folder.

See Also:

Constant Field Values

Method Detail

createUniqueNameHint

String createUniqueNameHint(String message)

createUniqueNameHint

String createUniqueNameHint(String message,
                          int numRandomChars)

getResourceTypeFromDesign

String getResourceTypeFromDesign(Resource resource,
                               String styleProperty,
                               String defaultValue)

checkPermission

Boolean checkPermission(ResourceResolver resolver,
                      String path,
                      String action)

Checks a path and an action based on the passed in resolver.

Parameters:

resolver - the resource resolver to use to evaluate the permissions

path - the path to the resource to check

action - the action to check

Returns:

True if the resolver is allowed to take the requested action, otherwise false

getUGCResource

Resource getUGCResource(Resource userResource,
                      ResourceResolverFactory rrf)

Gets the base UGC Resource from a SocialResource. This is used to get the JCR base node of a remote piece of UGC. It will also create all the parallel content/usergenerated paths.

Parameters:

userResource - a path to a resource that needs to have its UGC Resource located.

rrf - a resource resolver factory to use to create the nodes in the UGC area

Returns:

the path to the UGC location for this social resource

getUGCResource

Resource getUGCResource(Resource userResource,
                      ResourceResolverFactory rrf,
                      String resourceTypeHint)

Gets the base UGC Resource from a SocialResource. This is used to get the JCR base node of a remote piece of UGC. It will also create all the parallel content/usergenerated paths.

Parameters:

userResource - a path to a resource that needs to have its UGC Resource located.

rrf - a resource resolver factory to use to create the nodes in the UGC area

resourceTypeHint - the resource type to set on the root node in the UGC tree, this is used when components are cq:included onto a page

Returns:

the path to the UGC location for this social resource

generateRandomString

String generateRandomString(int length)

Generates a (secure) random string with the given length.

Parameters:

length - length of random string.

Returns:

a random string.

getStorageCloudServiceConfig

Configuration getStorageCloudServiceConfig(Resource resource)

From a resource get the cloud configuration for the social data service.

Parameters:

resource - the base resource to check the cloud configuration for

Returns:

a configuration for the social data store or null if one does not exist

getUserProperties

UserProperties getUserProperties(ResourceResolver resolver,
                               String userId)

Returns the user properties denoted by the given userId. The user props are looked for using the provided resource resolver, so as to ensure that the user properties are only accessible to users having the necessary access rights on the requested user properties.

Parameters:

resolver - The ResourceResolver.

userId - The user id for which to retrieve the user properties.

Returns:

The UserProperties or null if not found.

getAvatar

String getAvatar(UserProperties userProperties)

Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

Returns:

the avatar URL or the default one.

getAvatar

String getAvatar(UserProperties userProperties,
               String absoluteDefaultAvatar)

Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

absoluteDefaultAvatar - The absolute default avatar

Returns:

the avatar URL or the default one.

getAvatar

String getAvatar(UserProperties userProperties,
               String absoluteDefaultAvatar,
               SocialUtils.AVATAR_SIZE size)

Returns the userProperties avatar URL or absoluteDefaultAvatar if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

absoluteDefaultAvatar - The absolute default avatar

size - The avatar size (for example, 32)

Returns:

the avatar URL or the default one.

getAvatar

String getAvatar(UserProperties userProperties,
               int size)

Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.

Parameters:

userProperties - The userProperties (may be null)

size - The avatar size (for example, 32)

Returns:

the avatar URL or the default one.

getPagePath

String getPagePath(Resource resource)

Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.

Parameters:

resource - The resource to check.

Returns:

A String representing the page path.

createNode

Node createNode(ResourceResolver resolver,
              String path,
              String nodeType)
                throws SocialException

Create node.

Parameters:

resolver - The ResourceResolver to use for persisting values.

path - The path of the node to be created

nodeType - The node type

Returns:

Node object.

Throws:

CollabException - if error occurs in Social Collaboration

SocialException

resourceToUGCPath

String resourceToUGCPath(Resource resource)

This method maps the given resource to its equivalent path in /usergenerated, e.g. as the relationship a page /content/test to its comment at /content/usergenerated/content/test.

Parameters:

resource - The resource to transpose to the comment's UCG path.

Returns:

A String representing the equivalent UCG path.

canAddNode

boolean canAddNode(Session session,
                 String path)

Checks whether the given session has the permission to add a node below the given path.

Parameters:

session - The Session to check the permissions for.

path - The repository path under which the "add node" permission is to be checked.

Returns:

false if the session is null or the session does not have add node permissions on the given path.

mayPost

boolean mayPost(ResourceResolver resolver,
              Resource resource)

Indicates whether the user within the given resource resolver has enough permissions to post to the given resource component. If no posts to the specified resource have yet been made, the permissions on the PATH_UGC path are checked instead.

Parameters:

resolver - The ResourceResolver

resource - The Resource component.

Returns:

true if the user may post.

prepareUserGeneratedContent

String prepareUserGeneratedContent(ResourceResolver resolver,
                                 String path)
                                   throws SocialException

Prepare user generated content for the specified path. The path can be the page path or the ugc collection root.

Parameters:

resolver - The ResourceResolver to use for persisting values.

path - The page path

Returns:

the user generated content page path.

Throws:

CollabException - if error occurs in Social Collaboration

SocialException

UGCToResourcePath

String UGCToResourcePath(Resource resource)

This method maps the given resource in /content/usergenerated to its equivalent path in the normal content tree, e.g. as the relationship of a comment in //content/usergenerated/content/test to its parent resource at /content/test.

Parameters:

resource - The resource to transpose.

Returns:

A String representing the equivalent normal content path.

UGCToResourcePath

String UGCToResourcePath(String ugcPath,
                       ResourceResolver resolver)

This method maps the given resource in /content/usergenerated to its equivalent path in the normal content tree, e.g. as the relationship of a comment in //content/usergenerated/content/test to its parent resource at /content/test.

Parameters:

ugcPath - The path to transpose.

resolver - The resource resolver to use.

Returns:

A String representing the equivalent normal content path.

getContainingPage

Page getContainingPage(Resource resource)

Finds the page which contains the given resource

Parameters:

resource - the resource for which the page is to be found

Returns:

the page that contains the resource

getPage

Page getPage(String path,
           ResourceResolver resolver)

Parameters:

path - path to the page

resolver - resolver to us

Returns:

the Page object for the given path if a page exists, null otherwise.

getConfiguredProvider

SocialResourceProvider getConfiguredProvider(Resource resource)

A simple way of getting the configured SocialResourceProvider for a resource.

Parameters:

resource - The resource to use as the base of the resolution

Returns:

getSocialProfileURL

String getSocialProfileURL(String username,
                         ResourceResolver resolver,
                         Page page)

Gets the social profile url for a user based on the page being passed in. The form used to show the profile will be the read from "cq:socialProfilePage" in the content hierarchy "above" the page requested.

Parameters:

username - user to find the profile for.

resolver - the resolver to use, which must have read access to the profile other

page - the page to use as the basis for the search for "cq:socialProfilePage" property.

Returns:

a url to the profile or null if the username was not found.

hasModeratePermissions

boolean hasModeratePermissions(Resource resource)

Check if the login user can moderate a given resource. This will always return false if the resource is not under the UGC tree.

Parameters:

resource - The resource to check

Returns:

true iff the login user can moderate a given resource.

getResourceTypeForIncludedResource

String getResourceTypeForIncludedResource(Resource component,
                                        String defaultResourceType,
                                        String designPropertyName)

Returns the resource type of a Component when it is included dynamically via cq:include. This will check the component node, then the design to determine if one is available, if it cannot retrieve another resource type it will return the defaultResourceType.

Parameters:

component - the component to determine the type for

defaultResourceType - the fall back if no suitable matchers are found

designPropertyName - the name of the design property to try and use

Returns:

a valid resource type to use when dealing with dynamically included components

mayAccessUGC

boolean mayAccessUGC(ResourceResolver resolver)

May access ugc.

Parameters:

resolver - the resolver

Returns:

true, if successful