org.glassfish.jersey.message.internal

Class WriterInterceptorExecutor

java.lang.Object

org.glassfish.jersey.message.internal.WriterInterceptorExecutor

All Implemented Interfaces:

InterceptorContext, WriterInterceptorContext

public final class WriterInterceptorExecutor
extends Object
implements WriterInterceptorContext

Represents writer 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 writer execution interceptor is inserted, which writes entity to the output stream provided by the chain.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERCEPTORS Defines property, which is used to pass a list of writer interceptors to the executor via PropertiesDelegate.

Constructor Summary

Constructors

Constructor and Description

WriterInterceptorExecutor(Object entity, Class<?> rawType, Type type, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> headers, PropertiesDelegate propertiesDelegate, OutputStream entityStream, MessageBodyWorkers workers, MessageBodyWorkers.MessageBodySizeCallback sizeCallback, boolean intercept, boolean writeEntity) Constructs a new executor to write given type to provided entityStream.

Method Summary

Methods

Modifier and Type	Method and Description
Annotation[]	getAnnotations()
Object	getEntity()
Type	getGenericType()
MultivaluedMap<String,Object>	getHeaders()
MediaType	getMediaType()
WriterInterceptor	getNextInterceptor() Returns next interceptor in the chain.
OutputStream	getOutputStream()
Object	getProperty(String name)
Collection<String>	getPropertyNames()
Class	getType()
void	proceed() Starts the interceptor chain execution.
void	removeProperty(String name)
void	setAnnotations(Annotation[] annotations)
void	setEntity(Object entity)
void	setGenericType(Type genericType)
void	setMediaType(MediaType mediaType)
void	setOutputStream(OutputStream os)
void	setProperty(String name, Object object)
void	setType(Class type)

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

INTERCEPTORS

public static final String INTERCEPTORS

Defines property, which is used to pass a list of writer interceptors to the executor via PropertiesDelegate.

See Also:

Constant Field Values

Constructor Detail

WriterInterceptorExecutor

public WriterInterceptorExecutor(Object entity,
                         Class<?> rawType,
                         Type type,
                         Annotation[] annotations,
                         MediaType mediaType,
                         MultivaluedMap<String,Object> headers,
                         PropertiesDelegate propertiesDelegate,
                         OutputStream entityStream,
                         MessageBodyWorkers workers,
                         MessageBodyWorkers.MessageBodySizeCallback sizeCallback,
                         boolean intercept,
                         boolean writeEntity)

Constructs a new executor to write given type to provided entityStream. List of interceptors to be used is taken from given workers instance unless "jersey.runtime.writer.interceptors" property is set in propertiesDelegate. If such a property is present, the executor tries to cast it to List<WriterInterceptor> and the list is then used to build the interceptor chain.

Parameters:

entity - entity object to be processed.

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 HTTP headers associated with HTTP entity.

propertiesDelegate - request-scoped properties delegate.

entityStream - InputStream from which an entity will be read. The stream is not closed after reading the entity.

workers - Message body workers.

sizeCallback - MessageBodyWorkers.MessageBodySizeCallback instance. Can be null.

intercept - if true, user interceptors will be executed. Otherwise only exception wrapping interceptor will be executed on the client side.

writeEntity - if true, the entity will be written. Otherwise only headers will be written to the underlying OutputStream.

Method Detail

getNextInterceptor

public WriterInterceptor getNextInterceptor()

Returns next interceptor in the chain. Stateful method.

Returns:

Next interceptor.

proceed

public void proceed()
             throws IOException

Starts the interceptor chain execution.

Specified by:

proceed in interface WriterInterceptorContext

Throws:

IOException

getEntity

public Object getEntity()

Specified by:

getEntity in interface WriterInterceptorContext

setEntity

public void setEntity(Object entity)

Specified by:

setEntity in interface WriterInterceptorContext

getOutputStream

public OutputStream getOutputStream()

Specified by:

getOutputStream in interface WriterInterceptorContext

setOutputStream

public void setOutputStream(OutputStream os)

Specified by:

setOutputStream in interface WriterInterceptorContext

getHeaders

public MultivaluedMap<String,Object> getHeaders()

Specified by:

getHeaders in interface WriterInterceptorContext

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface InterceptorContext

getPropertyNames

public Collection<String> getPropertyNames()

Specified by:

getPropertyNames in interface InterceptorContext

setProperty

public void setProperty(String name,
               Object object)

Specified by:

setProperty in interface InterceptorContext

removeProperty

public void removeProperty(String name)

Specified by:

removeProperty in interface InterceptorContext

getAnnotations

public Annotation[] getAnnotations()

Specified by:

getAnnotations in interface InterceptorContext

setAnnotations

public void setAnnotations(Annotation[] annotations)

Specified by:

setAnnotations in interface InterceptorContext

getType

public Class getType()

Specified by:

getType in interface InterceptorContext

setType

public void setType(Class type)

Specified by:

setType in interface InterceptorContext

getGenericType

public Type getGenericType()

Specified by:

getGenericType in interface InterceptorContext

setGenericType

public void setGenericType(Type genericType)

Specified by:

setGenericType in interface InterceptorContext

getMediaType

public MediaType getMediaType()

Specified by:

getMediaType in interface InterceptorContext

setMediaType

public void setMediaType(MediaType mediaType)

Specified by:

setMediaType in interface InterceptorContext