Class ReaderInterceptorExecutor
- java.lang.Object
-
- org.glassfish.jersey.message.internal.ReaderInterceptorExecutor
-
- All Implemented Interfaces:
jakarta.ws.rs.ext.InterceptorContext
,jakarta.ws.rs.ext.ReaderInterceptorContext
,org.glassfish.jersey.internal.inject.InjectionManagerSupplier
,PropertiesDelegate
public final class ReaderInterceptorExecutor extends Object implements jakarta.ws.rs.ext.ReaderInterceptorContext, org.glassfish.jersey.internal.inject.InjectionManagerSupplier
Represents reader 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 reader
execution interceptor is inserted, which finally reads an entity from the output stream provided by the chain.- Author:
- Miroslav Fuksa, Jakub Podlesak
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
clearLastTracedInterceptor()
Clear last traced interceptor information.static InputStream
closeableInputStream(InputStream inputStream)
Make theInputStream
able to close.Annotation[]
getAnnotations()
Type
getGenericType()
jakarta.ws.rs.core.MultivaluedMap<String,String>
getHeaders()
org.glassfish.jersey.internal.inject.InjectionManager
getInjectionManager()
Get injection manager.InputStream
getInputStream()
jakarta.ws.rs.core.MediaType
getMediaType()
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()
Object
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
setGenericType(Type genericType)
void
setInputStream(InputStream is)
void
setMediaType(jakarta.ws.rs.core.MediaType mediaType)
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.
-
-
-
Method Detail
-
proceed
public Object proceed() throws IOException
Starts the interceptor chain execution.- Specified by:
proceed
in interfacejakarta.ws.rs.ext.ReaderInterceptorContext
- Returns:
- an entity read from the stream.
- Throws:
IOException
-
getInputStream
public InputStream getInputStream()
- Specified by:
getInputStream
in interfacejakarta.ws.rs.ext.ReaderInterceptorContext
-
setInputStream
public void setInputStream(InputStream is)
- Specified by:
setInputStream
in interfacejakarta.ws.rs.ext.ReaderInterceptorContext
-
getHeaders
public jakarta.ws.rs.core.MultivaluedMap<String,String> getHeaders()
- Specified by:
getHeaders
in interfacejakarta.ws.rs.ext.ReaderInterceptorContext
-
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.
-
closeableInputStream
public static InputStream closeableInputStream(InputStream inputStream)
Make theInputStream
able to close. The purpose of this utility method is to undo effect ofReaderInterceptorExecutor.UnCloseableInputStream
.- Parameters:
inputStream
- PotentialReaderInterceptorExecutor.UnCloseableInputStream
to undo its effect- Returns:
- Input stream that is possible to close
-
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 interfacejakarta.ws.rs.ext.InterceptorContext
- 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 interfacejakarta.ws.rs.ext.InterceptorContext
- 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 interfacejakarta.ws.rs.ext.InterceptorContext
- 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 interfacejakarta.ws.rs.ext.InterceptorContext
- 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 interfacejakarta.ws.rs.ext.InterceptorContext
-
setAnnotations
public void setAnnotations(Annotation[] annotations)
- Specified by:
setAnnotations
in interfacejakarta.ws.rs.ext.InterceptorContext
-
getType
public Class getType()
- Specified by:
getType
in interfacejakarta.ws.rs.ext.InterceptorContext
-
setType
public void setType(Class type)
- Specified by:
setType
in interfacejakarta.ws.rs.ext.InterceptorContext
-
getGenericType
public Type getGenericType()
- Specified by:
getGenericType
in interfacejakarta.ws.rs.ext.InterceptorContext
-
setGenericType
public void setGenericType(Type genericType)
- Specified by:
setGenericType
in interfacejakarta.ws.rs.ext.InterceptorContext
-
getMediaType
public jakarta.ws.rs.core.MediaType getMediaType()
- Specified by:
getMediaType
in interfacejakarta.ws.rs.ext.InterceptorContext
-
setMediaType
public void setMediaType(jakarta.ws.rs.core.MediaType mediaType)
- Specified by:
setMediaType
in interfacejakarta.ws.rs.ext.InterceptorContext
-
-