org.glassfish.jersey.servlet.spi

Interface AsyncContextDelegate

public interface AsyncContextDelegate

Utilized by the Servlet container response writer to deal with the container async features. Individual instances are created by AsyncContextDelegateProvider.

Author:

Jakub Podlesak

See Also:

AsyncContextDelegateProvider

Method Summary

Modifier and Type	Method and Description
void	complete() Invoked upon a response writing completion when the response write is either committed or canceled.
default boolean	isCompleted() Return true when the AsyncContext is completed, such as when complete() has been called.
void	suspend() Invoked by the superior ContainerResponseWriter responsible for writing the response when processing is to be suspended.

Method Detail

suspend

void suspend()
      throws IllegalStateException

Invoked by the superior ContainerResponseWriter responsible for writing the response when processing is to be suspended. An implementation can throw an UnsupportedOperationException if suspend is not supported (the default behavior).

Throws:

IllegalStateException - if underlying servlet request throws an exception.

See Also:

ContainerResponseWriter.suspend(long, java.util.concurrent.TimeUnit, org.glassfish.jersey.server.spi.ContainerResponseWriter.TimeoutHandler)

complete

void complete()

Invoked upon a response writing completion when the response write is either committed or canceled.

isCompleted

default boolean isCompleted()

Return true when the AsyncContext is completed, such as when complete() has been called.

For compatibility, the default is false.

Returns:

true when the AsyncContext is completed.