org.glassfish.jersey.message.internal

Class WriterInterceptorExecutor

java.lang.Object

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

org.glassfish.jersey.message.internal.WriterInterceptorExecutor

All Implemented Interfaces:

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

public final class WriterInterceptorExecutor
extends InterceptorExecutor<javax.ws.rs.ext.WriterInterceptor>
implements javax.ws.rs.ext.WriterInterceptorContext, ServiceLocatorSupplier

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	WriterInterceptorExecutor.TerminalWriterInterceptor Terminal writer interceptor which choose the appropriate MessageBodyWriter and writes the entity to the output stream.
private static class	WriterInterceptorExecutor.UnCloseableOutputStream MessageBodyWriters should not close the given stream.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	entity
private javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object>	headers
private java.util.Iterator<javax.ws.rs.ext.WriterInterceptor>	iterator
private static java.util.logging.Logger	LOGGER
private java.io.OutputStream	outputStream
private int	processedCount
private org.glassfish.hk2.api.ServiceLocator	serviceLocator

Constructor Summary

Constructors

Constructor and Description

WriterInterceptorExecutor(java.lang.Object entity, 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.Object> headers, PropertiesDelegate propertiesDelegate, java.io.OutputStream entityStream, MessageBodyWorkers workers, java.lang.Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors, org.glassfish.hk2.api.ServiceLocator serviceLocator) Constructs a new executor to write given type to provided entityStream.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getEntity()
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.Object>	getHeaders()
javax.ws.rs.ext.WriterInterceptor	getNextInterceptor() Returns next interceptor in the chain.
java.io.OutputStream	getOutputStream()
(package private) int	getProcessedCount() Get number of processed interceptors.
org.glassfish.hk2.api.ServiceLocator	getServiceLocator() Get service locator.
void	proceed() Starts the interceptor chain execution.
void	setEntity(java.lang.Object entity)
void	setOutputStream(java.io.OutputStream os)

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

outputStream

private java.io.OutputStream outputStream

headers

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

entity

private java.lang.Object entity

iterator

private final java.util.Iterator<javax.ws.rs.ext.WriterInterceptor> iterator

processedCount

private int processedCount

serviceLocator

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

Constructor Detail

WriterInterceptorExecutor

public WriterInterceptorExecutor(java.lang.Object entity,
                                 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.Object> headers,
                                 PropertiesDelegate propertiesDelegate,
                                 java.io.OutputStream entityStream,
                                 MessageBodyWorkers workers,
                                 java.lang.Iterable<javax.ws.rs.ext.WriterInterceptor> writerInterceptors,
                                 org.glassfish.hk2.api.ServiceLocator serviceLocator)

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 interceptors that are to be used to intercept writing of an entity.

serviceLocator - Service locator.

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 java.io.IOException

Starts the interceptor chain execution.

Specified by:

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

Throws:

java.io.IOException

getEntity

public java.lang.Object getEntity()

Specified by:

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

setEntity

public void setEntity(java.lang.Object entity)

Specified by:

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

getOutputStream

public java.io.OutputStream getOutputStream()

Specified by:

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

setOutputStream

public void setOutputStream(java.io.OutputStream os)

Specified by:

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

getHeaders

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

Specified by:

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

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;