public class GrailsWebRequest extends org.springframework.web.servlet.handler.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()
Modifiers | Name | Description |
---|---|---|
static java.lang.String |
ID_PARAMETER |
Fields inherited from class | Fields |
---|---|
class org.springframework.web.servlet.handler.DispatcherServletWebRequest |
SCOPE_REQUEST, SCOPE_SESSION, REFERENCE_REQUEST, REFERENCE_SESSION, DESTRUCTION_CALLBACK_NAME_PREFIX |
Constructor and description |
---|
GrailsWebRequest
(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, GrailsApplicationAttributes attributes) |
GrailsWebRequest
(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext) |
GrailsWebRequest
(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.ServletContext servletContext, org.springframework.context.ApplicationContext applicationContext) |
Type Params | Return Type | Name and description |
---|---|---|
|
public void |
addParameterListener(ParameterCreationListener creationListener) |
|
public void |
addParametersFrom(java.util.Map previousParams) |
|
public java.lang.String |
getActionName()
|
|
public org.springframework.context.ApplicationContext |
getApplicationContext() Obtains the ApplicationContext object. |
|
public GrailsApplicationAttributes |
getAttributes()
|
|
public java.lang.String |
getBaseUrl() |
|
public java.lang.String |
getContextPath() Returns the context path of the request. |
|
public GrailsControllerClass |
getControllerClass()
|
|
public java.lang.String |
getControllerName()
|
|
public java.lang.String |
getControllerNamespace()
|
|
public javax.servlet.http.HttpServletRequest |
getCurrentRequest()
|
|
public javax.servlet.http.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()
|
|
public java.util.Map |
getParameterMap() Overriden to return the GrailsParameterMap instance, |
|
public GrailsParameterMap |
getParams()
|
|
public org.springframework.beans.PropertyEditorRegistry |
getPropertyEditorRegistry() Obtains the PropertyEditorRegistry instance. |
|
public javax.servlet.ServletContext |
getServletContext()
|
|
public GrailsHttpSession |
getSession()
|
|
public javax.servlet.http.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()
|
|
public boolean |
isSkipFilteringCodec()
|
|
public static GrailsWebRequest |
lookup(javax.servlet.http.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 |
requestCompleted() |
|
public void |
resetParams() Reset params by re-reading & 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(javax.servlet.http.HttpServletRequest multipartRequest) Holds a reference to the org.springframework.web.multipart.MultipartRequest |
|
public void |
setOut(java.io.Writer out)
|
|
public void |
setRenderView(boolean renderView) |
|
public void |
setSkipFilteringCodec(boolean skipCodec) |
|
public void |
setWrappedResponse(javax.servlet.http.HttpServletResponse wrappedResponse) |
Methods inherited from class | Name |
---|---|
class org.springframework.web.servlet.handler.DispatcherServletWebRequest |
org.springframework.web.servlet.handler.DispatcherServletWebRequest#getLocale(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getParameter(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getUserPrincipal(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#isSecure(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getParameterNames(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getContextPath(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getParameterMap(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getParameterValues(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getHeaderNames(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getRemoteUser(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#isUserInRole(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getNativeRequest(java.lang.Class), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getNativeRequest(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getHttpMethod(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getNativeResponse(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getNativeResponse(java.lang.Class), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getHeaderValues(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#checkNotModified(long), org.springframework.web.servlet.handler.DispatcherServletWebRequest#checkNotModified(java.lang.String, long), org.springframework.web.servlet.handler.DispatcherServletWebRequest#checkNotModified(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#isNotModified(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getDescription(boolean), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getHeader(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#toString(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#removeAttribute(java.lang.String, int), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getRequest(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getAttributeNames(int), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getResponse(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getSessionId(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#setAttribute(java.lang.String, java.lang.Object, int), org.springframework.web.servlet.handler.DispatcherServletWebRequest#registerDestructionCallback(java.lang.String, java.lang.Runnable, int), org.springframework.web.servlet.handler.DispatcherServletWebRequest#resolveReference(java.lang.String), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getSessionMutex(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getAttribute(java.lang.String, int), org.springframework.web.servlet.handler.DispatcherServletWebRequest#requestCompleted(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#wait(long, int), org.springframework.web.servlet.handler.DispatcherServletWebRequest#wait(long), org.springframework.web.servlet.handler.DispatcherServletWebRequest#wait(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#equals(java.lang.Object), org.springframework.web.servlet.handler.DispatcherServletWebRequest#hashCode(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#getClass(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#notify(), org.springframework.web.servlet.handler.DispatcherServletWebRequest#notifyAll() |
Obtains the ApplicationContext object.
Returns the context path of the request.
Overriden to return the GrailsParameterMap instance,
Obtains the PropertyEditorRegistry instance.
Informs any parameter creation listeners.
Whether the web request is still active
Returns true if the current executing request is a flow request
Looks up the GrailsWebRequest from the current request.
request
- The current requestLooks up the current Grails WebRequest instance
Reset params by re-reading & initializing parameters from request
Sets the id of the request.
id
- The idHolds a reference to the org.springframework.web.multipart.MultipartRequest
multipartRequest
- The multipart request
out
- the out to set