com.adobe.cq.social.srp.utilities.api

Interface SocialResourceUtilities

public interface SocialResourceUtilities

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	checkPermission(ResourceResolver resolver, java.lang.String path, java.lang.String action) Checks a path and an action based on the passed in resolver.
SocialResourceProvider	getSocialResourceProvider(Resource resource) Get a SocialResourceProvider given a resource.
SocialResourceConfiguration	getStorageConfig(Resource resource) From a resource get the configuration for the social data service.
Resource	getUGCResource(Resource userResource) Gets the base UGC Resource from a SocialResource.
Resource	getUGCResource(Resource userResource, java.lang.String resourceTypeHint) Gets the base UGC Resource from a SocialResource.
boolean	hasModeratePermissions(Resource resource) Check if the login user can moderate a given resource.
java.lang.String	resourceToACLPath(Resource resource) This method maps the given resource to its equivalent path in UGC for ACL checking.
java.lang.String	resourceToUGCStoragePath(Resource resource) This method maps the given resource to its equivalent UGC page path.
java.lang.String	ugcToResourcePath(Resource resource) This method maps the given resource in /content/usergenerated to its equivalent path in the normal content tree, e.g.
java.lang.String	ugcToResourcePath(java.lang.String ugcPath) This method maps the given resource in /content/usergenerated to its equivalent path in the normal content tree, e.g.

Method Detail

resourceToACLPath

@CheckForNull
java.lang.String resourceToACLPath(@Nullable
                                                 Resource resource)

This method maps the given resource to its equivalent path in UGC for ACL checking. For cloud storage a component like: /content/site/en/page/jcr:content/par/forum will map to /content/usergenerated/content/site/en/page/. For JCR content, /content/site/en/page/jcr:content/par/forum will map to: /content/usergenerated/content/site/en/page/ Note: This method maps the Cloud Storage path to the JCR marker used for ACL checking, not the path that is used as the resource path for the user generated content itself

Parameters:

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

Returns:

A String representing the equivalent UCG path.

resourceToUGCStoragePath

@CheckForNull
java.lang.String resourceToUGCStoragePath(@Nullable
                                                        Resource resource)

This method maps the given resource to its equivalent UGC page path. For cloud storage a component like: /content/site/en/page/jcr:content/par/forum will map to /content/usergenerated/asi/cloud/content/site/en/page/. For JCR content, /content/site/en/page/jcr:content/par/forum will map to: /content/usergenerated/content/site/en/page/ Note: A cloud path can not be used for ACL checking. See resourceToACLPath for mapping the resource to a UGC path suitable for ACL checking (returns the 'marker' in /content/usergenerated/content)

Parameters:

resource - The resource to transpose to the cloud UGC path.

Returns:

A String representing the equivalent cloud UCG path.

ugcToResourcePath

java.lang.String ugcToResourcePath(@Nonnull
                                   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

@CheckForNull
java.lang.String ugcToResourcePath(@Nullable
                                                 java.lang.String ugcPath)

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.

Returns:

A String representing the equivalent normal content path.

getUGCResource

@CheckForNull
Resource getUGCResource(Resource userResource)

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.

Returns:

the path to the UGC location for this social resource

getUGCResource

@CheckForNull
Resource getUGCResource(Resource userResource,
                                      java.lang.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.

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

getStorageConfig

@CheckForNull
SocialResourceConfiguration getStorageConfig(Resource resource)

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

Parameters:

resource - the base resource to get the configuration for

Returns:

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

getSocialResourceProvider

@CheckForNull
SocialResourceProvider getSocialResourceProvider(@Nullable
                                                               Resource resource)

Get a SocialResourceProvider given a resource.

Parameters:

resource - The resource to return the provider for.

Returns:

social resource provider, if a provider wasn't found it will return the default

hasModeratePermissions

boolean hasModeratePermissions(@Nonnull
                               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.

checkPermission

java.lang.Boolean checkPermission(@Nonnull
                                  ResourceResolver resolver,
                                  java.lang.String path,
                                  java.lang.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