Package org.alfresco.rest.framework.core

Class ResourceMetadata

java.lang.Object

org.alfresco.rest.framework.core.ResourceMetadata

Direct Known Subclasses:

OperationResourceMetaData

public class ResourceMetadata
extends java.lang.Object

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

Author:

Gethin James, janv

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceMetadata.RESOURCE_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Api	getApi()
protected java.util.Set<java.lang.Class<? extends ResourceAction>>	getApiDeleted()
java.lang.Class	getObjectType(ResourceOperation operation)	Gets the data type of the resource parameter
ResourceOperation	getOperation(org.springframework.http.HttpMethod supportedMethod)	Gets the operation for the specified HTTPMethod
java.util.List<ResourceOperation>	getOperations()
java.lang.String	getParentResource()
ResourceMetadata.RESOURCE_TYPE	getType()	The type of this resource
java.lang.String	getUniqueId()	URL uniqueId to the resource
boolean	isDeleted(java.lang.Class<? extends ResourceAction> resourceAction)	Indicates if this resource action is no longer supported.
boolean	isNoAuth(java.lang.Class<? extends ResourceAction> resourceAction)	Indicates if this resource action supports unauthenticated access.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceMetadata

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

Method Detail

getOperation

public ResourceOperation getOperation(org.springframework.http.HttpMethod supportedMethod)

Gets the operation for the specified HTTPMethod

Parameters:

supportedMethod - HttpMethod

Returns:

null if the operation is not supported

getObjectType

public java.lang.Class getObjectType(ResourceOperation operation)

Gets the data type of the resource parameter

Parameters:

operation - ResourceOperation object

Returns:

The data type of the resource parameter

isDeleted

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

Indicates if this resource action is no longer supported.

Returns:

true if it is no longer supported

isNoAuth

public boolean isNoAuth(java.lang.Class<? extends ResourceAction> resourceAction)

Indicates if this resource action supports unauthenticated access.

Parameters:

resourceAction -

Returns:

getUniqueId

public java.lang.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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOperations

public java.util.List<ResourceOperation> getOperations()

getApiDeleted

protected java.util.Set<java.lang.Class<? extends ResourceAction>> getApiDeleted()

getParentResource

public java.lang.String getParentResource()