-
public interface WriterInterceptor
Interface for message body writer interceptors that wrap around calls toMessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
.Providers implementing
WriterInterceptor
contract must be either programmatically registered in a JAX-RS runtime or must be annotated with@Provider
annotation to be automatically discovered by the JAX-RS runtime during a provider scanning phase. Message body interceptor instances may also be discovered and bounddynamically
to particular resource methods.- Since:
- 2.0
- Author:
- Santiago Pericas-Geertsen, Bill Burke, Marek Potociar
- See Also:
MessageBodyWriter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
aroundWriteTo(WriterInterceptorContext context)
-
-
-
Method Detail
-
aroundWriteTo
void aroundWriteTo(WriterInterceptorContext context) throws IOException, WebApplicationException
Interceptor method wrapping calls toMessageBodyWriter.writeTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], javax.ws.rs.core.MediaType, javax.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, java.io.OutputStream)
method. The parameters of the wrapped method called are available fromcontext
. Implementations of this method SHOULD explicitly callWriterInterceptorContext.proceed()
to invoke the next interceptor in the chain, and ultimately the wrappedMessageBodyWriter.writeTo
method.- Parameters:
context
- invocation context.- Throws:
IOException
- if an IO error arises or is thrown by the wrappedMessageBodyWriter.writeTo
method.WebApplicationException
- thrown by the wrappedMessageBodyWriter.writeTo
method.
-
-
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/WriterInterceptor.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.