Package org.jboss.resteasy.core.interception.jaxrs

Class AbstractReaderInterceptorContext

java.lang.Object

org.jboss.resteasy.core.interception.jaxrs.AbstractReaderInterceptorContext

All Implemented Interfaces:

InterceptorContext, ReaderInterceptorContext

Direct Known Subclasses:

ClientReaderInterceptorContext, ServerReaderInterceptorContext

public abstract class AbstractReaderInterceptorContext
extends Object
implements ReaderInterceptorContext

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields

Modifier and Type	Field	Description
protected Annotation[]	annotations
protected Type	genericType
protected MultivaluedMap<String,String>	headers
protected int	index
protected InputStream	inputStream
protected ReaderInterceptor[]	interceptors
protected MediaType	mediaType
protected ResteasyProviderFactory	providerFactory
protected RESTEasyTracingLogger	tracingLogger
protected Class	type

Constructor Summary

Constructors

Constructor	Description
AbstractReaderInterceptorContext(MediaType mediaType, ResteasyProviderFactory providerFactory, Annotation[] annotations, ReaderInterceptor[] interceptors, MultivaluedMap<String,String> headers, Type genericType, Class type, InputStream inputStream)	Deprecated.
AbstractReaderInterceptorContext(MediaType mediaType, ResteasyProviderFactory providerFactory, Annotation[] annotations, ReaderInterceptor[] interceptors, MultivaluedMap<String,String> headers, Type genericType, Class type, InputStream inputStream, RESTEasyTracingLogger logger)

Method Summary

Modifier and Type	Method	Description
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	getProcessedInterceptorCount()
protected MessageBodyReader	getReader()
Class	getType()	Get Java type supported by corresponding message body provider.
Object	proceed()	Proceed to the next interceptor in the chain.
protected Object	readFrom(MessageBodyReader reader)
protected abstract MessageBodyReader	resolveReader(MediaType mediaType)
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	setType(Class type)	Update Java type before calling message body provider.
protected abstract void	throwReaderNotFound()
protected final void	traceAfter(ReaderInterceptor interceptor)
protected final void	traceBefore(ReaderInterceptor interceptor)

Methods inherited from class java.lang.Object

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

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

getProperty, getPropertyNames, hasProperty, removeProperty, setProperty

Field Details

tracingLogger

protected RESTEasyTracingLogger tracingLogger

interceptors

protected ReaderInterceptor[] interceptors

providerFactory

protected ResteasyProviderFactory providerFactory

type

protected Class type

genericType

protected Type genericType

annotations

protected Annotation[] annotations

mediaType

protected MediaType mediaType

headers

protected MultivaluedMap<String,String> headers

inputStream

protected InputStream inputStream

index

protected int index

Constructor Details

AbstractReaderInterceptorContext

@Deprecated
public AbstractReaderInterceptorContext(MediaType mediaType,
 ResteasyProviderFactory providerFactory,
 Annotation[] annotations,
 ReaderInterceptor[] interceptors,
 MultivaluedMap<String,String> headers,
 Type genericType,
 Class type,
 InputStream inputStream)

Deprecated.

AbstractReaderInterceptorContext

public AbstractReaderInterceptorContext(MediaType mediaType,
 ResteasyProviderFactory providerFactory,
 Annotation[] annotations,
 ReaderInterceptor[] interceptors,
 MultivaluedMap<String,String> headers,
 Type genericType,
 Class type,
 InputStream inputStream,
 RESTEasyTracingLogger logger)

Method Details

proceed

public Object proceed()
               throws IOException

Description copied from interface: ReaderInterceptorContext

Proceed to the next interceptor in the chain. Return the result of the next interceptor invoked. Interceptors MUST explicitly call this method to continue the execution chain; the call to this method in the last interceptor of the chain will invoke the wrapped MessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream).

Specified by:

proceed in interface ReaderInterceptorContext

Returns:

result of next interceptor invoked.

Throws:

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

readFrom

protected Object readFrom(MessageBodyReader reader)
                   throws IOException

Throws:

IOException

traceBefore

protected final void traceBefore(ReaderInterceptor interceptor)

traceAfter

protected final void traceAfter(ReaderInterceptor interceptor)

getReader

protected MessageBodyReader getReader()

resolveReader

protected abstract MessageBodyReader resolveReader(MediaType mediaType)

throwReaderNotFound

protected abstract void throwReaderNotFound()

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.

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

getProcessedInterceptorCount

public Object getProcessedInterceptorCount()