Package org.jboss.resteasy.spi
Interface AsyncWriterInterceptor
- All Superinterfaces:
jakarta.ws.rs.ext.WriterInterceptor
- All Known Implementing Classes:
DigitalSigningInterceptor
,GZIPEncodingInterceptor
,Jackson2JsonpInterceptor
,ServerContentEncodingAnnotationFilter
public interface AsyncWriterInterceptor
extends jakarta.ws.rs.ext.WriterInterceptor
Writer interceptors which support async IO.
-
Method Summary
Modifier and TypeMethodDescriptionInterceptor method wrapping calls toAsyncMessageBodyWriter.asyncWriteTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, org.jboss.resteasy.spi.AsyncOutputStream)
method.Methods inherited from interface jakarta.ws.rs.ext.WriterInterceptor
aroundWriteTo
-
Method Details
-
asyncAroundWriteTo
Interceptor method wrapping calls toAsyncMessageBodyWriter.asyncWriteTo(T, java.lang.Class<?>, java.lang.reflect.Type, java.lang.annotation.Annotation[], jakarta.ws.rs.core.MediaType, jakarta.ws.rs.core.MultivaluedMap<java.lang.String, java.lang.Object>, org.jboss.resteasy.spi.AsyncOutputStream)
method. The parameters of the wrapped method called are available fromcontext
. Implementations of this method SHOULD explicitly callAsyncWriterInterceptorContext.asyncProceed()
to invoke the next interceptor in the chain, and ultimately the wrappedAsyncMessageBodyWriter.asyncWriteTo
method.- Parameters:
context
- invocation context.- Returns:
- a
CompletionStage
indicating completion - Throws:
IOException
- if an IO error arises or is thrown by the wrappedAsyncMessageBodyWriter.asyncWriteTo
method, in the returnedCompletionStage
.jakarta.ws.rs.WebApplicationException
- thrown by the wrappedAsyncMessageBodyWriter.asyncWriteTo
method, in the returnedCompletionStage
.
-