java.lang.Object
- org.springframework.http.server.ServletServerHttpAsyncRequestControl

All Implemented Interfaces:
EventListener, AsyncListener, ServerHttpAsyncRequestControl
```
public class ServletServerHttpAsyncRequestControl
extends Object
implements ServerHttpAsyncRequestControl, AsyncListener
```
A ServerHttpAsyncRequestControl to use on Servlet containers (Servlet 3.0+).
Since:
4.0
Author:
Rossen Stoyanchev

Constructor Summary

Constructors
Constructor	Description
`ServletServerHttpAsyncRequestControl(ServletServerHttpRequest request, ServletServerHttpResponse response)`	Constructor accepting a request and response pair that are expected to be of type `ServletServerHttpRequest` and `ServletServerHttpResponse` respectively.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`complete()`	Mark asynchronous request processing as completed.
`boolean`	`isCompleted()`	Return whether asynchronous request processing has been completed.
`boolean`	`isStarted()`	Return whether asynchronous request processing has been started.
`void`	`onComplete(AsyncEvent event)`	Notifies this AsyncListener that an asynchronous operation has been completed.
`void`	`onError(AsyncEvent event)`	Notifies this AsyncListener that an asynchronous operation has failed to complete.
`void`	`onStartAsync(AsyncEvent event)`	Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the `ServletRequest.startAsync()` methods.
`void`	`onTimeout(AsyncEvent event)`	Notifies this AsyncListener that an asynchronous operation has timed out.
`void`	`start()`	Enable asynchronous processing after which the response remains open until a call to `ServerHttpAsyncRequestControl.complete()` is made or the server times out the request.
`void`	`start(long timeout)`	A variation on `ServerHttpAsyncRequestControl.start()` that allows specifying a timeout value to use to use for asynchronous processing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServletServerHttpAsyncRequestControl
```
public ServletServerHttpAsyncRequestControl(ServletServerHttpRequest request,
                                            ServletServerHttpResponse response)
```
    Constructor accepting a request and response pair that are expected to be of type ServletServerHttpRequest and ServletServerHttpResponse respectively.
- Method Detail
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: ServerHttpAsyncRequestControl
    Return whether asynchronous request processing has been started.
    Specified by:
    isStarted in interface ServerHttpAsyncRequestControl
  - isCompleted
```
public boolean isCompleted()
```
    Description copied from interface: ServerHttpAsyncRequestControl
    Return whether asynchronous request processing has been completed.
    Specified by:
    isCompleted in interface ServerHttpAsyncRequestControl
  - start
```
public void start()
```
    Description copied from interface: ServerHttpAsyncRequestControl
    Enable asynchronous processing after which the response remains open until a call to ServerHttpAsyncRequestControl.complete() is made or the server times out the request. Once enabled, additional calls to this method are ignored.
    Specified by:
    start in interface ServerHttpAsyncRequestControl
  - start
```
public void start(long timeout)
```
    Description copied from interface: ServerHttpAsyncRequestControl
    A variation on ServerHttpAsyncRequestControl.start() that allows specifying a timeout value to use to use for asynchronous processing. If ServerHttpAsyncRequestControl.complete() is not called within the specified value, the request times out.
    Specified by:
    start in interface ServerHttpAsyncRequestControl
  - complete
```
public void complete()
```
    Description copied from interface: ServerHttpAsyncRequestControl
    Mark asynchronous request processing as completed.
    Specified by:
    complete in interface ServerHttpAsyncRequestControl
  - onComplete
```
public void onComplete(AsyncEvent event)
                throws IOException
```
    Description copied from interface: javax.servlet.AsyncListener
    Notifies this AsyncListener that an asynchronous operation has been completed.
    The AsyncContext corresponding to the asynchronous operation that has been completed may be obtained by calling getAsyncContext on the given event.
    In addition, if this AsyncListener had been registered via a call to AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling getSuppliedRequest and getSuppliedResponse, respectively, on the given event.
    Specified by:
    onComplete in interface AsyncListener
    Parameters:
    event - the AsyncEvent indicating that an asynchronous operation has been completed
    Throws:
    IOException - if an I/O related error has occurred during the processing of the given AsyncEvent
  - onStartAsync
```
public void onStartAsync(AsyncEvent event)
                  throws IOException
```
    Description copied from interface: javax.servlet.AsyncListener
    Notifies this AsyncListener that a new asynchronous cycle is being initiated via a call to one of the ServletRequest.startAsync() methods.
    The AsyncContext corresponding to the asynchronous operation that is being reinitialized may be obtained by calling getAsyncContext on the given event.
    In addition, if this AsyncListener had been registered via a call to AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling getSuppliedRequest and getSuppliedResponse, respectively, on the given event.
    This AsyncListener will not receive any events related to the new asynchronous cycle unless it registers itself (via a call to AsyncContext.addListener(javax.servlet.AsyncListener)) with the AsyncContext that is delivered as part of the given AsyncEvent.
    Specified by:
    onStartAsync in interface AsyncListener
    Parameters:
    event - the AsyncEvent indicating that a new asynchronous cycle is being initiated
    Throws:
    IOException - if an I/O related error has occurred during the processing of the given AsyncEvent
  - onError
```
public void onError(AsyncEvent event)
             throws IOException
```
    Description copied from interface: javax.servlet.AsyncListener
    Notifies this AsyncListener that an asynchronous operation has failed to complete.
    The AsyncContext corresponding to the asynchronous operation that failed to complete may be obtained by calling getAsyncContext on the given event.
    In addition, if this AsyncListener had been registered via a call to AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling getSuppliedRequest and getSuppliedResponse, respectively, on the given event.
    Specified by:
    onError in interface AsyncListener
    Parameters:
    event - the AsyncEvent indicating that an asynchronous operation has failed to complete
    Throws:
    IOException - if an I/O related error has occurred during the processing of the given AsyncEvent
  - onTimeout
```
public void onTimeout(AsyncEvent event)
               throws IOException
```
    Description copied from interface: javax.servlet.AsyncListener
    Notifies this AsyncListener that an asynchronous operation has timed out.
    The AsyncContext corresponding to the asynchronous operation that has timed out may be obtained by calling getAsyncContext on the given event.
    In addition, if this AsyncListener had been registered via a call to AsyncContext.addListener(AsyncListener, ServletRequest, ServletResponse), the supplied ServletRequest and ServletResponse objects may be retrieved by calling getSuppliedRequest and getSuppliedResponse, respectively, on the given event.
    Specified by:
    onTimeout in interface AsyncListener
    Parameters:
    event - the AsyncEvent indicating that an asynchronous operation has timed out
    Throws:
    IOException - if an I/O related error has occurred during the processing of the given AsyncEvent

Class ServletServerHttpAsyncRequestControl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServletServerHttpAsyncRequestControl

Method Detail

isStarted

isCompleted

start

start

complete

onComplete

onStartAsync

onError

onTimeout