ServletWebRequest

java.lang.Object
- org.springframework.web.context.request.AbstractRequestAttributes
- - org.springframework.web.context.request.ServletRequestAttributes
  - - org.springframework.web.context.request.ServletWebRequest

All Implemented Interfaces:

NativeWebRequest, RequestAttributes, WebRequest

Direct Known Subclasses:

DispatcherServletWebRequest, StandardServletAsyncWebRequest
```
public class ServletWebRequest
extends ServletRequestAttributes
implements NativeWebRequest
```
WebRequest adapter for an javax.servlet.http.HttpServletRequest.

Since:

2.0

Author:

Juergen Hoeller, Brian Clozel, Markus Malkusch

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.String[]`	`DATE_FORMATS` Date formats as specified in the HTTP RFC.
`private static java.lang.String`	`ETAG`
`private static java.util.regex.Pattern`	`ETAG_HEADER_VALUE_PATTERN` Pattern matching ETag multiple field values in headers such as "If-Match", "If-None-Match".
`private static java.util.TimeZone`	`GMT`
`private static java.lang.String`	`IF_MODIFIED_SINCE`
`private static java.lang.String`	`IF_NONE_MATCH`
`private static java.lang.String`	`IF_UNMODIFIED_SINCE`
`private static java.lang.String`	`LAST_MODIFIED`
`private boolean`	`notModified`
`private static java.util.List<java.lang.String>`	`SAFE_METHODS`

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 and Description
`ServletWebRequest(HttpServletRequest request)` Create a new ServletWebRequest instance for the given request.
`ServletWebRequest(HttpServletRequest request, HttpServletResponse response)` Create a new ServletWebRequest instance for the given request/response pair.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`checkNotModified(long lastModifiedTimestamp)` Check whether the requested resource has been modified given the supplied last-modified timestamp (as determined by the application).
`boolean`	`checkNotModified(java.lang.String etag)` Check whether the requested resource has been modified given the supplied `ETag` (entity tag), as determined by the application.
`boolean`	`checkNotModified(java.lang.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.
`java.lang.String`	`getContextPath()` Return the context path for this request (usually the base path that the current web application is mapped to).
`java.lang.String`	`getDescription(boolean includeClientInfo)` Get a short description of this request, typically containing request URI and session id.
`java.lang.String`	`getHeader(java.lang.String headerName)` Return the request header of the given name, or `null` if none.
`java.util.Iterator<java.lang.String>`	`getHeaderNames()` Return a Iterator over request header names.
`java.lang.String[]`	`getHeaderValues(java.lang.String headerName)` Return the request header values for the given header name, or `null` if none.
`HttpMethod`	`getHttpMethod()` Return the HTTP method of the request.
`java.util.Locale`	`getLocale()` Return the primary Locale for this request.
`java.lang.Object`	`getNativeRequest()` Return the underlying native request object.
`<T> T`	`getNativeRequest(java.lang.Class<T> requiredType)` Return the underlying native request object, if available.
`java.lang.Object`	`getNativeResponse()` Return the underlying native response object, if any.
`<T> T`	`getNativeResponse(java.lang.Class<T> requiredType)` Return the underlying native response object, if available.
`java.lang.String`	`getParameter(java.lang.String paramName)` Return the request parameter of the given name, or `null` if none.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()` Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.
`java.util.Iterator<java.lang.String>`	`getParameterNames()` Return a Iterator over request parameter names.
`java.lang.String[]`	`getParameterValues(java.lang.String paramName)` Return the request parameter values for the given parameter name, or `null` if none.
`java.lang.String`	`getRemoteUser()` Return the remote user for this request, if any.
`java.security.Principal`	`getUserPrincipal()` Return the user principal for this request, if any.
`boolean`	`isNotModified()`
`boolean`	`isSecure()` Return whether this request has been sent over a secure transport mechanism (such as SSL).
`boolean`	`isUserInRole(java.lang.String role)` Determine whether the user is in the given role for this request.
`private java.lang.String`	`padEtagIfNecessary(java.lang.String etag)`
`private long`	`parseDateHeader(java.lang.String headerName)`
`private long`	`parseDateValue(java.lang.String headerValue)`
`java.lang.String`	`toString()`
`private boolean`	`validateIfModifiedSince(long lastModifiedTimestamp)`
`private boolean`	`validateIfNoneMatch(java.lang.String etag)`
`private boolean`	`validateIfUnmodifiedSince(long lastModifiedTimestamp)`

Methods inherited from class org.springframework.web.context.request.ServletRequestAttributes
getAttribute, getAttributeNames, getRequest, getResponse, getSession, getSessionId, getSessionMutex, isImmutableSessionAttribute, registerDestructionCallback, registerSessionDestructionCallback, removeAttribute, resolveReference, setAttribute, updateAccessedSessionAttributes

Methods inherited from class org.springframework.web.context.request.AbstractRequestAttributes
isRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.web.context.request.RequestAttributes
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttribute

- Field Detail
  - ETAG
```
private static final java.lang.String ETAG
```
    See Also:
    
    Constant Field Values
  - IF_MODIFIED_SINCE
```
private static final java.lang.String IF_MODIFIED_SINCE
```
    See Also:
    
    Constant Field Values
  - IF_UNMODIFIED_SINCE
```
private static final java.lang.String IF_UNMODIFIED_SINCE
```
    See Also:
    
    Constant Field Values
  - IF_NONE_MATCH
```
private static final java.lang.String IF_NONE_MATCH
```
    See Also:
    
    Constant Field Values
  - LAST_MODIFIED
```
private static final java.lang.String LAST_MODIFIED
```
    See Also:
    
    Constant Field Values
  - SAFE_METHODS
```
private static final java.util.List<java.lang.String> SAFE_METHODS
```
  - ETAG_HEADER_VALUE_PATTERN
```
private static final java.util.regex.Pattern ETAG_HEADER_VALUE_PATTERN
```
    Pattern matching ETag multiple field values in headers such as "If-Match", "If-None-Match".
    
    See Also:
    
    Section 2.3 of RFC 7232
  - DATE_FORMATS
```
private static final java.lang.String[] DATE_FORMATS
```
    Date formats as specified in the HTTP RFC.
    
    See Also:
    
    Section 7.1.1.1 of RFC 7231
  - GMT
```
private static final java.util.TimeZone GMT
```
  - notModified
```
private boolean notModified
```
- Constructor Detail
  - ServletWebRequest
```
public ServletWebRequest(HttpServletRequest request)
```
    Create a new ServletWebRequest instance for the given request.
    
    Parameters:
    
    request - current HTTP request
  - ServletWebRequest
```
public ServletWebRequest(HttpServletRequest request,
                         @Nullable
                         HttpServletResponse response)
```
    Create a new ServletWebRequest instance for the given request/response pair.
    
    Parameters:
    
    request - current HTTP request
    
    response - current HTTP response (for automatic last-modified handling)
- Method Detail
  - getNativeRequest
```
public java.lang.Object getNativeRequest()
```
    Description copied from interface: NativeWebRequest
    
    Return the underlying native request object.
    
    Specified by:
    
    getNativeRequest in interface NativeWebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest
  - getNativeResponse
```
public java.lang.Object getNativeResponse()
```
    Description copied from interface: NativeWebRequest
    
    Return the underlying native response object, if any.
    
    Specified by:
    
    getNativeResponse in interface NativeWebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletResponse
  - getNativeRequest
```
public <T> T getNativeRequest(@Nullable
                              java.lang.Class<T> requiredType)
```
    Description copied from interface: NativeWebRequest
    
    Return the underlying native request object, if available.
    
    Specified by:
    
    getNativeRequest in interface NativeWebRequest
    
    Parameters:
    
    requiredType - the desired type of request object
    
    Returns:
    
    the matching request object, or null if none of that type is available
    
    See Also:
    
    javax.servlet.http.HttpServletRequest
  - getNativeResponse
```
public <T> T getNativeResponse(@Nullable
                               java.lang.Class<T> requiredType)
```
    Description copied from interface: NativeWebRequest
    
    Return the underlying native response object, if available.
    
    Specified by:
    
    getNativeResponse in interface NativeWebRequest
    
    Parameters:
    
    requiredType - the desired type of response object
    
    Returns:
    
    the matching response object, or null if none of that type is available
    
    See Also:
    
    javax.servlet.http.HttpServletResponse
  - getHttpMethod
```
@Nullable
public HttpMethod getHttpMethod()
```
    Return the HTTP method of the request.
    
    Since:
    
    4.0.2
  - getHeader
```
@Nullable
public java.lang.String getHeader(java.lang.String headerName)
```
    Description copied from interface: WebRequest
    
    Return the request header of the given name, or null if none.
    Retrieves the first header value in case of a multi-value header.
    
    Specified by:
    
    getHeader in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getHeader(String)
  - getHeaderValues
```
@Nullable
public java.lang.String[] getHeaderValues(java.lang.String headerName)
```
    Description copied from interface: WebRequest
    
    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.
    
    Specified by:
    
    getHeaderValues in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getHeaders(String)
  - getHeaderNames
```
public java.util.Iterator<java.lang.String> getHeaderNames()
```
    Description copied from interface: WebRequest
    
    Return a Iterator over request header names.
    
    Specified by:
    
    getHeaderNames in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getHeaderNames()
  - getParameter
```
@Nullable
public java.lang.String getParameter(java.lang.String paramName)
```
    Description copied from interface: WebRequest
    
    Return the request parameter of the given name, or null if none.
    Retrieves the first parameter value in case of a multi-value parameter.
    
    Specified by:
    
    getParameter in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getParameter(String)
  - getParameterValues
```
@Nullable
public java.lang.String[] getParameterValues(java.lang.String paramName)
```
    Description copied from interface: WebRequest
    
    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.
    
    Specified by:
    
    getParameterValues in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getParameterValues(String)
  - getParameterNames
```
public java.util.Iterator<java.lang.String> getParameterNames()
```
    Description copied from interface: WebRequest
    
    Return a Iterator over request parameter names.
    
    Specified by:
    
    getParameterNames in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getParameterNames()
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Description copied from interface: WebRequest
    
    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.
    
    Specified by:
    
    getParameterMap in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getParameterMap()
  - getLocale
```
public java.util.Locale getLocale()
```
    Description copied from interface: WebRequest
    
    Return the primary Locale for this request.
    
    Specified by:
    
    getLocale in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getLocale()
  - getContextPath
```
public java.lang.String getContextPath()
```
    Description copied from interface: WebRequest
    
    Return the context path for this request (usually the base path that the current web application is mapped to).
    
    Specified by:
    
    getContextPath in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getContextPath()
  - getRemoteUser
```
@Nullable
public java.lang.String getRemoteUser()
```
    Description copied from interface: WebRequest
    
    Return the remote user for this request, if any.
    
    Specified by:
    
    getRemoteUser in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getRemoteUser()
  - getUserPrincipal
```
@Nullable
public java.security.Principal getUserPrincipal()
```
    Description copied from interface: WebRequest
    
    Return the user principal for this request, if any.
    
    Specified by:
    
    getUserPrincipal in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getUserPrincipal()
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Description copied from interface: WebRequest
    
    Determine whether the user is in the given role for this request.
    
    Specified by:
    
    isUserInRole in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#isUserInRole(String)
  - isSecure
```
public boolean isSecure()
```
    Description copied from interface: WebRequest
    
    Return whether this request has been sent over a secure transport mechanism (such as SSL).
    
    Specified by:
    
    isSecure in interface WebRequest
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#isSecure()
  - checkNotModified
```
public boolean checkNotModified(long lastModifiedTimestamp)
```
    Description copied from interface: WebRequest
    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 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";
 }
```
    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 WebRequest.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 WebRequest.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.
    Specified by:
    
    checkNotModified in interface WebRequest
    
    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
```
public boolean checkNotModified(java.lang.String etag)
```
    Description copied from interface: WebRequest
    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 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: you can use either this #checkNotModified(String) method; or WebRequest.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 WebRequest.checkNotModified(String, long).
    Specified by:
    
    checkNotModified in interface WebRequest
    
    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
```
public boolean checkNotModified(@Nullable
                                java.lang.String etag,
                                long lastModifiedTimestamp)
```
    Description copied from interface: WebRequest
    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 webRequest, 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 WebRequest.checkNotModified(long).
    Specified by:
    
    checkNotModified in interface WebRequest
    
    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.
  - validateIfUnmodifiedSince
```
private boolean validateIfUnmodifiedSince(long lastModifiedTimestamp)
```
  - validateIfNoneMatch
```
private boolean validateIfNoneMatch(@Nullable
                                    java.lang.String etag)
```
  - padEtagIfNecessary
```
private java.lang.String padEtagIfNecessary(java.lang.String etag)
```
  - validateIfModifiedSince
```
private boolean validateIfModifiedSince(long lastModifiedTimestamp)
```
  - isNotModified
```
public boolean isNotModified()
```
  - parseDateHeader
```
private long parseDateHeader(java.lang.String headerName)
```
  - parseDateValue
```
private long parseDateValue(@Nullable
                            java.lang.String headerValue)
```
  - getDescription
```
public java.lang.String getDescription(boolean includeClientInfo)
```
    Description copied from interface: WebRequest
    
    Get a short description of this request, typically containing request URI and session id.
    
    Specified by:
    
    getDescription in interface WebRequest
    
    Parameters:
    
    includeClientInfo - whether to include client-specific information such as session id and user name
    
    Returns:
    
    the requested description as String
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class ServletRequestAttributes

Class ServletWebRequest

Field Summary

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

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

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

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.context.request.ServletRequestAttributes

Methods inherited from class org.springframework.web.context.request.AbstractRequestAttributes

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.web.context.request.RequestAttributes

Field Detail

ETAG

IF_MODIFIED_SINCE

IF_UNMODIFIED_SINCE

IF_NONE_MATCH

LAST_MODIFIED

SAFE_METHODS

ETAG_HEADER_VALUE_PATTERN

DATE_FORMATS

GMT

notModified

Constructor Detail

ServletWebRequest

ServletWebRequest

Method Detail

getNativeRequest

getNativeResponse

getNativeRequest

getNativeResponse

getHttpMethod

getHeader

getHeaderValues

getHeaderNames

getParameter

getParameterValues

getParameterNames

getParameterMap

getLocale

getContextPath

getRemoteUser

getUserPrincipal

isUserInRole

isSecure

checkNotModified

checkNotModified

checkNotModified

validateIfUnmodifiedSince

validateIfNoneMatch

padEtagIfNecessary

validateIfModifiedSince

isNotModified

parseDateHeader

parseDateValue

getDescription

toString