public final class WriterInterceptorExecutor extends Object implements WriterInterceptorContext, org.glassfish.jersey.internal.inject.InjectionManagerSupplier
message body writer
execution interceptor is inserted,
which writes entity to the output stream provided by the chain.Constructor and Description |
---|
WriterInterceptorExecutor(Object entity,
Class<?> rawType,
Type type,
Annotation[] annotations,
MediaType mediaType,
MultivaluedMap<String,Object> headers,
PropertiesDelegate propertiesDelegate,
OutputStream entityStream,
MessageBodyWorkers workers,
Iterable<WriterInterceptor> writerInterceptors,
org.glassfish.jersey.internal.inject.InjectionManager injectionManager)
Constructs a new executor to write given type to provided
entityStream . |
Modifier and Type | Method and Description |
---|---|
protected void |
clearLastTracedInterceptor()
Clear last traced interceptor information.
|
Annotation[] |
getAnnotations() |
Object |
getEntity() |
Type |
getGenericType() |
MultivaluedMap<String,Object> |
getHeaders() |
org.glassfish.jersey.internal.inject.InjectionManager |
getInjectionManager()
Get injection manager.
|
MediaType |
getMediaType() |
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(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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getType, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType
public WriterInterceptorExecutor(Object entity, Class<?> rawType, Type type, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String,Object> headers, PropertiesDelegate propertiesDelegate, OutputStream entityStream, MessageBodyWorkers workers, Iterable<WriterInterceptor> writerInterceptors, org.glassfish.jersey.internal.inject.InjectionManager injectionManager)
entityStream
.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.injectionManager
- injection manager.public void proceed() throws IOException
proceed
in interface WriterInterceptorContext
IOException
public Object getEntity()
getEntity
in interface WriterInterceptorContext
public void setEntity(Object entity)
setEntity
in interface WriterInterceptorContext
public OutputStream getOutputStream()
getOutputStream
in interface WriterInterceptorContext
public void setOutputStream(OutputStream os)
setOutputStream
in interface WriterInterceptorContext
public MultivaluedMap<String,Object> getHeaders()
getHeaders
in interface WriterInterceptorContext
public org.glassfish.jersey.internal.inject.InjectionManager getInjectionManager()
org.glassfish.jersey.internal.inject.InjectionManagerSupplier
getInjectionManager
in interface org.glassfish.jersey.internal.inject.InjectionManagerSupplier
public Object getProperty(String name)
PropertiesDelegate
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.
getProperty
in interface InterceptorContext
getProperty
in interface PropertiesDelegate
name
- a String
specifying the name of the property.Object
containing the value of the property, or
null
if no property exists matching the given name.PropertiesDelegate.getPropertyNames()
public Collection<String> getPropertyNames()
PropertiesDelegate
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.
getPropertyNames
in interface InterceptorContext
getPropertyNames
in interface PropertiesDelegate
collection
of property names.PropertiesDelegate.getProperty(java.lang.String)
public void setProperty(String name, Object object)
PropertiesDelegate
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.
setProperty
in interface InterceptorContext
setProperty
in interface PropertiesDelegate
name
- a String
specifying the name of the property.object
- an Object
representing the property to be bound.public void removeProperty(String name)
PropertiesDelegate
PropertiesDelegate.getProperty(java.lang.String)
to retrieve the property value will return null
.removeProperty
in interface InterceptorContext
removeProperty
in interface PropertiesDelegate
name
- a String
specifying the name of the property to be removed.protected final TracingLogger getTracingLogger()
protected final void traceBefore(T interceptor, TracingLogger.Event event)
interceptor
- invoked interceptorevent
- event type to be testedprotected final void traceAfter(T interceptor, TracingLogger.Event event)
interceptor
- invoked interceptorevent
- event type to be testedprotected final void clearLastTracedInterceptor()
public Annotation[] getAnnotations()
getAnnotations
in interface InterceptorContext
public void setAnnotations(Annotation[] annotations)
setAnnotations
in interface InterceptorContext
public Class getType()
getType
in interface InterceptorContext
public void setType(Class type)
setType
in interface InterceptorContext
public Type getGenericType()
getGenericType
in interface InterceptorContext
public void setGenericType(Type genericType)
setGenericType
in interface InterceptorContext
public MediaType getMediaType()
getMediaType
in interface InterceptorContext
public void setMediaType(MediaType mediaType)
setMediaType
in interface InterceptorContext
Copyright © 2007-2023, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.