Interface AsyncWriterInterceptor

All Superinterfaces:

jakarta.ws.rs.ext.WriterInterceptor

All Known Implementing Classes:

DigitalSigningInterceptor, GZIPEncodingInterceptor, Jackson2JsonpInterceptor, ReaderContextFirstWriterInterceptor, ReaderContextSecondWriterInterceptor, ServerContentEncodingAnnotationFilter

public interface AsyncWriterInterceptor
extends jakarta.ws.rs.ext.WriterInterceptor

Writer interceptors which support async IO.

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	asyncAroundWriteTo(AsyncWriterInterceptorContext context)	Interceptor method wrapping calls to AsyncMessageBodyWriter.asyncWriteTo(T, Class, Type, Annotation[], MediaType, MultivaluedMap, AsyncOutputStream) method.

Methods inherited from interface jakarta.ws.rs.ext.WriterInterceptor

aroundWriteTo

Method Details

asyncAroundWriteTo

CompletionStage<Void> asyncAroundWriteTo(AsyncWriterInterceptorContext context)

Interceptor method wrapping calls to AsyncMessageBodyWriter.asyncWriteTo(T, Class, Type, Annotation[], MediaType, MultivaluedMap, AsyncOutputStream) method. The parameters of the wrapped method called are available from context. Implementations of this method SHOULD explicitly call AsyncWriterInterceptorContext.asyncProceed() to invoke the next interceptor in the chain, and ultimately the wrapped AsyncMessageBodyWriter.asyncWriteTo method.

Parameters:

context - invocation context.

Returns:

a CompletionStage indicating completion

Throws:

IOException - if an IO error arises or is thrown by the wrapped AsyncMessageBodyWriter.asyncWriteTo method, in the returned CompletionStage.

jakarta.ws.rs.WebApplicationException - thrown by the wrapped AsyncMessageBodyWriter.asyncWriteTo method, in the returned CompletionStage.