GrailsWebRequest (Grails 8.0.0)

org.grails.web.servlet.mvc.GrailsWebRequest

```
public class GrailsWebRequest
extends DispatcherServletWebRequest
```
Encapsulates a Grails request. An instance of this class is bound to the current thread using Spring's RequestContextHolder which can later be retrieved using: def webRequest = RequestContextHolder.currentRequestAttributes()
The request this exposes through getRequest() is always the outermost request, so wrappers contributed by other filters keep working. Multipart capabilities are discovered from its wrapper chain rather than by substituting the request - see WebUtils.resolveMultipartRequest.
Authors:
Graeme Rocher
Since:
3.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`ID_PARAMETER`

Inherited fields
Fields inherited from class	Fields
`class DispatcherServletWebRequest`	`SCOPE_REQUEST, SCOPE_SESSION, REFERENCE_REQUEST, REFERENCE_SESSION, DESTRUCTION_CALLBACK_NAME_PREFIX`

Constructor Summary

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

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`addParameterListener(ParameterCreationListener creationListener)`
	`public void`	`addParametersFrom(java.util.Map previousParams)`
	`public java.lang.String`	`getActionName()` Returns: the actionName
	`public ApplicationContext`	`getApplicationContext()` Obtains the ApplicationContext object.
	`public GrailsApplicationAttributes`	`getAttributes()` Returns: The GrailsApplicationAttributes instance
	`public java.lang.String`	`getBaseUrl()`
	`public java.lang.String`	`getContextPath()` Returns the context path of the request.
	`public GrailsControllerClass`	`getControllerClass()` Returns: the controllerClass
	`public java.lang.String`	`getControllerName()` Returns: the controllerName
	`public java.lang.String`	`getControllerNamespace()` Returns: the controllerNamespace
	`public HttpServletRequest`	`getCurrentRequest()` Returns: The currently executing request
	`public HttpServletResponse`	`getCurrentResponse()`
	`public EncodingStateRegistry`	`getEncodingStateRegistry()`
	`public java.lang.String`	`getFilteringCodec()`
	`public Encoder`	`getFilteringEncoder()`
	`public FlashScope`	`getFlashScope()` Returns: The FlashScope instance for the current request
	`public java.lang.String`	`getId()`
	`public GrailsParameterMap`	`getOriginalParams()` Returns: The Grails params object
	`public java.io.Writer`	`getOut()` Returns: the out
	`public java.util.Map`	`getParameterMap()` Overriden to return the GrailsParameterMap instance,
	`public GrailsParameterMap`	`getParams()` Returns: The Grails params object
	`public PropertyEditorRegistry`	`getPropertyEditorRegistry()` Obtains the PropertyEditorRegistry instance.
	`public ServletContext`	`getServletContext()` Returns: The ServletContext instance
	`public GrailsHttpSession`	`getSession()` Returns: The Grails session object
	`public HttpServletResponse`	`getWrappedResponse()`
	`public void`	`informParameterCreationListeners()` Informs any parameter creation listeners.
	`public boolean`	`isActive()` Whether the web request is still active
	`public boolean`	`isFlowRequest()` Returns true if the current executing request is a flow request
	`public boolean`	`isRenderView()` Returns: true if the view for this GrailsWebRequest should be rendered
	`public boolean`	`isSkipFilteringCodec()` Returns: true if grails.views.filteringCodecForMimeType settings should be ignored for this request
	`public static GrailsWebRequest`	`lookup(HttpServletRequest request)` Looks up the GrailsWebRequest from the current request.
	`public static GrailsWebRequest`	`lookup()` Looks up the current Grails WebRequest instance
	`public Encoder`	`lookupFilteringEncoder()`
	`public void`	`multipartRequestResolved()` Discards the cached params so they are rebuilt and pick up uploaded files, for when multipart resolution happens after params were already read.
	`public void`	`requestCompleted()`
	`public void`	`resetParams()` Reset params by re-reading and initializing parameters from request
	`public void`	`setActionName(java.lang.String actionName)`
	`public void`	`setControllerName(java.lang.String controllerName)`
	`public void`	`setControllerNamespace(java.lang.String controllerNamespace)`
	`public void`	`setFilteringCodec(java.lang.String codecName)`
	`public void`	`setFilteringEncoder(Encoder filteringEncoder)`
	`public void`	`setId(java.lang.Object id)` Sets the id of the request.
	`public void`	`setMultipartRequest(HttpServletRequest multipartRequest)` Parameters: `multipartRequest` - the resolved multipart request
	`public void`	`setOut(java.io.Writer out)` Parameters: `out` - the out to set
	`public void`	`setRenderView(boolean renderView)`
	`public void`	`setSkipFilteringCodec(boolean skipCodec)`
	`public void`	`setWrappedResponse(HttpServletResponse wrappedResponse)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class DispatcherServletWebRequest`	checkNotModified, checkNotModified, checkNotModified, equals, getAttribute, getAttributeNames, getClass, getContextPath, getDescription, getHeader, getHeaderNames, getHeaderValues, getHttpMethod, getLocale, getNativeRequest, getNativeRequest, getNativeResponse, getNativeResponse, getParameter, getParameterMap, getParameterNames, getParameterValues, getRemoteUser, getRequest, getResponse, getSessionId, getSessionMutex, getUserPrincipal, hashCode, isNotModified, isSecure, isUserInRole, notify, notifyAll, registerDestructionCallback, removeAttribute, requestCompleted, resolveReference, setAttribute, toString, wait, wait, wait

