com.adobe.cq.social.ugcbase.core

Class SocialResourceUtils

java.lang.Object

com.adobe.cq.social.ugcbase.core.SocialResourceUtils

Deprecated.

@Deprecated
public final class SocialResourceUtils
extends java.lang.Object

Static social utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRAVATAR_PREFIX Deprecated.
static java.lang.String	SRP_CONFIGURATION_ROOT Deprecated. Where config definitions are stored.
static java.lang.String	SRP_DEFAULT_CONFIG_PATH Deprecated.

Method Summary

Modifier and Type	Method and Description
static boolean	causeByInvalidItemStateException(java.lang.Exception e) Deprecated. Check to see if the specified exception caused by a jcr InvalidItemStateException.
static 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.
static java.lang.String	getAvatar(UserProperties userProperties, java.lang.String absoluteDefaultAvatar, SocialUtils.AVATAR_SIZE size) Deprecated. Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
static java.lang.String	getAvatar(UserProperties userProperties, java.lang.String absoluteDefaultAvatar, java.lang.String size) Deprecated. Returns the userProperties avatar URL or InternalSCFUtilities.DEFAULT_AVATAR if profile has no avatar defined.
static Configuration	getFirstCloudStorageConfig(ResourceResolver resolver) Deprecated. No longer using cloud storage, will return the default configuration.
static SocialResource	getSocialResource(Resource res) Deprecated. Check if a resource is a wrapped resource, and unwrap until a SocialResource is found.
static java.lang.String	getUniqueUGCResourceName(ResourceResolver resourceResolver, java.lang.String ugcPath, SocialResourceProvider resourceProvider, java.lang.String nodeName) Deprecated.
static UserProperties	getUserProperties(ResourceResolver resolver, java.lang.String userId) Deprecated. Returns the user properties denoted by the given userId.
static boolean	isCloudUGC(java.lang.String path) Deprecated. Check if path is non JCR based.
static boolean	isSocialResource(Resource res) Deprecated. Check if a given resource is an instance of SocialResource.
void	start(BundleContext context) Deprecated.
void	stop(BundleContext context) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GRAVATAR_PREFIX

public static java.lang.String GRAVATAR_PREFIX

Deprecated.

SRP_CONFIGURATION_ROOT

public static final java.lang.String SRP_CONFIGURATION_ROOT

Deprecated.

Where config definitions are stored. TODO: Temporary This will change once the config location settles down.

See Also:

Constant Field Values

SRP_DEFAULT_CONFIG_PATH

public static final java.lang.String SRP_DEFAULT_CONFIG_PATH

Deprecated.

See Also:

Constant Field Values

Method Detail

checkPermission

public static 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

getFirstCloudStorageConfig

@Deprecated
public static Configuration getFirstCloudStorageConfig(ResourceResolver resolver)

Deprecated. No longer using cloud storage, will return the default configuration.

Gets the first cloud storage provider. Note: Caller must have read access to configuration storage.

Parameters:

resolver - the resolver to use

Returns:

the configuration

getUserProperties

public static 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

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

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

size - The avatar size (for example, 32x48)

Returns:

the avatar URL or the default one.

getAvatar

public static java.lang.String getAvatar(UserProperties userProperties,
                                         java.lang.String absoluteDefaultAvatar,
                                         java.lang.String size)

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

size - The avatar size (for example, 32)

Returns:

the avatar URL or the default one.

isCloudUGC

public static boolean isCloudUGC(java.lang.String path)

Deprecated.

Check if path is non JCR based. Assume that all alternate storage paths have prefix SocialUtils.ASI_UGC_PREFIX, which is enforced in the cloudconfig UI.

Parameters:

path - the path to the ugc resource

Returns:

true if path is of alternate storage type (non jcr)

isSocialResource

public static boolean isSocialResource(Resource res)

Deprecated.

Check if a given resource is an instance of SocialResource.

Parameters:

res - the resource to check

Returns:

true if resource is a SocialResource

getSocialResource

public static SocialResource getSocialResource(Resource res)

Deprecated.

Check if a resource is a wrapped resource, and unwrap until a SocialResource is found.

Parameters:

res - resource to unwrap

Returns:

an unwrap resource or null if no SocialResource found

causeByInvalidItemStateException

public static boolean causeByInvalidItemStateException(java.lang.Exception e)

Deprecated.

Check to see if the specified exception caused by a jcr InvalidItemStateException. This exception is thrown if any of the changes to be persisted conflicts with a change already persisted through another session and the implementation is such that this conflict can only be detected at save-time and therefore was not detected earlier, at change-time.

Parameters:

e - The exception

Returns:

if caused by InvalidItemStateException

start

public void start(BundleContext context)
           throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getUniqueUGCResourceName

public static java.lang.String getUniqueUGCResourceName(ResourceResolver resourceResolver,
                                                        java.lang.String ugcPath,
                                                        SocialResourceProvider resourceProvider,
                                                        java.lang.String nodeName)

Deprecated.

stop

public void stop(BundleContext context)
          throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception