org.glassfish.jersey.message.internal
Class ReaderInterceptorExecutor

java.lang.Object
  org.glassfish.jersey.message.internal.ReaderInterceptorExecutor

All Implemented Interfaces:

javax.ws.rs.ext.InterceptorContext, javax.ws.rs.ext.ReaderInterceptorContext, ServiceLocatorSupplier, PropertiesDelegate

public final class ReaderInterceptorExecutor
extends Object
implements javax.ws.rs.ext.ReaderInterceptorContext, ServiceLocatorSupplier

Represents reader interceptor chain executor for both client and server side. It constructs wrapped interceptor chain and invokes it. At the end of the chain a message body reader execution interceptor is inserted, which finally reads an entity from the output stream provided by the chain.

Author:

Miroslav Fuksa (miroslav.fuksa at oracle.com), Jakub Podlesak (jakub.podlesak at oracle.com)

Constructor Summary

ReaderInterceptorExecutor(Class<?> rawType, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,String> headers, PropertiesDelegate propertiesDelegate, InputStream inputStream, MessageBodyWorkers workers, Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors, boolean translateNce, org.glassfish.hk2.api.ServiceLocator serviceLocator)
Constructs a new executor to read given type from provided entityStream.

Method Summary

protected void	clearLastTracedInterceptor() Clear last traced interceptor information.
Annotation[]	getAnnotations()
Type	getGenericType()
javax.ws.rs.core.MultivaluedMap<String,String>	getHeaders()
InputStream	getInputStream()
javax.ws.rs.core.MediaType	getMediaType()
Object	getProperty(String name) Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.
Collection<String>	getPropertyNames() Returns an immutable collection containing the property names available within the context of the current request/response exchange context.
org.glassfish.hk2.api.ServiceLocator	getServiceLocator() Get service locator.
protected TracingLogger	getTracingLogger() Get tracing logger instance configured in via properties.
Class	getType()
Object	proceed() Starts the interceptor chain execution.
void	removeProperty(String name) Removes a property with the given name from the current request/response exchange context.
void	setAnnotations(Annotation[] annotations)
void	setGenericType(Type genericType)
void	setInputStream(InputStream is)
void	setMediaType(javax.ws.rs.core.MediaType mediaType)
void	setProperty(String name, Object object) Binds an object to a given property name in the current request/response exchange context.
void	setType(Class type)
protected void	traceAfter(T interceptor, TracingLogger.Event event) Tracing support - log invocation of interceptor AFTER context.proceed() call.
protected void	traceBefore(T interceptor, TracingLogger.Event event) Tracing support - log invocation of interceptor BEFORE context.proceed() call.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.ws.rs.ext.InterceptorContext

getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getType, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType

Constructor Detail

ReaderInterceptorExecutor

public ReaderInterceptorExecutor(Class<?> rawType,
                                 Type type,
                                 Annotation[] annotations,
                                 javax.ws.rs.core.MediaType mediaType,
                                 javax.ws.rs.core.MultivaluedMap<String,String> headers,
                                 PropertiesDelegate propertiesDelegate,
                                 InputStream inputStream,
                                 MessageBodyWorkers workers,
                                 Iterable<javax.ws.rs.ext.ReaderInterceptor> readerInterceptors,
                                 boolean translateNce,
                                 org.glassfish.hk2.api.ServiceLocator serviceLocator)

Constructs a new executor to read given type from provided entityStream.

Parameters:

rawType - raw Java entity type.

type - generic Java entity type.

annotations - array of annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Method.getParameterAnnotations.

mediaType - media type of the HTTP entity.

headers - mutable message headers.

propertiesDelegate - request-scoped properties delegate.

inputStream - entity input stream.

workers - Message body workers.

readerInterceptors - Reader interceptor that are to be used to intercept the reading of an entity. The interceptors will be executed in the same order as given in this parameter.

translateNce - if true, the NoContentException thrown by a selected message body reader will be translated into a BadRequestException as required by

serviceLocator - Service locator.

Method Detail

proceed

public Object proceed()
               throws IOException

Starts the interceptor chain execution.

Specified by:

