com.adobe.cq.social.ugcbase

Interface SocialUtils

Deprecated.

@Deprecated
public interface SocialUtils

Social Utilities.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
boolean	canAddNode(Session session, java.lang.String path) Deprecated. Can add node at path.
java.lang.Boolean	checkPermission(ResourceResolver resolver, java.lang.String path, java.lang.String action) Deprecated. Checks a path and an action based on the passed in resolver.
Node	createNode(ResourceResolver resolver, java.lang.String path, java.lang.String nodeType) Deprecated. Create node.
java.lang.String	createUniqueNameHint(java.lang.String message) Deprecated.
java.lang.String	createUniqueNameHint(java.lang.String message, int numRandomChars) Deprecated.
java.lang.String	generateRandomString(int length) Deprecated. Generates a (secure) random string with the given length.
java.lang.String	getAvatar(UserProperties userProperties) Deprecated. Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
java.lang.String	getAvatar(UserProperties userProperties, int size) Deprecated. Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
java.lang.String	getAvatar(UserProperties userProperties, java.lang.String absoluteDefaultAvatar) Deprecated. Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
java.lang.String	getAvatar(UserProperties userProperties, java.lang.String absoluteDefaultAvatar, SocialUtils.AVATAR_SIZE size) Deprecated. Returns the userProperties avatar URL or absoluteDefaultAvatar if profile has no avatar defined.
java.lang.String	getCommonStorePath(Resource resource) Deprecated. This method maps the given resource to its equivalent resource path based on applicable global shared storage cloud config settings.
SocialResourceProvider	getConfiguredProvider(Resource resource) Deprecated. A simple way of getting the configured SocialResourceProvider for a resource.
Page	getContainingPage(Resource resource) Deprecated. Finds the page which contains the given resource.
SocialResourceConfiguration	getDefaultStorageConfig() Deprecated. From a resource get the configuration for the social data service.
Page	getPage(java.lang.String path, ResourceResolver resolver) Deprecated.
java.lang.String	getPagePath(Resource resource) Deprecated. Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.
java.lang.String	getPagePath(java.lang.String path) Deprecated. Returns the given resource's path without its potential /jcr:content/... suffix, thus representing a page path.
Resource	getResourceAtPath(ResourceResolver resolver, java.lang.String path) Deprecated. Return a resource at path.
Resource	getResourceAtPath(ResourceResolver resolver, java.lang.String path, java.lang.String resourceType) Deprecated. Return a resource at path.
java.lang.String	getResourceTypeForIncludedResource(Resource component, java.lang.String defaultResourceType, java.lang.String designPropertyName) Deprecated. Returns the resource type of a Component when it is included dynamically via cq:include.
java.lang.String	getResourceTypeFromDesign(Resource resource, java.lang.String styleProperty, java.lang.String defaultValue) Deprecated.
java.lang.String	getSocialProfileURL(java.lang.String username, ResourceResolver resolver, Page page) Deprecated. Gets the social profile url for a user based on the page being passed in.
SocialResourceProvider	getSocialResourceProvider(Resource resource) Deprecated. Get a SocialResourceProvider given a resource.
SocialResourceProvider	getSocialResourceProvider(ResourceResolver resolver, java.lang.String path) Deprecated. Get a SocialResourceProvider given a path and a resolver.
SocialResourceProvider	getSocialResourceProvider(java.lang.String path) Deprecated.
Configuration	getStorageCloudServiceConfig(Resource resource) Deprecated. use getStorageConfig
SocialResourceConfiguration	getStorageConfig(Resource resource) Deprecated. From a resource get the configuration for the social data service.
TranslationManager	getTranslationManager() Deprecated.
TranslationSaveQueue	getTranslationSaveQueue() Deprecated. Return reference to TranslationSaveQueue to save translation batch jobs.
Resource	getUGCResource(Resource userResource) Deprecated. Gets the base UGC Resource from a SocialResource.
Resource	getUGCResource(Resource userResource, ResourceResolverFactory rrf) Deprecated.
Resource	getUGCResource(Resource userResource, ResourceResolverFactory rrf, java.lang.String resourceTypeHint) Deprecated.
Resource	getUGCResource(Resource userResource, java.lang.String resourceTypeHint) Deprecated. Gets the base UGC Resource from a SocialResource.
UserProperties	getUserProperties(ResourceResolver resolver, java.lang.String userId) Deprecated. Returns the user properties denoted by the given userId.
boolean	hasModeratePermissions(Resource resource) Deprecated. Check if the login user can moderate a given resource.
boolean	isResourceOwner(Resource resource) Deprecated. Check if the login user is the resource owner.
boolean	isUserInGroups(ResourceResolver resolver, java.lang.String userId, java.util.List<java.lang.String> groupIds) Deprecated. Checks if is user in group.
java.lang.String	mapUGCPath(Resource resource) Deprecated. Map a UGC path, avoiding multiple round trips.
java.lang.String	mapUGCPath(java.lang.String ugcPath, ResourceResolver resolver) Deprecated. Map a UGC path, avoiding multiple round trips.
boolean	mayAccessUGC(ResourceResolver resolver) Deprecated. May access ugc.
boolean	mayPost(ResourceResolver resolver, Resource resource) Deprecated. Indicates whether the user within the given resource resolver has enough permissions to post to the given resource component.
java.lang.String	prepareUserGeneratedContent(ResourceResolver resolver, java.lang.String path) Deprecated. Prepare user generated content for the specified path.
java.lang.String	resourceToACLPath(Resource resource) Deprecated. This method maps the given resource to its equivalent path in UGC for ACL checking.
java.lang.String	resourceToUGCPath(Resource resource) Deprecated. Use resourceToACLPath or resourceToUGCStoragePath
java.lang.String	resourceToUGCStoragePath(Resource resource) Deprecated. This method maps the given resource to its equivalent UGC page path.
java.lang.String	UGCToResourcePath(Resource resource) Deprecated. 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, ResourceResolver resolver) Deprecated. 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 java.lang.String PN_PARENTID

Deprecated.

See Also:

Constant Field Values

PN_DATE

static final java.lang.String PN_DATE

Deprecated.

See Also:

Constant Field Values

PN_COMMENT_RESOURCETYPE

static final java.lang.String PN_COMMENT_RESOURCETYPE

Deprecated.

See Also:

Constant Field Values

PN_TOPIC_RESOURCETYPE

static final java.lang.String PN_TOPIC_RESOURCETYPE

Deprecated.

See Also:

Constant Field Values

PN_POST_RESOURCETYPE

static final java.lang.String PN_POST_RESOURCETYPE

Deprecated.

See Also:

Constant Field Values

PN_SLING_RESOURCETYPE

static final java.lang.String PN_SLING_RESOURCETYPE

Deprecated.

See Also:

Constant Field Values

PN_DS_KEY

static final java.lang.String PN_DS_KEY

Deprecated.

See Also:

Constant Field Values

PN_CS_ROOT

static final java.lang.String PN_CS_ROOT

Deprecated.

See Also:

Constant Field Values

PN_BASETYPE

static final java.lang.String PN_BASETYPE

Deprecated.

See Also:

Constant Field Values

PN_ATTACHMENT_LIST

static final java.lang.String PN_ATTACHMENT_LIST

Deprecated.

See Also:

Constant Field Values

PN_IS_REPLY

static final java.lang.String PN_IS_REPLY

Deprecated.

See Also:

Constant Field Values

PN_ENTITY

static final java.lang.String PN_ENTITY

Deprecated.

See Also:

Constant Field Values

CC_ASIPATH

static final java.lang.String CC_ASIPATH

Deprecated.

See Also:

Constant Field Values

CC_HOST_URL

static final java.lang.String CC_HOST_URL

Deprecated.

See Also:

Constant Field Values

CC_REPORT_SUITE

static final java.lang.String CC_REPORT_SUITE

Deprecated.

See Also:

Constant Field Values

CC_CONSUMER_KEY

static final java.lang.String CC_CONSUMER_KEY

Deprecated.

See Also:

Constant Field Values

CC_SECRET_KEY

static final java.lang.String CC_SECRET_KEY

Deprecated.

See Also:

Constant Field Values

COMMENTID_SEPARATOR

static final java.lang.String COMMENTID_SEPARATOR

Deprecated.

See Also:

Constant Field Values

PROP_COMPONENT

static final java.lang.String PROP_COMPONENT

Deprecated.

The property name for the path to the comments component.

See Also:

Constant Field Values

COMMENT_CS_RESOURCE_TYPE

static final java.lang.String COMMENT_CS_RESOURCE_TYPE

Deprecated.

The resource type for the comments component.

See Also:

Constant Field Values

PATH_UGC

static final java.lang.String PATH_UGC

Deprecated.

The path to the user-generated content.

See Also:

Constant Field Values

ASI_UGC_PREFIX

static final java.lang.String ASI_UGC_PREFIX

Deprecated.

The SRP prefix.

See Also:

Constant Field Values

SRP_CLOUD_PATH

static final java.lang.String SRP_CLOUD_PATH

Deprecated.

The Cloud prefix.

See Also:

Constant Field Values

SRP_MONGO_PATH

static final java.lang.String SRP_MONGO_PATH

Deprecated.

Mongo prefix.

See Also:

Constant Field Values

SRP_JSRP_PATH

