com.adobe.cq.social.srp.internal

Class SocialResourceUtils

java.lang.Object

com.adobe.cq.social.srp.internal.SocialResourceUtils

public final class SocialResourceUtils
extends Object

Static social utilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocialResourceUtils.AVATAR_SIZE enum for avartar's size.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASI_UGC_PREFIX The SRP prefix.
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	DEFAULT_AVATAR Default avatar URL.
static String	GRAVATAR_PREFIX
static String	PATH_UGC The path to the user-generated content.
static String	SRP_CONFIGURATION_ROOT Where config definitions are stored.
static String	SRP_DEFAULT_CONFIG_PATH

Method Summary

Modifier and Type	Method and Description
static boolean	causeByInvalidItemStateException(Exception e) Check to see if the specified exception caused by a jcr InvalidItemStateException.
static Boolean	checkPermission(ResourceResolver resolver, String path, String action) Checks a path and an action based on the passed in resolver.
static String	getAvatar(UserProperties userProperties, String absoluteDefaultAvatar, SocialResourceUtils.AVATAR_SIZE size) Returns the userProperties avatar URL or CollabUtil#DEFAULT_AVATAR if profile has no avatar defined.
static String	getAvatar(UserProperties userProperties, String absoluteDefaultAvatar, String size) Returns the userProperties avatar URL or CollabUtil#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) Check if a resource is a wrapped resource, and unwrap until a SocialResource is found.
static String	getUniqueUGCResourceName(ResourceResolver resourceResolver, String ugcPath, SocialResourceProvider resourceProvider, String nodeName)
static UserProperties	getUserProperties(ResourceResolver resolver, String userId) Returns the user properties denoted by the given userId.
static boolean	isCloudUGC(String path) Check if path is non JCR based.
static boolean	isSocialResource(Resource res) Check if a given resource is an instance of SocialResource.

Methods inherited from class java.lang.Object

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

Field Detail

GRAVATAR_PREFIX

public static String GRAVATAR_PREFIX

PATH_UGC

public static final String PATH_UGC

The path to the user-generated content.

See Also:

Constant Field Values

ASI_UGC_PREFIX

public static final String ASI_UGC_PREFIX

The SRP prefix.

See Also:

Constant Field Values

DEFAULT_AVATAR

public static final String DEFAULT_AVATAR

Default avatar URL.

See Also:

Constant Field Values

CC_ASIPATH

public static final String CC_ASIPATH

See Also:

Constant Field Values

CC_HOST_URL

public static final String CC_HOST_URL

See Also:

Constant Field Values

CC_REPORT_SUITE

public static final String CC_REPORT_SUITE

See Also:

Constant Field Values

CC_CONSUMER_KEY

public static final String CC_CONSUMER_KEY

See Also:

Constant Field Values

CC_SECRET_KEY

public static final String CC_SECRET_KEY

See Also:

Constant Field Values

SRP_CONFIGURATION_ROOT

public static final String SRP_CONFIGURATION_ROOT

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 String SRP_DEFAULT_CONFIG_PATH

See Also:

Constant Field Values

Method Detail

checkPermission

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

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

public static String getAvatar(UserProperties userProperties,
                               String absoluteDefaultAvatar,
                               SocialResourceUtils.AVATAR_SIZE size)

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

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

Returns:

the avatar URL or the default one.

getAvatar

public static String getAvatar(UserProperties userProperties,
                               String absoluteDefaultAvatar,
                               String size)

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

size - The avatar size (for example, 32)

Returns:

the avatar URL or the default one.

isCloudUGC

public static boolean isCloudUGC(String path)

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)

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)

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(Exception e)

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

getUniqueUGCResourceName

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