org.everrest.core.impl

Class ProviderBinder

java.lang.Object

org.everrest.core.impl.ProviderBinder

All Implemented Interfaces:

javax.ws.rs.ext.Providers

Direct Known Subclasses:

ApplicationProviderBinder

public class ProviderBinder
extends Object
implements javax.ws.rs.ext.Providers

Gives access to common predefined provider. Users of EverRest are not expected to use this class or any of its subclasses.

Author:

andrew00x

See Also:

Providers, Provider, MessageBodyReader, MessageBodyWriter, ContextResolver, ExceptionMapper, Filter, RequestFilter, ResponseFilter, MethodInvokerFilter

Field Summary

Fields

Modifier and Type	Field and Description
protected ConcurrentMap<Class<?>,MediaTypeMap<ObjectFactory<ProviderDescriptor>>>	contextResolvers Context resolvers.
protected ConcurrentMap<Class<? extends Throwable>,ObjectFactory<ProviderDescriptor>>	exceptionMappers Exception mappers, see ExceptionMapper.
protected UriPatternMap<ObjectFactory<FilterDescriptor>>	invokerFilters Method invoking filters.
protected ResourceDescriptorVisitor	rdv Validator.
protected MediaTypeMultivaluedMap<ObjectFactory<ProviderDescriptor>>	readProviders Read message body providers.
protected UriPatternMap<ObjectFactory<FilterDescriptor>>	requestFilters Request filters, see RequestFilter.
protected UriPatternMap<ObjectFactory<FilterDescriptor>>	responseFilters Response filters, see ResponseFilter.
protected MediaTypeMultivaluedMap<ObjectFactory<ProviderDescriptor>>	writeProviders Read message body providers.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProviderBinder()

Method Summary

Modifier and Type	Method and Description
void	addContextResolver(Class<? extends javax.ws.rs.ext.ContextResolver> clazz) Add per-request ContextResolver.
void	addContextResolver(javax.ws.rs.ext.ContextResolver instance) Add singleton ContextResolver.
void	addContextResolver(ObjectFactory<ProviderDescriptor> contextResolverFactory)
void	addExceptionMapper(Class<? extends javax.ws.rs.ext.ExceptionMapper> clazz) Add per-request ExceptionMapper.
void	addExceptionMapper(javax.ws.rs.ext.ExceptionMapper instance) Add singleton ExceptionMapper.
void	addExceptionMapper(ObjectFactory<ProviderDescriptor> exceptionMapperFactory)
void	addMessageBodyReader(Class<? extends javax.ws.rs.ext.MessageBodyReader> clazz) Add per-request MessageBodyReader.
void	addMessageBodyReader(javax.ws.rs.ext.MessageBodyReader instance) Add singleton MessageBodyReader.
void	addMessageBodyReader(ObjectFactory<ProviderDescriptor> readerFactory)
void	addMessageBodyWriter(Class<? extends javax.ws.rs.ext.MessageBodyWriter> clazz) Add per-request MessageBodyWriter.
void	addMessageBodyWriter(javax.ws.rs.ext.MessageBodyWriter instance) Add singleton MessageBodyWriter.
void	addMessageBodyWriter(ObjectFactory<ProviderDescriptor> writerFactory)
void	addMethodInvokerFilter(Class<? extends MethodInvokerFilter> clazz) Add per-request MethodInvokerFilter.
void	addMethodInvokerFilter(MethodInvokerFilter instance) Add singleton MethodInvokerFilter.
void	addMethodInvokerFilter(ObjectFactory<FilterDescriptor> filterFactory)
void	addRequestFilter(Class<? extends RequestFilter> clazz) Add per-request RequestFilter.
void	addRequestFilter(ObjectFactory<FilterDescriptor> filterFactory)
void	addRequestFilter(RequestFilter instance) Add singleton RequestFilter.
void	addResponseFilter(Class<? extends ResponseFilter> clazz) Add per-request ResponseFilter.
void	addResponseFilter(ObjectFactory<FilterDescriptor> filterFactory)
void	addResponseFilter(ResponseFilter instance) Add singleton ResponseFilter.
protected List<javax.ws.rs.core.MediaType>	doGetAcceptableWriterMediaTypes(Class<?> type, Type genericType, Annotation[] annotations)
protected <T> javax.ws.rs.ext.ContextResolver<T>	doGetContextResolver(Class<T> contextType, javax.ws.rs.core.MediaType mediaType)
protected <T extends Throwable> javax.ws.rs.ext.ExceptionMapper<T>	doGetExceptionMapper(Class<T> type)
protected List<ObjectFactory<FilterDescriptor>>	doGetMatchedFilters(String path, UriPatternMap<ObjectFactory<FilterDescriptor>> m)
protected <T> javax.ws.rs.ext.MessageBodyReader<T>	doGetMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Looking for message body reader according to supplied entity class, entity generic type, annotations and content type.
protected <T> javax.ws.rs.ext.MessageBodyWriter<T>	doGetMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType) Looking for message body writer according to supplied entity class, entity generic type, annotations and content type.
List<javax.ws.rs.core.MediaType>	getAcceptableWriterMediaTypes(Class<?> type, Type genericType, Annotation[] annotations) Get list of most acceptable writer's media type for specified type.
<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)
static ProviderBinder	getInstance()
<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)
List<ObjectFactory<FilterDescriptor>>	getMethodInvokerFilters(String path)
List<ObjectFactory<FilterDescriptor>>	getRequestFilters(String path)
List<ObjectFactory<FilterDescriptor>>	getResponseFilters(String path)
protected void	init() Add prepared providers.
static void	setInstance(ProviderBinder inst) Replace default set of providers by new one.