static final java.lang.String SRP_JSRP_PATH

Deprecated.

JSRP prefix.

See Also:

Constant Field Values

PN_REMOTE_UGC_LOCATION

static final java.lang.String PN_REMOTE_UGC_LOCATION

Deprecated.

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

See Also:

Constant Field Values

BUCKET_TYPE

static final java.lang.String BUCKET_TYPE

Deprecated.

Property name for bucket resource type.

See Also:

Constant Field Values

GROUP_MEMBERGROUP

static final java.lang.String GROUP_MEMBERGROUP

Deprecated.

Property name for group's member group.

See Also:

Constant Field Values

COMMENT_NODE_TYPE

static final java.lang.String COMMENT_NODE_TYPE

Deprecated.

The comment node type.

See Also:

Constant Field Values

DEFAULT_AVATAR

static final java.lang.String DEFAULT_AVATAR

Deprecated.

Default avatar URL.

See Also:

Constant Field Values

NN_COMMENT_ATTACHMENTS

static final java.lang.String NN_COMMENT_ATTACHMENTS

Deprecated.

The property name for the Comment Attachments folder.

See Also:

Constant Field Values

Method Detail

createUniqueNameHint

java.lang.String createUniqueNameHint(java.lang.String message)

Deprecated.

createUniqueNameHint

java.lang.String createUniqueNameHint(java.lang.String message,
                                      int numRandomChars)

Deprecated.

getResourceTypeFromDesign

java.lang.String getResourceTypeFromDesign(Resource resource,
                                           java.lang.String styleProperty,
                                           java.lang.String defaultValue)

Deprecated.

checkPermission

java.lang.Boolean checkPermission(ResourceResolver resolver,
                                  java.lang.String path,
                                  java.lang.String action)

Deprecated.

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)

Deprecated.

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

@Deprecated
Resource getUGCResource(Resource userResource,
                                    ResourceResolverFactory rrf)

Deprecated.

getUGCResource

Resource getUGCResource(Resource userResource,
                        java.lang.String resourceTypeHint)

Deprecated.

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

getUGCResource

@Deprecated
Resource getUGCResource(Resource userResource,
                                    ResourceResolverFactory rrf,
                                    java.lang.String resourceTypeHint)

Deprecated.

generateRandomString

java.lang.String generateRandomString(int length)

Deprecated.

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

Parameters:

length - length of random string.

Returns:

a random string.

getStorageCloudServiceConfig

@Deprecated
Configuration getStorageCloudServiceConfig(Resource resource)

Deprecated. use getStorageConfig

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

getStorageConfig

SocialResourceConfiguration getStorageConfig(Resource resource)

Deprecated.

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

getDefaultStorageConfig

SocialResourceConfiguration getDefaultStorageConfig()

Deprecated.

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

Returns:

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

getUserProperties

UserProperties getUserProperties(ResourceResolver resolver,
                                 java.lang.String userId)

Deprecated.

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

java.lang.String getAvatar(UserProperties userProperties)

Deprecated.

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

Parameters:

userProperties - The userProperties (may be null)

Returns:

the avatar URL or the default one.

getAvatar

java.lang.String getAvatar(UserProperties userProperties,
                           java.lang.String absoluteDefaultAvatar)

Deprecated.

Returns the userProperties avatar URL or InternalSCFUtilities.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

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

Deprecated.

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

java.lang.String getAvatar(UserProperties userProperties,
                           int size)

Deprecated.

Returns the userProperties avatar URL or InternalSCFUtilities.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

java.lang.String getPagePath(Resource resource)

Deprecated.

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.

getPagePath

java.lang.String getPagePath(java.lang.String path)

Deprecated.

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

Parameters:

path - The path to check.

Returns:

A String representing the page path.

createNode

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

Deprecated.

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:

SocialException - if error occurs in Social Collaboration

resourceToUGCPath

@Deprecated
java.lang.String resourceToUGCPath(Resource resource)

Deprecated. Use resourceToACLPath or resourceToUGCStoragePath

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. 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.

resourceToACLPath

java.lang.String resourceToACLPath(Resource resource)

Deprecated.

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

java.lang.String resourceToUGCStoragePath(Resource resource)

Deprecated.

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.

canAddNode

boolean canAddNode(Session session,
                   java.lang.String path)

Deprecated.

Can add node at path.

Parameters:

session - session

path - path

Returns:

true if node can be added at path in this session

mayPost

boolean mayPost(ResourceResolver resolver,
                Resource resource)

Deprecated.

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

java.lang.String prepareUserGeneratedContent(ResourceResolver resolver,
                                             java.lang.String path)
                                      throws SocialException

Deprecated.

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:

SocialException - if error occurs in Social Collaboration

UGCToResourcePath