- Field Detail
  - public static final java.lang.String ID_PARAMETER
- Constructor Detail
  - public GrailsWebRequest(HttpServletRequest request, HttpServletResponse response, GrailsApplicationAttributes attributes)
  - public GrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)
  - public GrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, ApplicationContext applicationContext)
- Method Detail
  - public void addParameterListener(ParameterCreationListener creationListener)
  - @java.lang.SuppressWarnings("rawtypes")
    public void addParametersFrom(java.util.Map previousParams)
  - public java.lang.String getActionName()
    
    Returns:
    the actionName
  - public ApplicationContext getApplicationContext()
    
    Obtains the ApplicationContext object.
    Returns:
    The ApplicationContext
  - public GrailsApplicationAttributes getAttributes()
    
    Returns:
    The GrailsApplicationAttributes instance
  - public java.lang.String getBaseUrl()
  - @java.lang.Override
    public java.lang.String getContextPath()
    
    Returns the context path of the request.
    Returns:
    the path
  - public GrailsControllerClass getControllerClass()
    
    Returns:
    the controllerClass
  - public java.lang.String getControllerName()
    
    Returns:
    the controllerName
  - public java.lang.String getControllerNamespace()
    
    Returns:
    the controllerNamespace
  - public HttpServletRequest getCurrentRequest()
    
    Returns:
    The currently executing request
    This used to return the resolved multipart request in place of the request Grails was bound to. That substitution is gone, so this and getRequest() are the same object; either may be called.
  - public HttpServletResponse getCurrentResponse()
  - public EncodingStateRegistry getEncodingStateRegistry()
  - public java.lang.String getFilteringCodec()
  - public Encoder getFilteringEncoder()
  - public FlashScope getFlashScope()
    
    Returns:
    The FlashScope instance for the current request
  - public java.lang.String getId()
  - public GrailsParameterMap getOriginalParams()
    
    Returns:
    The Grails params object
  - public java.io.Writer getOut()
    
    Returns:
    the out
  - @java.lang.Override
    @java.lang.SuppressWarnings({ "unchecked", "rawtypes" })
    public java.util.Map getParameterMap()
    
    Overriden to return the GrailsParameterMap instance,
    Returns:
    An instance of GrailsParameterMap
  - public GrailsParameterMap getParams()
    
    Returns:
    The Grails params object
  - public PropertyEditorRegistry getPropertyEditorRegistry()
    
    Obtains the PropertyEditorRegistry instance.
    Returns:
    The PropertyEditorRegistry
  - public ServletContext getServletContext()
    
    Returns:
    The ServletContext instance
  - public GrailsHttpSession getSession()
    
    Returns:
    The Grails session object
  - public HttpServletResponse getWrappedResponse()
  - public void informParameterCreationListeners()
    
    Informs any parameter creation listeners.
  - public boolean isActive()
    
    Whether the web request is still active
    Returns:
    true if it is
  - public boolean isFlowRequest()
    
    Returns true if the current executing request is a flow request
    Returns:
    true if it is a flow request
  - public boolean isRenderView()
    
    Returns:
    true if the view for this GrailsWebRequest should be rendered
  - public boolean isSkipFilteringCodec()
    
    Returns:
    true if grails.views.filteringCodecForMimeType settings should be ignored for this request
  - @org.jspecify.annotations.Nullable
    public static GrailsWebRequest lookup(HttpServletRequest request)
    
    Looks up the GrailsWebRequest from the current request.
    Parameters:
    request - The current request
    Returns:
    The GrailsWebRequest
  - @org.jspecify.annotations.Nullable
    public static GrailsWebRequest lookup()
    
    Looks up the current Grails WebRequest instance
    Returns:
    The GrailsWebRequest instance
  - public Encoder lookupFilteringEncoder()
  - public void multipartRequestResolved()
    
    Discards the cached params so they are rebuilt and pick up uploaded files, for when multipart resolution happens after params were already read. See gh-13837.
    Since:
    8.0
  - @java.lang.Override
    public void requestCompleted()
  - public void resetParams()
    
    Reset params by re-reading and initializing parameters from request
  - public void setActionName(java.lang.String actionName)
  - public void setControllerName(java.lang.String controllerName)
  - public void setControllerNamespace(java.lang.String controllerNamespace)
  - public void setFilteringCodec(java.lang.String codecName)
  - public void setFilteringEncoder(Encoder filteringEncoder)
  - public void setId(java.lang.Object id)
    
    Sets the id of the request.
    Parameters:
    id - The id
  - @java.lang.Deprecated(since = "8.0")
    public void setMultipartRequest(HttpServletRequest multipartRequest)
    
    deprecated:
    as of 8.0, use multipartRequestResolved() instead. Grails no longer holds the resolved multipart request in place of the request it was bound to; the resolver publishes it as WebUtils.MULTIPART_HTTP_SERVLET_REQUEST_ATTRIBUTE and it is found from there or by unwrapping. This publishes the argument on the current request and discards the cached params, so an existing caller keeps working.
    
    Parameters:
    multipartRequest - the resolved multipart request
  - public void setOut(java.io.Writer out)
    
    Parameters:
    out - the out to set
  - public void setRenderView(boolean renderView)
  - public void setSkipFilteringCodec(boolean skipCodec)
  - public void setWrappedResponse(HttpServletResponse wrappedResponse)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class GrailsWebRequest

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String ID_PARAMETER

