org.everrest.exoplatform.container

Class RestfulContainer

java.lang.Object

org.exoplatform.container.ConcurrentPicoContainer

org.everrest.exoplatform.container.RestfulContainer

All Implemented Interfaces:

Serializable, javax.ws.rs.ext.Providers, org.picocontainer.Disposable, org.picocontainer.MutablePicoContainer, org.picocontainer.PicoContainer, org.picocontainer.Startable

public class RestfulContainer
extends org.exoplatform.container.ConcurrentPicoContainer
implements javax.ws.rs.ext.Providers

Container intended for decoupling third part code and everrest framework. Components and adapters are searchable by annotation and type or by annotation only. Components (implementation class or instance) annotated with JAX-RS annotations @Path and @Provider should be registered in container as usually. After registration if class annotated with Path it may be retrieved by method getMatchedResource(String, List). If class annotated with Provider and implement one of JAX-RS extension interfaces instance of component may be retrieved by corresponded methods of Providers interface. E.g:

Suppose we have a resource class org.example.MyResource annotated with @Path("my-resource") and base URL is http://example.com/:

 @Path("my-resource")
 public class MyResource
 {
    @GET
    @Path("{id}")
    public String get()
    {
    ...
    }
 }
 

Need register resource in container.

 RestfulContainer container = ...
 container.registerComponentImplementation(MyResource.class);
 

Suppose we have a GET request for http://example.com/my-resource/101. We need to find resource matched to relative path /my-resource/101.

 List<String> paramValues = new ArrayList<String>();
 Object resource = container.getMatchedResource("/my-resource/101", paramValues);
 ...
 

Resource should be the instance of org.example.MyResource.class. Container supports injection JAX-RS runtime information into a class field or constructor parameters with annotation Context.

NOTE Methods registerXXX of this container may throws PicoRegistrationException if component violates the restrictions of framework, e.g. if resource with the same URI pattern or provider with the same purpose already registered in this container.

Author:

andrew00x

See Also:

Context, MessageBodyReader, MessageBodyWriter, ContextResolver, ExceptionMapper, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.exoplatform.container.ConcurrentPicoContainer

org.exoplatform.container.ConcurrentPicoContainer.ContainerVisitor

Constructor Summary

Constructors

Modifier	Constructor and Description
	RestfulContainer()
protected	RestfulContainer(org.picocontainer.defaults.ComponentAdapterFactory factory, org.picocontainer.PicoContainer parent)
protected	RestfulContainer(org.picocontainer.PicoContainer parent)

Method Summary

Modifier and Type	Method and Description
List<org.picocontainer.ComponentAdapter>	getComponentAdapters(Class<? extends Annotation> annotation) Retrieve all the component adapters for types annotated with annotation inside this container.
List<org.picocontainer.ComponentAdapter>	getComponentAdaptersOfType(Class componentType, Class<? extends Annotation> annotation) Retrieve all the component adapters of the specified type and annotated with annotation inside this container.
List<Object>	getComponents(Class<? extends Annotation> annotation) Retrieve all the component instances annotated with annotation.
<T> List<T>	getComponentsOfType(Class<T> componentType, Class<? extends Annotation> annotation) Retrieve all the component instances of the specified type and annotated with annotation.
<T> javax.ws.rs.ext.ContextResolver<T>	getContextResolver(Class<T> contextType, javax.ws.rs.core.MediaType mediaType)
<T extends Throwable> javax.ws.rs.ext.ExceptionMapper<T>	getExceptionMapper(Class<T> type)
org.picocontainer.ComponentAdapter	getMatchedResource(String requestPath, List<String> parameterValues) Get ComponentAdapter root resource matched to requestPath.
<T> javax.ws.rs.ext.MessageBodyReader<T>	getMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
<T> javax.ws.rs.ext.MessageBodyWriter<T>	getMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType)
org.picocontainer.ComponentAdapter	registerComponent(org.picocontainer.ComponentAdapter componentAdapter)
org.picocontainer.ComponentAdapter	registerComponentInstance(Object componentKey, Object componentInstance)
org.picocontainer.ComponentAdapter	unregisterComponent(Object componentKey)

Methods inherited from class org.exoplatform.container.ConcurrentPicoContainer

accept, accept, addChildContainer, addComponentToCtx, canBeDisposed, canBeStarted, canBeStopped, dispose, getComponentAdapter, getComponentAdapterOfType, getComponentAdapters, getComponentAdaptersOfType, getComponentInstance, getComponentInstanceOfType, getComponentInstances, getComponentInstancesOfType, getParent, makeChildContainer, registerComponentImplementation, registerComponentImplementation, registerComponentImplementation, registerComponentImplementation, registerComponentInstance, removeChildContainer, removeComponentFromCtx, start, stop, unregisterComponentByInstance, verify

