Package javax.ws.rs.ext
Interface WriterInterceptorContext
- All Superinterfaces:
InterceptorContext
Context class used by
WriterInterceptor
to intercept calls to MessageBodyWriter.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
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionGet object to be written as HTTP entity.Get mutable map of HTTP headers.Get the output stream for the object to be written.void
proceed()
Proceed to the next interceptor in the chain.void
Update object to be written as HTTP entity.void
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 Details
-
proceed
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
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
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.
-