org.glassfish.jersey.message.internal
Class WriterInterceptorExecutor

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

All Implemented Interfaces:

javax.ws.rs.ext.InterceptorContext, javax.ws.rs.ext.WriterInterceptorContext, PropertiesDelegate

public final class WriterInterceptorExecutor
extends Object
implements javax.ws.rs.ext.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)

Constructor Summary

WriterInterceptorExecutor(Object entity, Class<?> rawType, Type type, Annotation[] annotations, javax.ws.rs.core.MediaType mediaType, javax.ws.rs.core.MultivaluedMap<String,Object> headers, PropertiesDelegate propertiesDelegate, OutputStream entityStream, MessageBodyWorkers workers, Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors)
Constructs a new executor to write given type to provided entityStream.

Method Summary

protected void	clearLastTracedInterceptor() Clear last traced interceptor information.
Annotation[]	getAnnotations()
Object	getEntity()
Type	getGenericType()
javax.ws.rs.core.MultivaluedMap<String,Object>	getHeaders()
javax.ws.rs.core.MediaType	getMediaType()
javax.ws.rs.ext.WriterInterceptor	getNextInterceptor() Returns next interceptor in the chain.
OutputStream	getOutputStream()
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.
protected TracingLogger	getTracingLogger() Get tracing logger instance configured in via properties.
Class	getType()
void	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	setEntity(Object entity)
void	setGenericType(Type genericType)
void	setMediaType(javax.ws.rs.core.MediaType mediaType)
void	setOutputStream(OutputStream os)
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

WriterInterceptorExecutor

public WriterInterceptorExecutor(Object entity,
                                 Class<?> rawType,
                                 Type type,
                                 Annotation[] annotations,
                                 javax.ws.rs.core.MediaType mediaType,
                                 javax.ws.rs.core.MultivaluedMap<String,Object> headers,
                                 PropertiesDelegate propertiesDelegate,
                                 OutputStream entityStream,
                                 MessageBodyWorkers workers,
                                 Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors)

Constructs a new executor to write given type to provided entityStream.

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.

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

Method Detail

getNextInterceptor

public javax.ws.rs.ext.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 javax.ws.rs.ext.WriterInterceptorContext

Throws:

IOException

getEntity

public Object getEntity()

Specified by:

getEntity in interface javax.ws.rs.ext.WriterInterceptorContext

setEntity

public void setEntity(Object entity)

Specified by:

setEntity in interface javax.ws.rs.ext.WriterInterceptorContext

getOutputStream

public OutputStream getOutputStream()

Specified by:

getOutputStream in interface javax.ws.rs.ext.WriterInterceptorContext

setOutputStream

public void setOutputStream(OutputStream os)

Specified by:

setOutputStream in interface javax.ws.rs.ext.WriterInterceptorContext

getHeaders

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

Specified by:

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

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