proceed in interface javax.ws.rs.ext.ReaderInterceptorContext

Returns:

an entity read from the stream.

Throws:

IOException

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface javax.ws.rs.ext.ReaderInterceptorContext

setInputStream

public void setInputStream(InputStream is)

Specified by:

setInputStream in interface javax.ws.rs.ext.ReaderInterceptorContext

getHeaders

public javax.ws.rs.core.MultivaluedMap<String,String> getHeaders()

Specified by:

getHeaders in interface javax.ws.rs.ext.ReaderInterceptorContext

getServiceLocator

public org.glassfish.hk2.api.ServiceLocator getServiceLocator()

Description copied from interface: ServiceLocatorSupplier

Get service locator.

Specified by:

getServiceLocator in interface ServiceLocatorSupplier

Returns:

Service locator;

getProperty

public Object getProperty(String name)

Description copied from interface: PropertiesDelegate

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

Specified by:

getProperty in interface javax.ws.rs.ext.InterceptorContext

Specified by:

getProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

Returns:

an Object containing the value of the property, or null if no property exists matching the given name.

See Also:

PropertiesDelegate.getPropertyNames()

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: PropertiesDelegate

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

Use the PropertiesDelegate.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

getPropertyNames in interface javax.ws.rs.ext.InterceptorContext

Specified by:

getPropertyNames in interface PropertiesDelegate

Returns:

an immutable collection of property names.

See Also:

PropertiesDelegate.getProperty(java.lang.String)

setProperty

public void setProperty(String name,
                        Object object)

Description copied from interface: PropertiesDelegate

Binds an object to a given property name in the current request/response exchange context. If the name specified is already used for a property, this method will replace the value of the property with the new value.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

If a null value is passed, the effect is the same as calling the PropertiesDelegate.removeProperty(String) method.

Specified by:

setProperty in interface javax.ws.rs.ext.InterceptorContext

Specified by:

setProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

object - an Object representing the property to be bound.

removeProperty

public void removeProperty(String name)

Description copied from interface: PropertiesDelegate

Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to PropertiesDelegate.getProperty(java.lang.String) to retrieve the property value will return null.

Specified by:

removeProperty in interface javax.ws.rs.ext.InterceptorContext

Specified by:

removeProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property to be removed.

getTracingLogger

protected final TracingLogger getTracingLogger()

Get tracing logger instance configured in via properties.

Returns:

tracing logger instance.

traceBefore

protected final void traceBefore(T interceptor,
                                 TracingLogger.Event event)

Tracing support - log invocation of interceptor BEFORE context.proceed() call.

Parameters:

interceptor - invoked interceptor

event - event type to be tested

traceAfter

protected final void traceAfter(T interceptor,
                                TracingLogger.Event event)

Tracing support - log invocation of interceptor AFTER context.proceed() call.

Parameters:

interceptor - invoked interceptor

event - event type to be tested

clearLastTracedInterceptor

protected final void clearLastTracedInterceptor()

Clear last traced interceptor information.

getAnnotations

public Annotation[] getAnnotations()

Specified by:

getAnnotations in interface javax.ws.rs.ext.InterceptorContext

setAnnotations

public void setAnnotations(Annotation[] annotations)

Specified by:

setAnnotations in interface javax.ws.rs.ext.InterceptorContext

getType

public Class getType()

Specified by:

getType in interface javax.ws.rs.ext.InterceptorContext

setType

public void setType(Class type)

Specified by:

setType in interface javax.ws.rs.ext.InterceptorContext

getGenericType

public Type getGenericType()

Specified by:

getGenericType in interface javax.ws.rs.ext.InterceptorContext

setGenericType

public void setGenericType(Type genericType)

Specified by:

setGenericType in interface javax.ws.rs.ext.InterceptorContext

getMediaType

public javax.ws.rs.core.MediaType getMediaType()

Specified by:

getMediaType in interface javax.ws.rs.ext.InterceptorContext

setMediaType

public void setMediaType(javax.ws.rs.core.MediaType mediaType)

Specified by:

setMediaType in interface javax.ws.rs.ext.InterceptorContext