org.alfresco.rest.framework.core

Class ResourceInspector

java.lang.Object

org.alfresco.rest.framework.core.ResourceInspector

public class ResourceInspector
extends Object

Looks at resources to see what they can do

Author:

Gethin James

Constructor Summary

Constructors

Constructor and Description
ResourceInspector()

Method Summary

Methods

Modifier and Type	Method and Description
static Map<String,Pair<String,Method>>	findEmbeddedResources(Class<?> anyClass) For a given class, looks for @EmbeddedEntityResource annotations, using the annotation produce a Map of the property name key and the entity key
static String	findEntityCollectionNameName(ResourceMetadata meta) Finds the name of the entity collection using the meta information.
protected static String	findEntityName(EntityResource entityAnnot) Finds the name of the entity using its annotation.
protected static String	findEntityNameByAnnotationAttributes(Map<String,Object> annotAttribs) Finds the name of the entity using its annotation.
static Method	findMethod(Class<? extends ResourceAction> resourceInterfaceWithOneMethod, Class<?> resource) Returns the method for the interface
static String	findUniqueId(Object obj) Finds the unique id of an object using the @UniqueId annotation.
static Method	findUniqueIdMethod(Class<?> objClass) Finds a single method with the @UniqueId annotation.
static String	findUniqueIdName(Method uniqueIdMethod) Finds the property name that is used as the unique id.
static List<ResourceMetadata>	inspect(Class resource) Inspects the annotated resource to understand its capabilities
static void	inspectAddressedProperties(Api api, Class<?> resource, String entityPath, List<ResourceMetadata> metainfo) Inspects the entity resource and returns meta data about any addresssed/binary properties
static Api	inspectApi(Class<?> resource) Inspects the resource to determine what api it belongs to.
static ResourceOperation	inspectOperation(Class<?> resource, Method aMethod, org.springframework.http.HttpMethod httpMethod) Inspects the method and returns meta data about its operations
static boolean	isDeleted(Method method) Returns true if the method has been marked as deleted.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceInspector

public ResourceInspector()

Method Detail

inspectAddressedProperties

public static void inspectAddressedProperties(Api api,
                              Class<?> resource,
                              String entityPath,
                              List<ResourceMetadata> metainfo)

Inspects the entity resource and returns meta data about any addresssed/binary properties

Parameters:

api -

inspectOperation

public static ResourceOperation inspectOperation(Class<?> resource,
                                 Method aMethod,
                                 org.springframework.http.HttpMethod httpMethod)

Inspects the method and returns meta data about its operations

Parameters:

resource -

aMethod -

httpMethod -

defaultParams -

Returns:

ResourceOperation

isDeleted

public static boolean isDeleted(Method method)

Returns true if the method has been marked as deleted.

Parameters:

method - the method

Returns:

true - if is is marked as deleted.

findMethod

public static Method findMethod(Class<? extends ResourceAction> resourceInterfaceWithOneMethod,
                Class<?> resource)

Returns the method for the interface

Parameters:

resourceInterfaceWithOneMethod -

resource -

Returns:

null or a Method

findEntityNameByAnnotationAttributes

protected static String findEntityNameByAnnotationAttributes(Map<String,Object> annotAttribs)

Finds the name of the entity using its annotation.

Parameters:

annotAttribs -

Returns:

the entity name/path

findEntityName

protected static String findEntityName(EntityResource entityAnnot)

Finds the name of the entity using its annotation.

Parameters:

entityAnnot -

Returns:

the entity name/path

findEntityCollectionNameName

public static String findEntityCollectionNameName(ResourceMetadata meta)

Finds the name of the entity collection using the meta information.

Parameters:

entityAnnot -

Returns:

the entity name/path

findEmbeddedResources

public static Map<String,Pair<String,Method>> findEmbeddedResources(Class<?> anyClass)

For a given class, looks for @EmbeddedEntityResource annotations, using the annotation produce a Map of the property name key and the entity key

Parameters:

anyClass -

Returns:

A map of property key name and a value of the entity path name

inspectApi

public static Api inspectApi(Class<?> resource)

Inspects the resource to determine what api it belongs to. It does this by looking for the WebApi package annotation.

Parameters:

resource -

Returns:

Api

inspect

public static List<ResourceMetadata> inspect(Class resource)

Inspects the annotated resource to understand its capabilities

Parameters:

resource -

findUniqueId

public static String findUniqueId(Object obj)

Finds the unique id of an object using the @UniqueId annotation.

Parameters:

obj - any object

Returns:

a String object with the entity id set

findUniqueIdMethod

public static Method findUniqueIdMethod(Class<?> objClass)
                                 throws IllegalArgumentException

Finds a single method with the @UniqueId annotation.

Parameters:

obj - any object

Returns:

the Method

Throws:

IllegalArgumentException - if there is is more than 1 method annotated with @UniqueId

findUniqueIdName

public static String findUniqueIdName(Method uniqueIdMethod)

Finds the property name that is used as the unique id.

Parameters:

Method - uniqueIdMethod

Returns:

String the property name that is used as the unique id.