Package org.grails.web.servlet.mvc

Class GrailsWebRequest

  • All Implemented Interfaces:
    org.springframework.web.context.request.NativeWebRequest, org.springframework.web.context.request.RequestAttributes, org.springframework.web.context.request.WebRequest
    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()
    Since:
    3.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ID_PARAMETER  

      • Fields inherited from class org.springframework.web.context.request.ServletRequestAttributes

        DESTRUCTION_CALLBACK_NAME_PREFIX, immutableValueTypes

      • Fields inherited from class org.springframework.web.context.request.AbstractRequestAttributes

        requestDestructionCallbacks

      • Fields inherited from interface org.springframework.web.context.request.RequestAttributes

        REFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_REQUEST, SCOPE_SESSION

    • Constructor Summary

      Constructors 
      Constructor Description
      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)  
      GrailsWebRequest​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, GrailsApplicationAttributes attributes)  

    • Constructor Detail

      • GrailsWebRequest

        public GrailsWebRequest​(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        GrailsApplicationAttributes attributes)

      • GrailsWebRequest

        public GrailsWebRequest​(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        javax.servlet.ServletContext servletContext)

      • GrailsWebRequest

        public GrailsWebRequest​(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        javax.servlet.ServletContext servletContext,
                        org.springframework.context.ApplicationContext applicationContext)

    • Method Detail

      • setMultipartRequest

        public void setMultipartRequest​(javax.servlet.http.HttpServletRequest multipartRequest)
        Holds a reference to the MultipartRequest
        Parameters:
        multipartRequest - The multipart request

      • getParameterMap

        public java.util.Map getParameterMap()
        Overriden to return the GrailsParameterMap instance,
        Specified by:
        getParameterMap in interface org.springframework.web.context.request.WebRequest
        Overrides:
        getParameterMap in class org.springframework.web.context.request.ServletWebRequest
        Returns:
        An instance of GrailsParameterMap

      • requestCompleted

        public void requestCompleted()
        Overrides:
        requestCompleted in class org.springframework.web.context.request.AbstractRequestAttributes

      • getOut

        public java.io.Writer getOut()
        Returns:
        the out

      • isActive

        public boolean isActive()
        Whether the web request is still active
        Returns:
        true if it is

      • setOut

        public void setOut​(java.io.Writer out)
        Parameters:
        out - the out to set

      • getServletContext

        public javax.servlet.ServletContext getServletContext()
        Returns:
        The ServletContext instance

      • getContextPath

        public java.lang.String getContextPath()
        Returns the context path of the request.
        Specified by:
        getContextPath in interface org.springframework.web.context.request.WebRequest
        Overrides:
        getContextPath in class org.springframework.web.context.request.ServletWebRequest
        Returns:
        the path

      • getFlashScope

        public FlashScope getFlashScope()
        Returns:
        The FlashScope instance for the current request

      • getCurrentRequest

        public javax.servlet.http.HttpServletRequest getCurrentRequest()
        Returns:
        The currently executing request

      • getCurrentResponse

        public javax.servlet.http.HttpServletResponse getCurrentResponse()

      • getWrappedResponse

        public javax.servlet.http.HttpServletResponse getWrappedResponse()

      • setWrappedResponse

        public void setWrappedResponse​(javax.servlet.http.HttpServletResponse wrappedResponse)

      • getOriginalParams

        public GrailsParameterMap getOriginalParams()
        Returns:
        The Grails params object

      • resetParams

        public void resetParams()
        Reset params by re-reading and initializing parameters from request

      • addParametersFrom

        public void addParametersFrom​(java.util.Map previousParams)

      • informParameterCreationListeners

        public void informParameterCreationListeners()
        Informs any parameter creation listeners.

      • getSession

        public GrailsHttpSession getSession()
        Returns:
        The Grails session object

      • setActionName

        public void setActionName​(java.lang.String actionName)

      • setControllerName

        public void setControllerName​(java.lang.String controllerName)

      • setControllerNamespace

        public void setControllerNamespace​(java.lang.String controllerNamespace)

      • getActionName

        public java.lang.String getActionName()
        Returns:
        the actionName

      • getControllerName

        public java.lang.String getControllerName()
        Returns:
        the controllerName

      • getControllerClass

        public grails.core.GrailsControllerClass getControllerClass()
        Returns:
        the controllerClass

      • getControllerNamespace

        public java.lang.String getControllerNamespace()
        Returns:
        the controllerNamespace

      • setRenderView

        public void setRenderView​(boolean renderView)

      • isRenderView

        public boolean isRenderView()
        Returns:
        true if the view for this GrailsWebRequest should be rendered

      • getId

        public java.lang.String getId()

      • isFlowRequest

        public boolean isFlowRequest()
        Returns true if the current executing request is a flow request
        Returns:
        true if it is a flow request

      • getApplicationContext

        public org.springframework.context.ApplicationContext getApplicationContext()
        Obtains the ApplicationContext object.
        Returns:
        The ApplicationContext

      • getPropertyEditorRegistry

        public org.springframework.beans.PropertyEditorRegistry getPropertyEditorRegistry()
        Obtains the PropertyEditorRegistry instance.
        Returns:
        The PropertyEditorRegistry

      • lookup

        @Nullable
public static GrailsWebRequest lookup​(javax.servlet.http.HttpServletRequest request)
        Looks up the GrailsWebRequest from the current request.
        Parameters:
        request - The current request
        Returns:
        The GrailsWebRequest

      • lookup

        @Nullable
public static GrailsWebRequest lookup()
        Looks up the current Grails WebRequest instance
        Returns:
        The GrailsWebRequest instance

      • setId

        public void setId​(java.lang.Object id)
        Sets the id of the request.
        Parameters:
        id - The id

      • getBaseUrl

        public java.lang.String getBaseUrl()

      • getEncodingStateRegistry

        public org.grails.encoder.EncodingStateRegistry getEncodingStateRegistry()

      • isSkipFilteringCodec

        public boolean isSkipFilteringCodec()
        Returns:
        true if grails.views.filteringCodecForMimeType settings should be ignored for this request

      • setSkipFilteringCodec

        public void setSkipFilteringCodec​(boolean skipCodec)

      • getFilteringCodec

        public java.lang.String getFilteringCodec()

      • setFilteringCodec

        public void setFilteringCodec​(java.lang.String codecName)

      • lookupFilteringEncoder

        public org.grails.encoder.Encoder lookupFilteringEncoder()

      • getFilteringEncoder

        public org.grails.encoder.Encoder getFilteringEncoder()

      • setFilteringEncoder

        public void setFilteringEncoder​(org.grails.encoder.Encoder filteringEncoder)