public interface

WebRequest

implements RequestAttributes
org.springframework.web.context.request.WebRequest
Known Indirect Subclasses

Class Overview

Generic interface for a web request. Mainly intended for generic web request interceptors, giving them access to general request metadata, not for actual handling of the request.

See Also

Summary

[Expand]
Inherited Constants
From interface org.springframework.web.context.request.RequestAttributes
Public Methods
abstract boolean checkNotModified(String eTag)
Check whether the request qualifies as not modified given the supplied ETag (entity tag), as determined by the application.
abstract boolean checkNotModified(long lastModifiedTimestamp)
Check whether the request qualifies as not modified given the supplied last-modified timestamp (as determined by the application).
abstract String getContextPath()
Return the context path for this request (usually the base path that the current web application is mapped to).
abstract String getDescription(boolean includeClientInfo)
Get a short description of this request, typically containing request URI and session id.
abstract String getHeader(String headerName)
Return the request header of the given name, or null if none.
abstract Iterator<String> getHeaderNames()
Return a Iterator over request header names.
abstract String[] getHeaderValues(String headerName)
Return the request header values for the given header name, or null if none.
abstract Locale getLocale()
Return the primary Locale for this request.
abstract String getParameter(String paramName)
Return the request parameter of the given name, or null if none.
abstract Map<String, String[]> getParameterMap()
Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.
abstract Iterator<String> getParameterNames()
Return a Iterator over request parameter names.
abstract String[] getParameterValues(String paramName)
Return the request parameter values for the given parameter name, or null if none.
abstract String getRemoteUser()
Return the remote user for this request, if any.
abstract Principal getUserPrincipal()
Return the user principal for this request, if any.
abstract boolean isSecure()
Return whether this request has been sent over a secure transport mechanism (such as SSL).
abstract boolean isUserInRole(String role)
Determine whether the user is in the given role for this request.
[Expand]
Inherited Methods
From interface org.springframework.web.context.request.RequestAttributes

Public Methods

public abstract boolean checkNotModified (String eTag)

Check whether the request qualifies as not modified given the supplied ETag (entity tag), as determined by the application.

This will also transparently set the appropriate response headers, for both the modified case and the not-modified case.

Typical usage: 

 public String myHandleMethod(WebRequest webRequest, 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: that you typically want to use either this checkNotModified(String) method; or checkNotModified(long), but not both.

Parameters
eTag the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary.
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

public abstract boolean checkNotModified (long lastModifiedTimestamp)

Check whether the request qualifies as not modified given the supplied last-modified timestamp (as determined by the application).

This will also transparently set the appropriate response headers, for both the modified case and the not-modified case.

Typical usage: 

 public String myHandleMethod(WebRequest webRequest, 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";
 }

Note: that you typically want to use either this checkNotModified(long) method; or checkNotModified(String), but not both.

Parameters
lastModifiedTimestamp the last-modified timestamp 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

public abstract String getContextPath ()

Return the context path for this request (usually the base path that the current web application is mapped to).

See Also

public abstract 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

public abstract String getHeader (String headerName)

Return the request header of the given name, or null if none.

Retrieves the first header value in case of a multi-value header.

See Also

public abstract Iterator<String> getHeaderNames ()

Return a Iterator over request header names.

See Also

public abstract String[] getHeaderValues (String headerName)

Return the request header values for the given header name, or null if none.

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

See Also

public abstract Locale getLocale ()

Return the primary Locale for this request.

See Also

public abstract String getParameter (String paramName)

Return the request parameter of the given name, or null if none.

Retrieves the first parameter value in case of a multi-value parameter.

See Also

public abstract 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

public abstract Iterator<String> getParameterNames ()

Return a Iterator over request parameter names.

See Also

public abstract String[] getParameterValues (String paramName)

Return the request parameter values for the given parameter name, or null if none.

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

See Also

public abstract String getRemoteUser ()

Return the remote user for this request, if any.

See Also

public abstract Principal getUserPrincipal ()

Return the user principal for this request, if any.

See Also

public abstract boolean isSecure ()

Return whether this request has been sent over a secure transport mechanism (such as SSL).

See Also

public abstract boolean isUserInRole (String role)

Determine whether the user is in the given role for this request.

See Also