com.adobe.cq.social.srp.utilities.internal

Class InternalStaticResourceUtilities

java.lang.Object

com.adobe.cq.social.srp.utilities.internal.InternalStaticResourceUtilities

All Implemented Interfaces:

org.osgi.framework.BundleActivator

public class InternalStaticResourceUtilities
extends Object
implements org.osgi.framework.BundleActivator

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 Node	getOrCreateByPathDepthFirst(String path, boolean createUniqueLeaf, String intermediateNodeType, String nodeType, Session session, boolean autoSave) Creates or gets the Node at the given path.
static SocialResource	getSocialResource(Resource res) Check if a resource is a wrapped resource, and unwrap until a SocialResource is found.
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.
void	start(org.osgi.framework.BundleContext context)
void	stop(org.osgi.framework.BundleContext context)

Methods inherited from class java.lang.Object

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

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

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.

isCloudUGC

public static boolean isCloudUGC(String path)

Check if path is non JCR based. Assume that all alternate storage paths have prefix InternalStaticResourceUtilities#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

getOrCreateByPathDepthFirst

public static Node getOrCreateByPathDepthFirst(String path,
                                               boolean createUniqueLeaf,
                                               String intermediateNodeType,
                                               String nodeType,
                                               Session session,
                                               boolean autoSave)
                                        throws RepositoryException

Creates or gets the Node at the given path. In case it has to create the Node all non-existent intermediate path-elements will be created with the given intermediate node type and the returned node will be created with the given nodeType. This version exists to ensure creation only needs to read and write the deepest of the existing ancestors of the target node. This allows creation of paths where some ancestors exist but are not readable by the session in use. For further details see: org.apache.jackrabbit.commons.JcrUtils.getOrCreateByPath(Node, String, boolean, String, String, boolean)

Parameters:

path - the deep path to get or create

createUniqueLeaf - not used?

intermediateNodeType - node type to be used in creating any required intermediate nodes

nodeType - the node type for the leaf node

session - the session to create the nodes with

autoSave - to save when done

Returns:

the create leaf node

Throws:

RepositoryException - when JCR cannot create either any of the intermediate nodes or the leaf node

start

public void start(org.osgi.framework.BundleContext context)
           throws Exception

Specified by:

start in interface org.osgi.framework.BundleActivator

Throws:

Exception

stop

public void stop(org.osgi.framework.BundleContext context)
          throws Exception

Specified by:

stop in interface org.osgi.framework.BundleActivator

Throws:

Exception