Class AbstractRequest

  • Direct Known Subclasses:
    AbstractRequestAdapter

    public abstract class AbstractRequest
    extends java.lang.Object
    The Class AbstractRequest.
    Since:
    2011. 3. 12.
    • Constructor Detail

      • AbstractRequest

        public AbstractRequest​(MethodType requestMethod)
    • Method Detail

      • getRequestMethod

        public MethodType getRequestMethod()
      • getHeader

        public java.lang.String getHeader​(java.lang.String name)
        Returns the value of the response header with the given name.

        If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

        Parameters:
        name - the name of the response header whose value to return
        Returns:
        the value of the response header with the given name, or null if no header with the given name has been set on this response
      • getHeaderValues

        public java.util.List<java.lang.String> getHeaderValues​(java.lang.String name)
        Returns the values of the response header with the given name.
        Parameters:
        name - the name of the response header whose values to return
        Returns:
        a (possibly empty) Collection of the values of the response header with the given name
      • getHeaderNames

        public java.util.Set<java.lang.String> getHeaderNames()
        Returns the names of the headers of this response.
        Returns:
        a (possibly empty) Collection of the names of the headers of this response
      • containsHeader

        public boolean containsHeader​(java.lang.String name)
        Returns a boolean indicating whether the named response header has already been set.
        Parameters:
        name - the header name
        Returns:
        true if the named response header has already been set; false otherwise
      • setHeader

        public void setHeader​(java.lang.String name,
                              java.lang.String value)
        Set the given single header value under the given header name.
        Parameters:
        name - the header name
        value - the header value to set
      • addHeader

        public void addHeader​(java.lang.String name,
                              java.lang.String value)
        Add the given single header value to the current list of values for the given header.
        Parameters:
        name - the header name
        value - the header value to be added
      • getHeaderMap

        public MultiValueMap<java.lang.String,​java.lang.String> getHeaderMap()
        Returns a map of the request headers that can be modified. If not yet instantiated then create a new one.
        Returns:
        an MultiValueMap object, may not be null
      • setHeaderMap

        public void setHeaderMap​(MultiValueMap<java.lang.String,​java.lang.String> headers)
      • hasHeaders

        public boolean hasHeaders()
      • getParameter

        public java.lang.String getParameter​(java.lang.String name)
      • getParameterValues

        public java.lang.String[] getParameterValues​(java.lang.String name)
      • getParameterNames

        public java.util.Set<java.lang.String> getParameterNames()
      • setParameter

        public void setParameter​(java.lang.String name,
                                 java.lang.String value)
      • setParameter

        public void setParameter​(java.lang.String name,
                                 java.lang.String[] values)
      • getAllParameters

        public java.util.Map<java.lang.String,​java.lang.Object> getAllParameters()
        Returns all parameters as a mutable Map<String, Object>.
        Returns:
        an Map<String, Object> object, must not be null
      • putAllParameters

        public void putAllParameters​(ParameterMap parameterMap)
      • putAllParameters

        public void putAllParameters​(MultiValueMap<java.lang.String,​java.lang.String> parameterMap)
      • extractParameters

        public void extractParameters​(java.util.Map<java.lang.String,​java.lang.Object> targetMap)
      • getParameterMap

        public ParameterMap getParameterMap()
        Returns a map of the request parameters that can be modified. If not yet instantiated then create a new one.
        Returns:
        an ParameterMap object, may not be null
      • setParameterMap

        public void setParameterMap​(ParameterMap parameterMap)
      • hasParameters

        public boolean hasParameters()
      • getFileParameter

        public FileParameter getFileParameter​(java.lang.String name)
      • getFileParameterValues

        public FileParameter[] getFileParameterValues​(java.lang.String name)
      • getFileParameterNames

        public java.util.Set<java.lang.String> getFileParameterNames()
      • setFileParameter

        public void setFileParameter​(java.lang.String name,
                                     FileParameter fileParameter)
      • setFileParameter

        public void setFileParameter​(java.lang.String name,
                                     FileParameter[] fileParameters)
      • removeFileParameter

        public void removeFileParameter​(java.lang.String name)
      • hasFileParameters

        public boolean hasFileParameters()
      • getAttribute

        public <T> T getAttribute​(java.lang.String name)
      • setAttribute

        public void setAttribute​(java.lang.String name,
                                 java.lang.Object value)
      • getAttributeNames

        public java.util.Set<java.lang.String> getAttributeNames()
      • removeAttribute

        public void removeAttribute​(java.lang.String name)
      • putAllAttributes

        public void putAllAttributes​(java.util.Map<java.lang.String,​java.lang.Object> attributes)
      • extractAttributes

        public void extractAttributes​(java.util.Map<java.lang.String,​java.lang.Object> targetMap)
      • getAttributeMap

        public java.util.Map<java.lang.String,​java.lang.Object> getAttributeMap()
        Returns a map of the request attributes that can be modified. If not yet instantiated then create a new one.
        Returns:
        an Map<String, Object> object, may not be null
      • setAttributeMap

        public void setAttributeMap​(java.util.Map<java.lang.String,​java.lang.Object> attributeMap)
      • hasAttributes

        public boolean hasAttributes()
      • getEncoding

        public java.lang.String getEncoding()
      • setEncoding

        public void setEncoding​(java.lang.String encoding)
                         throws java.io.UnsupportedEncodingException
        Throws:
        java.io.UnsupportedEncodingException
      • getLocale

        public java.util.Locale getLocale()
      • setLocale

        public void setLocale​(java.util.Locale locale)
        Sets the locale.
        Parameters:
        locale - the locale
      • getTimeZone

        public java.util.TimeZone getTimeZone()
        Gets the time zone.
        Returns:
        the time zone
      • setTimeZone

        public void setTimeZone​(java.util.TimeZone timeZone)
        Sets the time zone.
        Parameters:
        timeZone - the time zone
      • getMaxRequestSize

        public long getMaxRequestSize()
      • setMaxRequestSize

        public void setMaxRequestSize​(long maxRequestSize)
      • getInputStream

        public java.io.InputStream getInputStream()
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • getBody

        public java.lang.String getBody()
      • setBody

        public void setBody​(java.lang.String body)
      • getBodyAsParameters

        public Parameters getBodyAsParameters()
      • getBodyAsParameters

        public <T extends Parameters> T getBodyAsParameters​(java.lang.Class<T> requiredType)
      • getParameters

        public Parameters getParameters()
      • getParameters

        public <T extends Parameters> T getParameters​(java.lang.Class<T> requiredType)