org.alfresco.rest.framework.core

Class ResourceMetadata

java.lang.Object

org.alfresco.rest.framework.core.ResourceMetadata

public class ResourceMetadata
extends Object

Describes a resource and its properties. Metadata about what functions the resource can perform and what properties it has.

Author:

Gethin James

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceMetadata.RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
ResourceMetadata(String uniqueId, ResourceMetadata.RESOURCE_TYPE type, List<ResourceOperation> operations, Api api, Set<Class<? extends ResourceAction>> apiDeleted, String parentResource)

Method Summary

Methods

Modifier and Type	Method and Description
Api	getApi()
protected Set<Class<? extends ResourceAction>>	getApiDeleted()
Class	getObjectType(org.springframework.http.HttpMethod supportedMethod) Indicates if this resource can support the specified HTTPMethod
List<ResourceOperation>	getOperations()
List<ResourceParameter>	getParameters(org.springframework.http.HttpMethod httpMethod) Gets the parameters for the specified http method.
String	getParentResource()
ResourceMetadata.RESOURCE_TYPE	getType() The type of this resource
String	getUniqueId() URL uniqueId to the resource
boolean	isDeleted(Class<? extends ResourceAction> resourceAction) Indicates if this resource action is no longer supported.
boolean	supports(org.springframework.http.HttpMethod supportedMethod) Indicates if this resource can support the specified HTTPMethod
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceMetadata

public ResourceMetadata(String uniqueId,
                ResourceMetadata.RESOURCE_TYPE type,
                List<ResourceOperation> operations,
                Api api,
                Set<Class<? extends ResourceAction>> apiDeleted,
                String parentResource)

Method Detail

supports

public boolean supports(org.springframework.http.HttpMethod supportedMethod)

Indicates if this resource can support the specified HTTPMethod

Parameters:

supportedMethod -

Returns:

true if can support it

getObjectType

public Class getObjectType(org.springframework.http.HttpMethod supportedMethod)

Indicates if this resource can support the specified HTTPMethod

Parameters:

supportedMethod -

Returns:

true if can support it

isDeleted

public boolean isDeleted(Class<? extends ResourceAction> resourceAction)

Indicates if this resource action is no longer supported.

Parameters:

resourceAction -

Returns:

true if it is no longer supported

getUniqueId

public String getUniqueId()

URL uniqueId to the resource

Returns:

String uniqueId

getType

public ResourceMetadata.RESOURCE_TYPE getType()

The type of this resource

Returns:

RESOURCE_TYPE type

getApi

public Api getApi()

Returns:

the api

toString

public String toString()

Overrides:

toString in class Object

getOperations

public List<ResourceOperation> getOperations()

getApiDeleted

protected Set<Class<? extends ResourceAction>> getApiDeleted()

getParentResource

public String getParentResource()

getParameters

public List<ResourceParameter> getParameters(org.springframework.http.HttpMethod httpMethod)

Gets the parameters for the specified http method. Matches the first operation.

Parameters:

httpMethod -

Returns:

If not found returns an empty list