java.lang.String UGCToResourcePath(Resource resource)

Deprecated.

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

java.lang.String UGCToResourcePath(java.lang.String ugcPath,
                                   ResourceResolver resolver)

Deprecated.

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.

mapUGCPath

java.lang.String mapUGCPath(Resource resource)

Deprecated.

Map a UGC path, avoiding multiple round trips.

Parameters:

resource - The resource to transpose.

Returns:

the mapped path

mapUGCPath

java.lang.String mapUGCPath(java.lang.String ugcPath,
                            ResourceResolver resolver)

Deprecated.

Map a UGC path, avoiding multiple round trips.

Parameters:

ugcPath - the ugc path to map

resolver - the resolver to use

Returns:

the mapped path

getContainingPage

Page getContainingPage(Resource resource)

Deprecated.

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(java.lang.String path,
             ResourceResolver resolver)

Deprecated.

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)

Deprecated.

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

Parameters:

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

Returns:

The social resource provider

getSocialProfileURL

java.lang.String getSocialProfileURL(java.lang.String username,
                                     ResourceResolver resolver,
                                     Page page)

Deprecated.

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)

Deprecated.

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

java.lang.String getResourceTypeForIncludedResource(Resource component,
                                                    java.lang.String defaultResourceType,
                                                    java.lang.String designPropertyName)

Deprecated.

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)

Deprecated.

May access ugc.

Parameters:

resolver - the resolver

Returns:

true, if successful

getTranslationManager

TranslationManager getTranslationManager()

Deprecated.

getSocialResourceProvider

SocialResourceProvider getSocialResourceProvider(Resource resource)

Deprecated.

Get a SocialResourceProvider given a resource.

Parameters:

resource - The resource to return the provider for.

Returns:

social resource provider

getSocialResourceProvider

SocialResourceProvider getSocialResourceProvider(ResourceResolver resolver,
                                                 java.lang.String path)

Deprecated.

Get a SocialResourceProvider given a path and a resolver. Replaces SocialUtils.getSocialResourceProvider(final String path)

Parameters:

path - The path to return the provider for.

resolver - A resolver with sufficient privileges to fetch a resource within the asi path.

Returns:

social resource provider

getSocialResourceProvider

@Deprecated
SocialResourceProvider getSocialResourceProvider(java.lang.String path)

Deprecated.

We no longer support this function. It had serious errors because it would close the session of a common service user after performing its task. use SocialUtils.getSocialResourceProvider(ResourceResolver resolver, String path) instead

Parameters:

path - The path to return the provider for.

Returns:

social resource provider

getResourceAtPath

Resource getResourceAtPath(ResourceResolver resolver,
                           java.lang.String path)

Deprecated.

Return a resource at path. In SRP, we don't have place keeper parent nodes, so resource may not exist at the path, but one may exist below the path. Create a SyntheticResource of SocialUtils.COMMENT_NODE_TYPE if UGC path and no resource at path.

Parameters:

resolver - Resolver to use

path - The path to get the resource at

Returns:

the resource at path (or synthetic if uGC and no resource at path)

getResourceAtPath

Resource getResourceAtPath(ResourceResolver resolver,
                           java.lang.String path,
                           java.lang.String resourceType)

Deprecated.

Return a resource at path. In SRP, we don't have place keeper parent nodes, so resource may not exist at the path, but one may exist below the path. Create a SyntheticResource of passed in type if UGC path and no resource at path.

Parameters:

resolver - Resolver to use

path - The path to get the resource at

resourceType - Resource type of returned SyntheticResource.

Returns:

the resource at path (or synthetic if uGC and no resource at path)

isResourceOwner

boolean isResourceOwner(Resource resource)

Deprecated.

Check if the login user is the resource owner.

Parameters:

resource - The resource to check

Returns:

true iff the login user is the resource owner.

getTranslationSaveQueue

TranslationSaveQueue getTranslationSaveQueue()

Deprecated.

Return reference to TranslationSaveQueue to save translation batch jobs.

Returns:

TranslationSaveQueue translation save queue

getCommonStorePath

java.lang.String getCommonStorePath(Resource resource)

Deprecated.

This method maps the given resource to its equivalent resource path based on applicable global shared storage cloud config settings.

Parameters:

resource - The resource to transpose.

Returns:

string representing the global shared storage resource path.

isUserInGroups

boolean isUserInGroups(ResourceResolver resolver,
                       java.lang.String userId,
                       java.util.List<java.lang.String> groupIds)

Deprecated.

Checks if is user in group.

Parameters:

resolver - The ResourceResolver used to get the user information. Should be ServiceUser/Admin user resolver if not checking for current user

userId - the user id

groupIds - the group ids

Returns:

true, if is user in group