-
- All Superinterfaces:
- InterceptorContext
public interface ReaderInterceptorContext extends InterceptorContext
Context class used byReaderInterceptorto intercept calls to (@link javax.ws.rs.ext.MessageBodyReader#readFrom}. The getters and setters in this context class correspond to the parameters of the intercepted method.- Since:
- 2.0
- Author:
- Santiago Pericas-Geertsen, Bill Burke
- See Also:
ReaderInterceptor,MessageBodyReader
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description MultivaluedMap<String,String>getHeaders()Get mutable map of HTTP headers.InputStreamgetInputStream()Get the input stream of the object to be read.Objectproceed()Proceed to the next interceptor in the chain.voidsetInputStream(InputStream is)Set the input stream of the object to be read.-
Methods inherited from interface javax.ws.rs.ext.InterceptorContext
getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getType, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType
-
-
-
-
Method Detail
-
proceed
Object proceed() throws IOException, WebApplicationException
Proceed to the next interceptor in the chain. Return the result of the next interceptor invoked. Interceptors MUST explicitly call this method to continue the execution chain; the call to this method in the last interceptor of the chain will invoke the wrappedMessageBodyReader.readFrom(java.lang.Class<T>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.String>, java.io.InputStream).- Returns:
- result of next interceptor invoked.
- Throws:
IOException- if an IO error arises or is thrown by the wrappedMessageBodyReader.readFrommethod.WebApplicationException- thrown by the wrappedMessageBodyReader.readFrommethod.
-
getInputStream
InputStream getInputStream()
Get the input stream of the object to be read. The JAX-RS runtime is responsible for closing the input stream.- Returns:
- input stream of the object to be read.
-
setInputStream
void setInputStream(InputStream is)
Set the input stream of the object to be read. For example, by wrapping it with another input stream. The JAX-RS runtime is responsible for closing the input stream that is set.- Parameters:
is- new input stream.
-
getHeaders
MultivaluedMap<String,String> getHeaders()
Get mutable map of HTTP headers.Note that while the headers are mutable, a
reader interceptorshould typically roll-back any header modifications once the call tocontext.proceed()returns, to avoid externally visible side-effects of the interceptor invocation.- Returns:
- map of HTTP headers.
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/ext/ReaderInterceptorContext.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.