AsyncGrailsWebRequest (Grails 7.0.1)

grails.async.web.AsyncGrailsWebRequest

All Implemented Interfaces and Traits:

AsyncListener, AsyncWebRequest
```
@groovy.transform.CompileStatic
class AsyncGrailsWebRequest
extends GrailsWebRequest
implements AsyncListener, AsyncWebRequest
```
Implementation of Spring 4.0 AsyncWebRequest interface for Grails
Authors:
Graeme Rocher
Since:
3.0

Inherited fields
Fields inherited from class	Fields
`class GrailsWebRequest`	`ID_PARAMETER`

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`WEB_REQUEST`
`AsyncContext`	`asyncContext`
`java.util.List<java.lang.Runnable>`	`completionHandlers`
`java.util.List<java.util.function.Consumer<java.lang.Throwable>>`	`exceptionHandlers`
`java.lang.Long`	`timeout`
`java.util.List<java.lang.Runnable>`	`timeoutHandlers`

Constructor Summary

Constructors
Constructor and description
`AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, GrailsApplicationAttributes attributes)`
`AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)`
`AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, ApplicationContext applicationContext)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addCompletionHandler(java.lang.Runnable runnable)`
	`void`	`addErrorHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)`
	`void`	`addTimeoutHandler(java.lang.Runnable runnable)`
	`void`	`dispatch()`
	`boolean`	`isAsyncComplete()`
	`boolean`	`isAsyncStarted()`
	`static AsyncGrailsWebRequest`	`lookup(HttpServletRequest request)` Looks up the GrailsWebRequest from the current request.
	`void`	`onComplete(AsyncEvent event)`
	`void`	`onError(AsyncEvent event)`
	`void`	`onStartAsync(AsyncEvent event)`
	`void`	`onTimeout(AsyncEvent event)`
	`void`	`startAsync()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GrailsWebRequest`	addParameterListener, addParametersFrom, getActionName, getApplicationContext, getAttributes, getBaseUrl, getContextPath, getControllerClass, getControllerName, getControllerNamespace, getCurrentRequest, getCurrentResponse, getEncodingStateRegistry, getFilteringCodec, getFilteringEncoder, getFlashScope, getId, getOriginalParams, getOut, getParameterMap, getParams, getPropertyEditorRegistry, getServletContext, getSession, getWrappedResponse, informParameterCreationListeners, isActive, isFlowRequest, isRenderView, isSkipFilteringCodec, lookup, lookup, lookupFilteringEncoder, requestCompleted, resetParams, setActionName, setControllerName, setControllerNamespace, setFilteringCodec, setFilteringEncoder, setId, setMultipartRequest, setOut, setRenderView, setSkipFilteringCodec, setWrappedResponse

- Property Detail
  - static final java.lang.String WEB_REQUEST
  - AsyncContext asyncContext
  - java.util.List<java.lang.Runnable> completionHandlers
  - java.util.List<java.util.function.Consumer<java.lang.Throwable>> exceptionHandlers
  - java.lang.Long timeout
  - java.util.List<java.lang.Runnable> timeoutHandlers
- Constructor Detail
  - AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, GrailsApplicationAttributes attributes)
  - AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
  - AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, ApplicationContext applicationContext)
- Method Detail
  - @java.lang.Override
    void addCompletionHandler(java.lang.Runnable runnable)
  - @java.lang.Override
    void addErrorHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)
  - @java.lang.Override
    void addTimeoutHandler(java.lang.Runnable runnable)
  - @java.lang.Override
    void dispatch()
  - @java.lang.Override
    boolean isAsyncComplete()
  - @java.lang.Override
    boolean isAsyncStarted()
  - static AsyncGrailsWebRequest lookup(HttpServletRequest request)
    
    Looks up the GrailsWebRequest from the current request.
    Parameters:
    request - The current request
    Returns:
    The GrailsWebRequest
  - @java.lang.Override
    void onComplete(AsyncEvent event)
  - @java.lang.Override
    void onError(AsyncEvent event)
  - @java.lang.Override
    void onStartAsync(AsyncEvent event)
  - @java.lang.Override
    void onTimeout(AsyncEvent event)
  - @java.lang.Override
    void startAsync()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AsyncGrailsWebRequest

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String WEB_REQUEST

AsyncContext asyncContext

java.util.List<java.lang.Runnable> completionHandlers

java.util.List<java.util.function.Consumer<java.lang.Throwable>> exceptionHandlers

java.lang.Long timeout

java.util.List<java.lang.Runnable> timeoutHandlers

Constructor Detail

AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, GrailsApplicationAttributes attributes)

AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)

AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, ApplicationContext applicationContext)

Method Detail

@java.lang.Override
void addCompletionHandler(java.lang.Runnable runnable)

@java.lang.Override
void addErrorHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)

@java.lang.Override
void addTimeoutHandler(java.lang.Runnable runnable)

@java.lang.Override
void dispatch()

@java.lang.Override
boolean isAsyncComplete()

@java.lang.Override
boolean isAsyncStarted()

static AsyncGrailsWebRequest lookup(HttpServletRequest request)

@java.lang.Override
void onComplete(AsyncEvent event)

@java.lang.Override
void onError(AsyncEvent event)

@java.lang.Override
void onStartAsync(AsyncEvent event)

@java.lang.Override
void onTimeout(AsyncEvent event)

@java.lang.Override
void startAsync()

[Groovy] Class AsyncGrailsWebRequest

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.String WEB_REQUEST

AsyncContext asyncContext

java.util.List<java.lang.Runnable> completionHandlers

java.util.List<java.util.function.Consumer<java.lang.Throwable>> exceptionHandlers

java.lang.Long timeout

java.util.List<java.lang.Runnable> timeoutHandlers

Constructor Detail

AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, GrailsApplicationAttributes attributes)

AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)

AsyncGrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, ApplicationContext applicationContext)

Method Detail

@java.lang.Overridevoid addCompletionHandler(java.lang.Runnable runnable)

@java.lang.Overridevoid addErrorHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)

@java.lang.Overridevoid addTimeoutHandler(java.lang.Runnable runnable)

@java.lang.Overridevoid dispatch()

@java.lang.Overrideboolean isAsyncComplete()

@java.lang.Overrideboolean isAsyncStarted()

static AsyncGrailsWebRequest lookup(HttpServletRequest request)

@java.lang.Overridevoid onComplete(AsyncEvent event)

@java.lang.Overridevoid onError(AsyncEvent event)

@java.lang.Overridevoid onStartAsync(AsyncEvent event)

@java.lang.Overridevoid onTimeout(AsyncEvent event)

@java.lang.Overridevoid startAsync()

@java.lang.Override
void addCompletionHandler(java.lang.Runnable runnable)

@java.lang.Override
void addErrorHandler(java.util.function.Consumer<java.lang.Throwable> exceptionHandler)

@java.lang.Override
void addTimeoutHandler(java.lang.Runnable runnable)

@java.lang.Override
void dispatch()

@java.lang.Override
boolean isAsyncComplete()

@java.lang.Override
boolean isAsyncStarted()

@java.lang.Override
void onComplete(AsyncEvent event)

@java.lang.Override
void onError(AsyncEvent event)

@java.lang.Override
void onStartAsync(AsyncEvent event)

@java.lang.Override
void onTimeout(AsyncEvent event)

@java.lang.Override
void startAsync()