org.exoplatform.services.rest.container
Interface ResourceDescriptor

All Known Implementing Classes:

HTTPAnnotatedContainerResolvingStrategy.HTTPResourceDescriptor

public interface ResourceDescriptor

Created by The eXo Platform SAS.
Abstraction of resource description.

Version:

$Id: $

Author:

Gennady Azarenkov

Method Summary

String	getAcceptableMethod() HTTP method for serving by ResourceContainer.
String	getConsumedMimeTypes() Describe mimetype(s) which RessourceContainer can consume.
Class<? extends InputEntityTransformer>	getInputTransformerType() Return Class of InputEntityTransformer.
Annotation[]	getMethodParameterAnnotations() Return the array of annotation for method parameters.
Class<?>[]	getMethodParameters() Return the array of types method parameters.
Class<? extends OutputEntityTransformer>	getOutputTransformerType() Return Class of OutputEntityTransformer.
String	getProducedMimeTypes() Describe mimetype(s) which RessourceContainer can produce.
MultivaluedMetadata	getQueryPattern()
ResourceContainer	getResourceContainer() Object of ResourecContainer.
Method	getServer() Method of ResourceContainer object.
URIPattern	getURIPattern() Return URIPattern object.

Method Detail

getAcceptableMethod

String getAcceptableMethod()

HTTP method for serving by ResourceContainer.

Returns:

HTTP method name.

getConsumedMimeTypes

String getConsumedMimeTypes()

Describe mimetype(s) which RessourceContainer can consume.

Returns:

mimetype(s).

getProducedMimeTypes

String getProducedMimeTypes()

Describe mimetype(s) which RessourceContainer can produce.

Returns:

mimetype(s).

getQueryPattern

MultivaluedMetadata getQueryPattern()

Returns:

MultivaluedMetadata.

getResourceContainer

ResourceContainer getResourceContainer()

Object of ResourecContainer.

Returns:

ResourceContainer.

getServer

Method getServer()

Method of ResourceContainer object. Then this method may be called by ResourceDispatcher.

Returns:

Method.

getURIPattern

URIPattern getURIPattern()

Return URIPattern object.

Returns:

URIPattern.

getMethodParameterAnnotations

Annotation[] getMethodParameterAnnotations()

Return the array of annotation for method parameters.

Returns:

method parameter annotations.

getMethodParameters

Class<?>[] getMethodParameters()

Return the array of types method parameters.

Returns:

method parameters types.

getOutputTransformerType

Class<? extends OutputEntityTransformer> getOutputTransformerType()

Return Class of OutputEntityTransformer. ResourceDispatcher uses this class for creation instance of OutputEntityTransformer.

Returns:

Class of OutputEntityTransformer.

getInputTransformerType

Class<? extends InputEntityTransformer> getInputTransformerType()

Return Class of InputEntityTransformer. ResourceDispatcher uses this class for creation instance of InputEntityTransformer.

Returns:

Class of InputEntityTransformer.