AsyncGrailsWebRequest (Grails 7.0.0-SNAPSHOT)

grails.async.web.AsyncGrailsWebRequest

All Implemented Interfaces and Traits:

org.springframework.web.context.request.async.AsyncWebRequest, jakarta.servlet.AsyncListener
```
@groovy.transform.CompileStatic
class AsyncGrailsWebRequest
extends GrailsWebRequest
implements org.springframework.web.context.request.async.AsyncWebRequest, jakarta.servlet.AsyncListener
```
Implementation of Spring 4.0 org.springframework.web.context.request.async.AsyncWebRequest interface for Grails
Authors:
Graeme Rocher
Since:
3.0

Field Summary

Fields
Modifiers	Name	Description
`private java.util.concurrent.atomic.AtomicBoolean`	`asyncCompleted`

Inherited fields
Fields inherited from class	Fields
`class GrailsWebRequest`	`ID_PARAMETER, REDIRECT_CALLED, applicationContext, attributes, baseUrl, encodingStateRegistry, filteringEncoder, grailsApplicationAttributesClass, grailsApplicationAttributesConstructor, multipartRequest, originalParams, parameterCreationListeners, params, renderView, session, skipFilteringCodec, urlHelper, wrappedResponse`

Properties Summary

Properties
Type	Name and description
`static java.lang.String`	`WEB_REQUEST`
`jakarta.servlet.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(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, GrailsApplicationAttributes attributes)`
`AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext)`
`AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext, org.springframework.context.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(jakarta.servlet.http.HttpServletRequest request)` Looks up the GrailsWebRequest from the current request.
	`void`	`onComplete(jakarta.servlet.AsyncEvent event)`
	`void`	`onError(jakarta.servlet.AsyncEvent event)`
	`void`	`onStartAsync(jakarta.servlet.AsyncEvent event)`
	`void`	`onTimeout(jakarta.servlet.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, inheritEncodingStateRegistry, isActive, isFlowRequest, isRenderView, isSkipFilteringCodec, lookup, lookup, lookupFilteringEncoder, requestCompleted, resetParams, setActionName, setControllerName, setControllerNamespace, setFilteringCodec, setFilteringEncoder, setId, setMultipartRequest, setOut, setRenderView, setSkipFilteringCodec, setWrappedResponse

- Field Detail
  - private java.util.concurrent.atomic.AtomicBoolean asyncCompleted
- Property Detail
  - static final java.lang.String WEB_REQUEST
  - jakarta.servlet.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(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, GrailsApplicationAttributes attributes)
  - AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext)
  - AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext, org.springframework.context.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(jakarta.servlet.http.HttpServletRequest request)
    
    Looks up the GrailsWebRequest from the current request.
    Parameters:
    request - The current request
    Returns:
    The GrailsWebRequest
  - @java.lang.Override
    void onComplete(jakarta.servlet.AsyncEvent event)
  - @java.lang.Override
    void onError(jakarta.servlet.AsyncEvent event)
  - @java.lang.Override
    void onStartAsync(jakarta.servlet.AsyncEvent event)
  - @java.lang.Override
    void onTimeout(jakarta.servlet.AsyncEvent event)
  - @java.lang.Override
    void startAsync()

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AsyncGrailsWebRequest

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private java.util.concurrent.atomic.AtomicBoolean asyncCompleted

Property Detail

static final java.lang.String WEB_REQUEST

jakarta.servlet.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(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, GrailsApplicationAttributes attributes)

AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext)

AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext, org.springframework.context.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(jakarta.servlet.http.HttpServletRequest request)

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

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

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

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

@java.lang.Override
void startAsync()

[Groovy] Class AsyncGrailsWebRequest

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private java.util.concurrent.atomic.AtomicBoolean asyncCompleted

Property Detail

static final java.lang.String WEB_REQUEST

jakarta.servlet.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(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, GrailsApplicationAttributes attributes)

AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext)

AsyncGrailsWebRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext, org.springframework.context.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(jakarta.servlet.http.HttpServletRequest request)

@java.lang.Overridevoid onComplete(jakarta.servlet.AsyncEvent event)

@java.lang.Overridevoid onError(jakarta.servlet.AsyncEvent event)

@java.lang.Overridevoid onStartAsync(jakarta.servlet.AsyncEvent event)

@java.lang.Overridevoid onTimeout(jakarta.servlet.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(jakarta.servlet.AsyncEvent event)

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

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

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

@java.lang.Override
void startAsync()