org.everrest.core

Interface ResourceBinder

All Known Implementing Classes:

ResourceBinderImpl

public interface ResourceBinder

Manages root resources.

Author:

andrew00x

Method Summary

Modifier and Type	Method and Description
void	addResource(Class<?> resourceClass, javax.ws.rs.core.MultivaluedMap<String,String> properties) Register supplied class as per-request root resource if it has valid JAX-RS annotations and no one resource with the same UriPattern already registered.
void	addResource(ObjectFactory<AbstractResourceDescriptor> resourceFactory) Register supplied root resource if no one resource with the same UriPattern already registered.
void	addResource(Object resource, javax.ws.rs.core.MultivaluedMap<String,String> properties) Register supplied Object as singleton root resource if it has valid JAX-RS annotations and no one resource with the same UriPattern already registered.
void	addResource(String uriPattern, Class<?> resourceClass, javax.ws.rs.core.MultivaluedMap<String,String> properties) Register supplied class as per-request root resource if it has valid JAX-RS annotations and no one resource with the same uriPattern already registered.
void	addResource(String uriPattern, Object resource, javax.ws.rs.core.MultivaluedMap<String,String> properties) Register supplied object as singleton root resource if it has valid JAX-RS annotations and no one resource with the same uriPattern already registered.
ObjectFactory<AbstractResourceDescriptor>	getMatchedResource(String requestPath, List<String> parameterValues) Get root resource matched to requestPath.
List<ObjectFactory<AbstractResourceDescriptor>>	getResources() Get list of all registered root resources.
int	getSize()
ObjectFactory<AbstractResourceDescriptor>	removeResource(Class<?> clazz) Remove root resource of supplied class from root resource collection.
ObjectFactory<AbstractResourceDescriptor>	removeResource(String path) Remove root resource with specified UriTemplate from root resource collection.

Method Detail

getResources

List<ObjectFactory<AbstractResourceDescriptor>> getResources()

Get list of all registered root resources. Returned list is the copy of original list. Any changes in this list does not impact to original list.

Returns:

all registered root resources

getSize

int getSize()

Returns:

number of bound resources

addResource

void addResource(Class<?> resourceClass,
                 javax.ws.rs.core.MultivaluedMap<String,String> properties)

Register supplied class as per-request root resource if it has valid JAX-RS annotations and no one resource with the same UriPattern already registered.

Parameters:

resourceClass - class of candidate to be root resource

properties - optional resource properties. It may contains additional info about resource, e.g. description of resource, its responsibility, etc. This info can be retrieved ObjectModel.getProperties(). This parameter may be null

Throws:

ResourcePublicationException - if resource can't be published because to:

• @javax.ws.rs.Path annotation is missing
• resource has not any method with JAX-RS annotations
• JAX-RS annotations are ambiguous or invalid
• resource with the sane UriPattern already registered

See Also:

ObjectModel.getProperties(), ObjectModel.getProperty(String)

addResource

void addResource(String uriPattern,
                 Class<?> resourceClass,
                 javax.ws.rs.core.MultivaluedMap<String,String> properties)

Register supplied class as per-request root resource if it has valid JAX-RS annotations and no one resource with the same uriPattern already registered. Resource class doesn't need to be annotated with @Path annotation (but may be). Anyway uriPattern parameter overwrites value of @Path annotation.

Parameters:

uriPattern - class of candidate to be root resource

resourceClass - class of candidate to be root resource

properties - optional resource properties. It may contains additional info about resource, e.g. description of resource, its responsibility, etc. This info can be retrieved ObjectModel.getProperties(). This parameter may be null

Throws:

ResourcePublicationException - if resource can't be published because to:

• uriPattern is null or empty
• resource has not any method with JAX-RS annotations
• JAX-RS annotations are ambiguous or invalid
• resource with the sane UriPattern already registered

See Also:

ObjectModel.getProperties(), ObjectModel.getProperty(String)

addResource

void addResource(Object resource,
                 javax.ws.rs.core.MultivaluedMap<String,String> properties)

Register supplied Object as singleton root resource if it has valid JAX-RS annotations and no one resource with the same UriPattern already registered.

Parameters:

resource - candidate to be root resource

properties - optional resource properties. It may contains additional info about resource, e.g. description of resource, its responsibility, etc. This info can be retrieved ObjectModel.getProperties(). This parameter may be null

Throws:

ResourcePublicationException - if resource can't be published because to:

• @javax.ws.rs.Path annotation is missing
• resource has not any method with JAX-RS annotations
• JAX-RS annotations are ambiguous or invalid
• resource with the sane UriPattern already registered

See Also:

ObjectModel.getProperties(), ObjectModel.getProperty(String)

addResource

void addResource(String uriPattern,
                 Object resource,
                 javax.ws.rs.core.MultivaluedMap<String,String> properties)

Register supplied object as singleton root resource if it has valid JAX-RS annotations and no one resource with the same uriPattern already registered. Resource class doesn't need to be annotated with @Path annotation (but may be). Anyway uriPattern parameter overwrite value of @Path annotation.

Parameters:

resource - candidate to be root resource

properties - optional resource properties. It may contains additional info about resource, e.g. description of resource, its responsibility, etc. This info can be retrieved ObjectModel.getProperties(). This parameter may be null

Throws:

ResourcePublicationException - if resource can't be published because to:

• uriPattern is null or empty
• resource has not any method with JAX-RS annotations
• JAX-RS annotations are ambiguous or invalid
• resource with the sane UriPattern already registered

See Also:

ObjectModel.getProperties(), ObjectModel.getProperty(String)

addResource

void addResource(ObjectFactory<AbstractResourceDescriptor> resourceFactory)

Register supplied root resource if no one resource with the same UriPattern already registered.

Parameters:

resourceFactory - root resource

Throws:

ResourcePublicationException - if resource can't be published because resource with the sane UriPattern already registered

getMatchedResource

ObjectFactory<AbstractResourceDescriptor> getMatchedResource(String requestPath,
                                                             List<String> parameterValues)

Get root resource matched to requestPath.

Parameters:

requestPath - request path

parameterValues - see ApplicationContext.getParameterValues()

Returns:

root resource matched to requestPath or null

removeResource

ObjectFactory<AbstractResourceDescriptor> removeResource(Class<?> clazz)

Remove root resource of supplied class from root resource collection.

Parameters:

clazz - root resource class

Returns:

removed resource or null if resource of specified class not found

removeResource

ObjectFactory<AbstractResourceDescriptor> removeResource(String path)

Remove root resource with specified UriTemplate from root resource collection.

Parameters:

path - root resource path

Returns:

removed resource or null if resource for specified template not found