Methods inherited from class java.lang.Object

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

Field Detail

writeProviders

protected final MediaTypeMultivaluedMap<ObjectFactory<ProviderDescriptor>> writeProviders

Read message body providers. Also see MediaTypeMultivaluedMap.

readProviders

protected final MediaTypeMultivaluedMap<ObjectFactory<ProviderDescriptor>> readProviders

Read message body providers. Also see MediaTypeMultivaluedMap.

exceptionMappers

protected final ConcurrentMap<Class<? extends Throwable>,ObjectFactory<ProviderDescriptor>> exceptionMappers

Exception mappers, see ExceptionMapper.

contextResolvers

protected final ConcurrentMap<Class<?>,MediaTypeMap<ObjectFactory<ProviderDescriptor>>> contextResolvers

Context resolvers.

requestFilters

protected final UriPatternMap<ObjectFactory<FilterDescriptor>> requestFilters

Request filters, see RequestFilter.

responseFilters

protected final UriPatternMap<ObjectFactory<FilterDescriptor>> responseFilters

Response filters, see ResponseFilter.

invokerFilters

protected final UriPatternMap<ObjectFactory<FilterDescriptor>> invokerFilters

Method invoking filters.

rdv

protected final ResourceDescriptorVisitor rdv

Validator.

Constructor Detail

ProviderBinder

protected ProviderBinder()

Method Detail

getInstance

public static ProviderBinder getInstance()

Returns:

instance of ProviderBinder

setInstance

public static void setInstance(ProviderBinder inst)

Replace default set of providers by new one. This must not be used by regular users of EverRest framework.

Parameters:

inst - instance of ProviderBinder

Throws:

SecurityException - if caller is not permitted to call this method because to current security policy

addContextResolver

public void addContextResolver(Class<? extends javax.ws.rs.ext.ContextResolver> clazz)

Add per-request ContextResolver.

Parameters:

clazz - class of implementation ContextResolver

addContextResolver

public void addContextResolver(javax.ws.rs.ext.ContextResolver instance)

Add singleton ContextResolver.

Parameters:

instance - ContextResolver instance

addExceptionMapper

public void addExceptionMapper(Class<? extends javax.ws.rs.ext.ExceptionMapper> clazz)

Add per-request ExceptionMapper.

Parameters:

clazz - class of implementation ExceptionMapper

addExceptionMapper

public void addExceptionMapper(javax.ws.rs.ext.ExceptionMapper instance)

Add singleton ExceptionMapper.

Parameters:

instance - ExceptionMapper instance

addMessageBodyReader

public void addMessageBodyReader(Class<? extends javax.ws.rs.ext.MessageBodyReader> clazz)

Add per-request MessageBodyReader.

Parameters:

clazz - class of implementation MessageBodyReader

addMessageBodyReader

public void addMessageBodyReader(javax.ws.rs.ext.MessageBodyReader instance)

Add singleton MessageBodyReader.

Parameters:

instance - MessageBodyReader instance

addMessageBodyWriter

public void addMessageBodyWriter(Class<? extends javax.ws.rs.ext.MessageBodyWriter> clazz)

Add per-request MessageBodyWriter.

Parameters:

clazz - class of implementation MessageBodyWriter

addMessageBodyWriter

public void addMessageBodyWriter(javax.ws.rs.ext.MessageBodyWriter instance)

Add singleton MessageBodyWriter.

Parameters:

instance - MessageBodyWriter instance

addMethodInvokerFilter

