-
- All Superinterfaces:
- InterceptorContext
public interface WriterInterceptorContext extends InterceptorContext
Context class used byWriterInterceptor
to intercept 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)
. 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:
WriterInterceptor
,MessageBodyWriter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Object
getEntity()
Get object to be written as HTTP entity.MultivaluedMap<String,Object>
getHeaders()
Get mutable map of HTTP headers.OutputStream
getOutputStream()
Get the output stream for the object to be written.void
proceed()
Proceed to the next interceptor in the chain.void
setEntity(Object entity)
Update object to be written as HTTP entity.void
setOutputStream(OutputStream os)
Set a new output stream for the object to be written.-
Methods inherited from interface javax.ws.rs.ext.InterceptorContext
getAnnotations, getGenericType, getMediaType, getProperty, getPropertyNames, getType, removeProperty, setAnnotations, setGenericType, setMediaType, setProperty, setType
-
-
-
-
Method Detail
-
proceed
void proceed() throws IOException, WebApplicationException
Proceed to the next interceptor in the chain. 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 wrappedMessageBodyWriter.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.- Throws:
IOException
- if an IO error arises or is thrown by the wrappedMessageBodyWriter.writeTo
method.WebApplicationException
- thrown by the wrappedMessageBodyWriter.writeTo
method.
-
getEntity
Object getEntity()
Get object to be written as HTTP entity.- Returns:
- object to be written as HTTP entity.
-
setEntity
void setEntity(Object entity)
Update object to be written as HTTP entity.- Parameters:
entity
- new object to be written.
-
getOutputStream
OutputStream getOutputStream()
Get the output stream for the object to be written. The JAX-RS runtime is responsible for closing the output stream.- Returns:
- output stream for the object to be written.
-
setOutputStream
void setOutputStream(OutputStream os)
Set a new output stream for the object to be written. For example, by wrapping it with another output stream. The JAX-RS runtime is responsible for closing the output stream that is set.- Parameters:
os
- new output stream for the object to be written.
-
getHeaders
MultivaluedMap<String,Object> getHeaders()
Get mutable map of HTTP headers.- Returns:
- map of HTTP headers.
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 19:07:31 Cette version de la page est en cache (à la date du 21/08/2025 19:07:31) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/ws/rs/ext/WriterInterceptorContext.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.