org.glassfish.jersey.message.internal

Class ReaderInterceptorExecutor

java.lang.Object

org.glassfish.jersey.message.internal.ReaderInterceptorExecutor

All Implemented Interfaces:

InterceptorContext, ReaderInterceptorContext, ServiceLocatorSupplier, PropertiesDelegate

public final class ReaderInterceptorExecutor
extends Object
implements 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

Constructors

Constructor and Description

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearLastTracedInterceptor() Clear last traced interceptor information.
Annotation[]	getAnnotations() Get an array of the annotations formally declared on the artifact that initiated the intercepted entity provider invocation.
Type	getGenericType() Get the type of the object to be produced or written.
MultivaluedMap<String,String>	getHeaders() Get mutable map of HTTP headers.
InputStream	getInputStream() Get the input stream of the object to be read.
MediaType	getMediaType() Get media type of HTTP entity.
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() Get Java type supported by corresponding message body provider.
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) Update annotations on the formal declaration of the artifact that initiated the intercepted entity provider invocation.
void	setGenericType(Type genericType) Update type of the object to be produced or written.
void	setInputStream(InputStream is) Set the input stream of the object to be read.
void	setMediaType(MediaType mediaType) Update media type of HTTP entity.
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) Update Java type before calling message body provider.
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,
                         MediaType mediaType,
                         MultivaluedMap<String,String> headers,
                         PropertiesDelegate propertiesDelegate,
                         InputStream inputStream,
                         MessageBodyWorkers workers,
                         Iterable<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 ReaderInterceptorContext

Returns:

an entity read from the stream.

Throws:

IOException - if an IO error arises or is thrown by the wrapped MessageBodyReader.readFrom method.

getInputStream

public InputStream getInputStream()

Description copied from interface: ReaderInterceptorContext

Get the input stream of the object to be read. The JAX-RS runtime is responsible for closing the input stream.

Specified by:

getInputStream in interface ReaderInterceptorContext

Returns:

input stream of the object to be read.

setInputStream

public void setInputStream(InputStream is)

Description copied from interface: ReaderInterceptorContext

Set the input stream of the object to be read. For example, by wrapping it with another input stream. The JAX-RS runtime is responsible for closing the input stream that is set.

Specified by:

setInputStream in interface ReaderInterceptorContext

Parameters:

is - new input stream.

getHeaders

public MultivaluedMap<String,String> getHeaders()

Description copied from interface: ReaderInterceptorContext

Get mutable map of HTTP headers.

Note that while the headers are mutable, a reader interceptor should typically roll-back any header modifications once the call to context.proceed() returns, to avoid externally visible side-effects of the interceptor invocation.

Specified by:

getHeaders in interface ReaderInterceptorContext

Returns:

map of HTTP headers.

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: InterceptorContext

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 InterceptorContext.getPropertyNames(). Custom property names should follow the same convention as package names.

In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all the attributes available in the ServletRequest.

Specified by:

getProperty in interface 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:

InterceptorContext.getPropertyNames()

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: InterceptorContext

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

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

In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes available in the ServletRequest. Any modifications of the properties are also reflected in the set of properties of the associated ServletRequest.

Specified by:

getPropertyNames in interface InterceptorContext

Specified by:

getPropertyNames in interface PropertiesDelegate

Returns:

an immutable collection of property names.

See Also:

InterceptorContext.getProperty(java.lang.String)

setProperty

public void setProperty(String name,
               Object object)

Description copied from interface: InterceptorContext

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 InterceptorContext.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 InterceptorContext.removeProperty(String) method.

In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all the attributes available in the ServletRequest.

Specified by:

setProperty in interface 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: InterceptorContext

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

In a Servlet container, on the server side, the properties are backed by the ServletRequest and contain all the attributes available in the ServletRequest.

Specified by:

removeProperty in interface 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()

Description copied from interface: InterceptorContext

Get an array of the annotations formally declared on the artifact that initiated the intercepted entity provider invocation. 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(); if the server-side response entity instance is to be converted into an output stream, this will be the annotations on the matched resource method returned by Method.getAnnotations(). This method may return an empty array in case the interceptor is not invoked in a context of any particular resource method (e.g. as part of the client API), but will never return null.

Specified by:

getAnnotations in interface InterceptorContext

Returns:

annotations declared on the artifact that initiated the intercepted entity provider invocation.

setAnnotations

public void setAnnotations(Annotation[] annotations)

Description copied from interface: InterceptorContext

Update annotations on the formal declaration of the artifact that initiated the intercepted entity provider invocation. Calling this method has no effect in the client API.

Specified by:

setAnnotations in interface InterceptorContext

Parameters:

annotations - updated annotations declarataion of the artifact that initiated the intercepted entity provider invocation. Must not be null.

getType

public Class getType()

Description copied from interface: InterceptorContext

Get Java type supported by corresponding message body provider.

Specified by:

getType in interface InterceptorContext

Returns:

java type supported by provider

setType

public void setType(Class type)

Description copied from interface: InterceptorContext

Update Java type before calling message body provider.

Specified by:

setType in interface InterceptorContext

Parameters:

type - java type for provider

getGenericType

public Type getGenericType()

Description copied from interface: InterceptorContext

Get the type of the object to be produced or written.

Specified by:

getGenericType in interface InterceptorContext

Returns:

type of object produced or written

setGenericType

public void setGenericType(Type genericType)

Description copied from interface: InterceptorContext

Update type of the object to be produced or written.

Specified by:

setGenericType in interface InterceptorContext

Parameters:

genericType - new type for object

getMediaType

public MediaType getMediaType()

Description copied from interface: InterceptorContext

Get media type of HTTP entity.

Specified by:

getMediaType in interface InterceptorContext

Returns:

media type of HTTP entity

setMediaType

public void setMediaType(MediaType mediaType)

Description copied from interface: InterceptorContext

Update media type of HTTP entity.

Specified by:

setMediaType in interface InterceptorContext

Parameters:

mediaType - new type for HTTP entity