Methods inherited from class java.lang.Object

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

Constructor Detail

RestfulContainer

public RestfulContainer()

RestfulContainer

protected RestfulContainer(org.picocontainer.PicoContainer parent)

RestfulContainer

protected RestfulContainer(org.picocontainer.defaults.ComponentAdapterFactory factory,
                           org.picocontainer.PicoContainer parent)

Method Detail

registerComponent

public org.picocontainer.ComponentAdapter registerComponent(org.picocontainer.ComponentAdapter componentAdapter)
                                                     throws org.picocontainer.defaults.DuplicateComponentKeyRegistrationException

Specified by:

registerComponent in interface org.picocontainer.MutablePicoContainer

Overrides:

registerComponent in class org.exoplatform.container.ConcurrentPicoContainer

Throws:

org.picocontainer.defaults.DuplicateComponentKeyRegistrationException

registerComponentInstance

public org.picocontainer.ComponentAdapter registerComponentInstance(Object componentKey,
                                                                    Object componentInstance)
                                                             throws org.picocontainer.PicoRegistrationException

Specified by:

registerComponentInstance in interface org.picocontainer.MutablePicoContainer

Overrides:

registerComponentInstance in class org.exoplatform.container.ConcurrentPicoContainer

Throws:

org.picocontainer.PicoRegistrationException

unregisterComponent

public org.picocontainer.ComponentAdapter unregisterComponent(Object componentKey)

Specified by:

unregisterComponent in interface org.picocontainer.MutablePicoContainer

Overrides:

unregisterComponent in class org.exoplatform.container.ConcurrentPicoContainer

getComponentAdapters

public List<org.picocontainer.ComponentAdapter> getComponentAdapters(Class<? extends Annotation> annotation)

Retrieve all the component adapters for types annotated with annotation inside this container. The component adapters from the parent container are not returned.

Parameters:

annotation - the annotation type

Returns:

a collection containing all the ComponentAdapters for types annotated with annotation inside this container.

getComponentAdaptersOfType

public List<org.picocontainer.ComponentAdapter> getComponentAdaptersOfType(Class componentType,
                                                                           Class<? extends Annotation> annotation)

Retrieve all the component adapters of the specified type and annotated with annotation inside this container. The component adapters from the parent container are not returned.

Parameters:

componentType - the type of component

annotation - the annotation type

Returns:

a collection containing all the ComponentAdapters of the specified type and annotated with annotation inside this container.

getComponentsOfType

public <T> List<T> getComponentsOfType(Class<T> componentType,
                                       Class<? extends Annotation> annotation)

Retrieve all the component instances of the specified type and annotated with annotation.

Parameters:

componentType - the type of component

annotation - the annotation type

Returns:

a collection of components

getComponents

public List<Object> getComponents(Class<? extends Annotation> annotation)

Retrieve all the component instances annotated with annotation.

Parameters:

annotation - the annotation type

Returns:

a collection of components

getMatchedResource

public final org.picocontainer.ComponentAdapter getMatchedResource(String requestPath,
                                                                   List<String> parameterValues)

Get ComponentAdapter root resource matched to requestPath.

Parameters:

requestPath - request path

parameterValues - list for placing values of URI templates

Returns:

root resource matched to requestPath or null

getMessageBodyReader

public final <T> javax.ws.rs.ext.MessageBodyReader<T> getMessageBodyReader(Class<T> type,
                                                                           Type genericType,
                                                                           Annotation[] annotations,
                                                                           javax.ws.rs.core.MediaType mediaType)

Specified by:

getMessageBodyReader in interface javax.ws.rs.ext.Providers

getMessageBodyWriter

public final <T> javax.ws.rs.ext.MessageBodyWriter<T> getMessageBodyWriter(Class<T> type,
                                                                           Type genericType,
                                                                           Annotation[] annotations,
                                                                           javax.ws.rs.core.MediaType mediaType)

Specified by:

getMessageBodyWriter in interface javax.ws.rs.ext.Providers

getExceptionMapper

public final <T extends Throwable> javax.ws.rs.ext.ExceptionMapper<T> getExceptionMapper(Class<T> type)

Specified by:

getExceptionMapper in interface javax.ws.rs.ext.Providers

getContextResolver

public final <T> javax.ws.rs.ext.ContextResolver<T> getContextResolver(Class<T> contextType,
                                                                       javax.ws.rs.core.MediaType mediaType)

Specified by:

getContextResolver in interface javax.ws.rs.ext.Providers