Package org.springframework.web.context.request

Interface WebRequest

    • Method Detail

      • getParameterMap

        Map<String,​String[]> getParameterMap()
        Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values. The map values will be of type String array.

        A single-value parameter will be exposed as an array with a single element.

        See Also:
        ServletRequest.getParameterMap()

      • checkNotModified

        boolean checkNotModified​(long lastModifiedTimestamp)
        Check whether the requested resource has been modified given the supplied last-modified timestamp (as determined by the application).

        This will also transparently set the "Last-Modified" response header and HTTP status when applicable.

        Typical usage: 

         public String myHandleMethod(WebRequest request, Model model) {
   long lastModified = // application-specific calculation
   if (request.checkNotModified(lastModified)) {
     // shortcut exit - no further processing necessary
     return null;
   }
   // further request processing, actually building content
   model.addAttribute(...);
   return "myViewName";
 }

        This method works with conditional GET/HEAD requests, but also with conditional POST/PUT/DELETE requests.

        Note: you can use either this #checkNotModified(long) method; or checkNotModified(String). If you want enforce both a strong entity tag and a Last-Modified value, as recommended by the HTTP specification, then you should use checkNotModified(String, long).

        If the "If-Modified-Since" header is set but cannot be parsed to a date value, this method will ignore the header and proceed with setting the last-modified timestamp on the response.

        Parameters:
        lastModifiedTimestamp - the last-modified timestamp in milliseconds that the application determined for the underlying resource
        Returns:
        whether the request qualifies as not modified, allowing to abort request processing and relying on the response telling the client that the content has not been modified

      • checkNotModified

        boolean checkNotModified​(String etag)
        Check whether the requested resource has been modified given the supplied ETag (entity tag), as determined by the application.

        This will also transparently set the "ETag" response header and HTTP status when applicable.

        Typical usage: 

         public String myHandleMethod(WebRequest request, Model model) {
   String eTag = // application-specific calculation
   if (request.checkNotModified(eTag)) {
     // shortcut exit - no further processing necessary
     return null;
   }
   // further request processing, actually building content
   model.addAttribute(...);
   return "myViewName";
 }

        Note: you can use either this #checkNotModified(String) method; or checkNotModified(long). If you want enforce both a strong entity tag and a Last-Modified value, as recommended by the HTTP specification, then you should use checkNotModified(String, long).

        Parameters:
        etag - the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary.
        Returns:
        true if the request does not require further processing.

      • checkNotModified

        boolean checkNotModified​(String etag,
                         long lastModifiedTimestamp)
        Check whether the requested resource has been modified given the supplied ETag (entity tag) and last-modified timestamp, as determined by the application.

        This will also transparently set the "ETag" and "Last-Modified" response headers, and HTTP status when applicable.

        Typical usage: 

         public String myHandleMethod(WebRequest request, Model model) {
   String eTag = // application-specific calculation
   long lastModified = // application-specific calculation
   if (request.checkNotModified(eTag, lastModified)) {
     // shortcut exit - no further processing necessary
     return null;
   }
   // further request processing, actually building content
   model.addAttribute(...);
   return "myViewName";
 }

        This method works with conditional GET/HEAD requests, but also with conditional POST/PUT/DELETE requests.

        Note: The HTTP specification recommends setting both ETag and Last-Modified values, but you can also use #checkNotModified(String) or checkNotModified(long).

        Parameters:
        etag - the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary.
        lastModifiedTimestamp - the last-modified timestamp in milliseconds that the application determined for the underlying resource
        Returns:
        true if the request does not require further processing.
        Since:
        4.2

      • getDescription

        String getDescription​(boolean includeClientInfo)
        Get a short description of this request, typically containing request URI and session id.
        Parameters:
        includeClientInfo - whether to include client-specific information such as session id and user name
        Returns:
        the requested description as String