Class WriterInterceptorExecutor
- java.lang.Object
-
- org.glassfish.jersey.message.internal.WriterInterceptorExecutor
-
- All Implemented Interfaces:
InterceptorContext
,WriterInterceptorContext
,org.glassfish.jersey.internal.inject.InjectionManagerSupplier
,PropertiesDelegate
public final class WriterInterceptorExecutor extends Object implements WriterInterceptorContext, org.glassfish.jersey.internal.inject.InjectionManagerSupplier
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 amessage body writer
execution interceptor is inserted, which writes entity to the output stream provided by the chain.- Author:
- Miroslav Fuksa, Jakub Podlesak
-
-
Constructor Summary
Constructors Constructor 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 providedentityStream
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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, ornull
if there is no property by that name.Collection<String>
getPropertyNames()
Returns an immutablecollection
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()
boolean
hasProperty(String name)
Returnstrue
if the property with the given name registered in the current request/response exchange context, orfalse
if there is no property by that name.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.-
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
getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getType, hasProperty, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType
-
-
-
-
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, Iterable<WriterInterceptor> writerInterceptors, org.glassfish.jersey.internal.inject.InjectionManager injectionManager)
Constructs a new executor to write given type to providedentityStream
.- 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 byMethod.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.
-
-
Method Detail
-
proceed
public void proceed() throws IOException
Starts the interceptor chain execution.- Specified by:
proceed
in interfaceWriterInterceptorContext
- Throws:
IOException
-
getEntity
public Object getEntity()
- Specified by:
getEntity
in interfaceWriterInterceptorContext
-
setEntity
public void setEntity(Object entity)
- Specified by:
setEntity
in interfaceWriterInterceptorContext
-
getOutputStream
public OutputStream getOutputStream()
- Specified by:
getOutputStream
in interfaceWriterInterceptorContext
-
setOutputStream
public void setOutputStream(OutputStream os)
- Specified by:
setOutputStream
in interfaceWriterInterceptorContext
-
getHeaders
public MultivaluedMap<String,Object> getHeaders()
- Specified by:
getHeaders
in interfaceWriterInterceptorContext
-
getInjectionManager
public org.glassfish.jersey.internal.inject.InjectionManager getInjectionManager()
Description copied from interface:org.glassfish.jersey.internal.inject.InjectionManagerSupplier
Get injection manager.- Specified by:
getInjectionManager
in interfaceorg.glassfish.jersey.internal.inject.InjectionManagerSupplier
- Returns:
- injection manager.
-
hasProperty
public boolean hasProperty(String name)
Description copied from interface:PropertiesDelegate
Returnstrue
if the property with the given name registered in the current request/response exchange context, orfalse
if there is no property by that name.Use the
PropertiesDelegate.getProperty(java.lang.String)
method with a property name to get the value of a property.- Specified by:
hasProperty
in interfaceInterceptorContext
- Specified by:
hasProperty
in interfacePropertiesDelegate
- Returns:
true
if a property matching the given name exists, orfalse
otherwise.- See Also:
PropertiesDelegate.getProperty(java.lang.String)
-
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, ornull
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 interfaceInterceptorContext
- Specified by:
getProperty
in interfacePropertiesDelegate
- Parameters:
name
- aString
specifying the name of the property.- Returns:
- an
Object
containing the value of the property, ornull
if no property exists matching the given name. - See Also:
PropertiesDelegate.getPropertyNames()
-
getPropertyNames
public Collection<String> getPropertyNames()
Description copied from interface:PropertiesDelegate
Returns an immutablecollection
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 interfaceInterceptorContext
- Specified by:
getPropertyNames
in interfacePropertiesDelegate
- 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 thePropertiesDelegate.removeProperty(String)
method.- Specified by:
setProperty
in interfaceInterceptorContext
- Specified by:
setProperty
in interfacePropertiesDelegate
- Parameters:
name
- aString
specifying the name of the property.object
- anObject
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 toPropertiesDelegate.getProperty(java.lang.String)
to retrieve the property value will returnnull
.- Specified by:
removeProperty
in interfaceInterceptorContext
- Specified by:
removeProperty
in interfacePropertiesDelegate
- Parameters:
name
- aString
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 interceptorevent
- 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 interceptorevent
- event type to be tested
-
clearLastTracedInterceptor
protected final void clearLastTracedInterceptor()
Clear last traced interceptor information.
-
getAnnotations
public Annotation[] getAnnotations()
- Specified by:
getAnnotations
in interfaceInterceptorContext
-
setAnnotations
public void setAnnotations(Annotation[] annotations)
- Specified by:
setAnnotations
in interfaceInterceptorContext
-
getType
public Class getType()
- Specified by:
getType
in interfaceInterceptorContext
-
setType
public void setType(Class type)
- Specified by:
setType
in interfaceInterceptorContext
-
getGenericType
public Type getGenericType()
- Specified by:
getGenericType
in interfaceInterceptorContext
-
setGenericType
public void setGenericType(Type genericType)
- Specified by:
setGenericType
in interfaceInterceptorContext
-
getMediaType
public MediaType getMediaType()
- Specified by:
getMediaType
in interfaceInterceptorContext
-
setMediaType
public void setMediaType(MediaType mediaType)
- Specified by:
setMediaType
in interfaceInterceptorContext
-
-