public void addMethodInvokerFilter(Class<? extends MethodInvokerFilter> clazz)

Add per-request MethodInvokerFilter.

Parameters:

clazz - class of implementation MethodInvokerFilter

addMethodInvokerFilter

public void addMethodInvokerFilter(MethodInvokerFilter instance)

Add singleton MethodInvokerFilter.

Parameters:

instance - MethodInvokerFilter instance

addRequestFilter

public void addRequestFilter(Class<? extends RequestFilter> clazz)

Add per-request RequestFilter.

Parameters:

clazz - class of implementation RequestFilter

addRequestFilter

public void addRequestFilter(RequestFilter instance)

Add singleton RequestFilter.

Parameters:

instance - RequestFilter instance

addResponseFilter

public void addResponseFilter(Class<? extends ResponseFilter> clazz)

Add per-request ResponseFilter.

Parameters:

clazz - class of implementation ResponseFilter

addResponseFilter

public void addResponseFilter(ResponseFilter instance)

Add singleton ResponseFilter.

Parameters:

instance - ResponseFilter instance

getAcceptableWriterMediaTypes

public List<javax.ws.rs.core.MediaType> getAcceptableWriterMediaTypes(Class<?> type,
                                                                      Type genericType,
                                                                      Annotation[] annotations)

Get list of most acceptable writer's media type for specified type.

Parameters:

type - type

genericType - generic type

annotations - annotations

Returns:

sorted acceptable media type collection

See Also:

MediaTypeHelper.MEDIA_TYPE_COMPARATOR

getContextResolver

public <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

getExceptionMapper

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

Specified by:

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

getMessageBodyReader

public <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 <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

getMethodInvokerFilters

public List<ObjectFactory<FilterDescriptor>> getMethodInvokerFilters(String path)

Parameters:

path - request path

Returns:

acceptable method invocation filters

getRequestFilters

public List<ObjectFactory<FilterDescriptor>> getRequestFilters(String path)

Parameters:

path - request path

Returns:

acceptable request filters

getResponseFilters

public List<ObjectFactory<FilterDescriptor>> getResponseFilters(String path)

Parameters:

path - request path

Returns:

acceptable response filters

addContextResolver

public void addContextResolver(ObjectFactory<ProviderDescriptor> contextResolverFactory)

addExceptionMapper

public void addExceptionMapper(ObjectFactory<ProviderDescriptor> exceptionMapperFactory)

addMessageBodyReader

public void addMessageBodyReader(ObjectFactory<ProviderDescriptor> readerFactory)

addMessageBodyWriter

public void addMessageBodyWriter(ObjectFactory<ProviderDescriptor> writerFactory)

addMethodInvokerFilter

public void addMethodInvokerFilter(ObjectFactory<FilterDescriptor> filterFactory)

addRequestFilter

public void addRequestFilter(ObjectFactory<FilterDescriptor> filterFactory)

addResponseFilter

public void addResponseFilter(ObjectFactory<FilterDescriptor> filterFactory)

doGetAcceptableWriterMediaTypes

protected List<javax.ws.rs.core.MediaType> doGetAcceptableWriterMediaTypes(Class<?> type,
                                                                           Type genericType,
                                                                           Annotation[] annotations)

doGetContextResolver

protected <T> javax.ws.rs.ext.ContextResolver<T> doGetContextResolver(Class<T> contextType,
                                                                      javax.ws.rs.core.MediaType mediaType)

doGetExceptionMapper

protected <T extends Throwable> javax.ws.rs.ext.ExceptionMapper<T> doGetExceptionMapper(Class<T> type)

doGetMessageBodyReader

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

Looking for message body reader according to supplied entity class, entity generic type, annotations and content type.

Type Parameters:

T - message body reader actual type argument

Parameters:

type - entity type

genericType - entity generic type

annotations - annotations

mediaType - entity content type

Returns:

message body reader or null if no one was found.

doGetMessageBodyWriter

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

Looking for message body writer according to supplied entity class, entity generic type, annotations and content type.

Type Parameters:

T - message body writer actual type argument

Parameters:

type - entity type

genericType - entity generic type

annotations - annotations

mediaType - content type in which entity should be represented

Returns:

message body writer or null if no one was found.

doGetMatchedFilters

protected List<ObjectFactory<FilterDescriptor>> doGetMatchedFilters(String path,
                                                                    UriPatternMap<ObjectFactory<FilterDescriptor>> m)

Parameters:

path - request path

m - filter map

Returns:

acceptable filter

See Also:

getMethodInvokerFilters(String), getRequestFilters(String), getResponseFilters(String)

init

protected void init()

Add prepared providers.