org.everrest.core.impl

Class ResourceBinderImpl

java.lang.Object

org.everrest.core.impl.ResourceBinderImpl

All Implemented Interfaces:

ResourceBinder

public class ResourceBinderImpl
extends Object
implements ResourceBinder

Author:

andrew00x

Field Summary

Fields

Modifier and Type	Field and Description
protected static Comparator<ObjectFactory<AbstractResourceDescriptor>>	RESOURCE_COMPARATOR Resource's comparator.

Constructor Summary

Constructors

Constructor and Description
ResourceBinderImpl()

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.
void	clear() Clear the list of resources.
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.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_COMPARATOR

protected static final Comparator<ObjectFactory<AbstractResourceDescriptor>> RESOURCE_COMPARATOR

Resource's comparator.

Constructor Detail

ResourceBinderImpl

public ResourceBinderImpl()

Method Detail

addResource

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

Description copied from interface: ResourceBinder

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.

Specified by:

addResource in interface ResourceBinder

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

See Also:

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

addResource

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

Description copied from interface: ResourceBinder

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.

Specified by:

addResource in interface ResourceBinder

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

See Also:

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

addResource

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

Description copied from interface: ResourceBinder

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

Specified by:

addResource in interface ResourceBinder

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

See Also:

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

addResource

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

Description copied from interface: ResourceBinder

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.

Specified by:

addResource in interface ResourceBinder

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

See Also:

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

addResource

public void addResource(ObjectFactory<AbstractResourceDescriptor> resourceFactory)

Description copied from interface: ResourceBinder

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

Specified by:

addResource in interface ResourceBinder

Parameters:

resourceFactory - root resource

clear

public void clear()

Clear the list of resources.

getMatchedResource

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

Get root resource matched to requestPath.

Specified by:

getMatchedResource in interface ResourceBinder

Parameters:

requestPath - request path

parameterValues - see ApplicationContext.getParameterValues()

Returns:

root resource matched to requestPath or null

getResources

public List<ObjectFactory<AbstractResourceDescriptor>> getResources()

Description copied from interface: ResourceBinder

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.

Specified by:

getResources in interface ResourceBinder

Returns:

all registered root resources

getSize

public int getSize()

Specified by:

getSize in interface ResourceBinder

Returns:

number of bound resources

removeResource

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

Description copied from interface: ResourceBinder

Remove root resource of supplied class from root resource collection.

Specified by:

removeResource in interface ResourceBinder

Parameters:

clazz - root resource class

Returns:

removed resource or null if resource of specified class not found

removeResource

public ObjectFactory<AbstractResourceDescriptor> removeResource(String path)

Description copied from interface: ResourceBinder

Remove root resource with specified UriTemplate from root resource collection.

Specified by:

removeResource in interface ResourceBinder

Parameters:

path - root resource path

Returns:

removed resource or null if resource for specified template not found