org.glassfish.jersey.message.internal

Class ReaderInterceptorExecutor

java.lang.Object

org.glassfish.jersey.message.internal.InterceptorExecutor<javax.ws.rs.ext.ReaderInterceptor>

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 InterceptorExecutor<javax.ws.rs.ext.ReaderInterceptor>
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ReaderInterceptorExecutor.TerminalReaderInterceptor Terminal reader interceptor which choose the appropriate MessageBodyReader and reads the entity from the input stream.
private static class	ReaderInterceptorExecutor.UnCloseableInputStream MessageBodyReaders should not close the given stream.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String>	headers
private java.io.InputStream	inputStream
private java.util.Iterator<javax.ws.rs.ext.ReaderInterceptor>	interceptors
private static java.util.logging.Logger	LOGGER
private int	processedCount
private org.glassfish.hk2.api.ServiceLocator	serviceLocator
private boolean	translateNce
private MessageBodyWorkers	workers

Constructor Summary

Constructors

Constructor and Description

ReaderInterceptorExecutor(java.lang.Class<?> rawType, java.lang.reflect.Type type, java.lang.annotation.Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> headers, PropertiesDelegate propertiesDelegate, java.io.InputStream inputStream, MessageBodyWorkers workers, java.lang.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

Modifier and Type	Method and Description
static java.io.InputStream	closeableInputStream(java.io.InputStream inputStream) Make the InputStream able to close.
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String>	getHeaders()
java.io.InputStream	getInputStream()
(package private) int	getProcessedCount() Get number of processed interceptors.
org.glassfish.hk2.api.ServiceLocator	getServiceLocator() Get service locator.
java.lang.Object	proceed() Starts the interceptor chain execution.
void	setInputStream(java.io.InputStream is)

Methods inherited from class org.glassfish.jersey.message.internal.InterceptorExecutor

clearLastTracedInterceptor, getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getTracingLogger, getType, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType, traceAfter, traceBefore

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

Field Detail

LOGGER

private static final java.util.logging.Logger LOGGER

headers

private final javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> headers

interceptors

private final java.util.Iterator<javax.ws.rs.ext.ReaderInterceptor> interceptors

workers

private final MessageBodyWorkers workers

translateNce

private final boolean translateNce

serviceLocator

private final org.glassfish.hk2.api.ServiceLocator serviceLocator

inputStream

private java.io.InputStream inputStream

processedCount

private int processedCount

Constructor Detail

ReaderInterceptorExecutor

public ReaderInterceptorExecutor(java.lang.Class<?> rawType,
                                 java.lang.reflect.Type type,
                                 java.lang.annotation.Annotation[] annotations,
                                 javax.ws.rs.core.MediaType mediaType,
                                 javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> headers,
                                 PropertiesDelegate propertiesDelegate,
                                 java.io.InputStream inputStream,
                                 MessageBodyWorkers workers,
                                 java.lang.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 java.lang.Object proceed()
                         throws java.io.IOException

Starts the interceptor chain execution.

Specified by:

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

Returns:

an entity read from the stream.

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream()

Specified by:

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

setInputStream

public void setInputStream(java.io.InputStream is)

Specified by:

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

getHeaders

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

Specified by:

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

getProcessedCount

int getProcessedCount()

Get number of processed interceptors.

Returns:

number of processed interceptors.

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;

closeableInputStream

public static java.io.InputStream closeableInputStream(java.io.InputStream inputStream)

Make the InputStream able to close.

The purpose of this utility method is to undo effect of ReaderInterceptorExecutor.UnCloseableInputStream.

Parameters:

inputStream - Potential ReaderInterceptorExecutor.UnCloseableInputStream to undo its effect

Returns:

Input stream that is possible to close