Constructor Detail

public GrailsWebRequest(HttpServletRequest request, HttpServletResponse response, GrailsApplicationAttributes attributes)

public GrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext)

public GrailsWebRequest(HttpServletRequest request, HttpServletResponse response, ServletContext servletContext, ApplicationContext applicationContext)

Method Detail

public void addParameterListener(ParameterCreationListener creationListener)

@java.lang.SuppressWarnings("rawtypes")public void addParametersFrom(java.util.Map previousParams)

public java.lang.String getActionName()

public ApplicationContext getApplicationContext()

public GrailsApplicationAttributes getAttributes()

public java.lang.String getBaseUrl()

@java.lang.Overridepublic java.lang.String getContextPath()

public GrailsControllerClass getControllerClass()

public java.lang.String getControllerName()

public java.lang.String getControllerNamespace()

public HttpServletRequest getCurrentRequest()

public HttpServletResponse getCurrentResponse()

public EncodingStateRegistry getEncodingStateRegistry()

public java.lang.String getFilteringCodec()

public Encoder getFilteringEncoder()

public FlashScope getFlashScope()

public java.lang.String getId()

public GrailsParameterMap getOriginalParams()

public java.io.Writer getOut()

@java.lang.Override@java.lang.SuppressWarnings({ "unchecked", "rawtypes" })public java.util.Map getParameterMap()

public GrailsParameterMap getParams()

public PropertyEditorRegistry getPropertyEditorRegistry()

public ServletContext getServletContext()

public GrailsHttpSession getSession()

public HttpServletResponse getWrappedResponse()

public void informParameterCreationListeners()

public boolean isActive()

public boolean isFlowRequest()

public boolean isRenderView()

public boolean isSkipFilteringCodec()

@org.jspecify.annotations.Nullablepublic static GrailsWebRequest lookup(HttpServletRequest request)

@org.jspecify.annotations.Nullablepublic static GrailsWebRequest lookup()

public Encoder lookupFilteringEncoder()

public void multipartRequestResolved()

@java.lang.Overridepublic void requestCompleted()

public void resetParams()

public void setActionName(java.lang.String actionName)

public void setControllerName(java.lang.String controllerName)

public void setControllerNamespace(java.lang.String controllerNamespace)

public void setFilteringCodec(java.lang.String codecName)

public void setFilteringEncoder(Encoder filteringEncoder)

public void setId(java.lang.Object id)

@java.lang.Deprecated(since = "8.0")public void setMultipartRequest(HttpServletRequest multipartRequest)

public void setOut(java.io.Writer out)

public void setRenderView(boolean renderView)

public void setSkipFilteringCodec(boolean skipCodec)

public void setWrappedResponse(HttpServletResponse wrappedResponse)

@java.lang.SuppressWarnings("rawtypes")
public void addParametersFrom(java.util.Map previousParams)

@java.lang.Override
public java.lang.String getContextPath()

@java.lang.Override
@java.lang.SuppressWarnings({ "unchecked", "rawtypes" })
public java.util.Map getParameterMap()

@org.jspecify.annotations.Nullable
public static GrailsWebRequest lookup(HttpServletRequest request)

@org.jspecify.annotations.Nullable
public static GrailsWebRequest lookup()

@java.lang.Override
public void requestCompleted()

@java.lang.Deprecated(since = "8.0")
public void setMultipartRequest(HttpServletRequest multipartRequest)