public interface WebRequest extends RequestAttributes
WebRequestInterceptor
REFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION
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(String etag)
Check whether the requested resource has been modified given the
supplied
ETag (entity tag), as determined by the application. |
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. |
String |
getContextPath()
Return the context path for this request
(usually the base path that the current web application is mapped to).
|
String |
getDescription(boolean includeClientInfo)
Get a short description of this request,
typically containing request URI and session id.
|
String |
getHeader(String headerName)
Return the request header of the given name, or
null if none. |
Iterator<String> |
getHeaderNames()
Return a Iterator over request header names.
|
String[] |
getHeaderValues(String headerName)
Return the request header values for the given header name,
or
null if none. |
Locale |
getLocale()
Return the primary Locale for this request.
|
String |
getParameter(String paramName)
Return the request parameter of the given name, or
null if none. |
Map<String,String[]> |
getParameterMap()
Return a immutable Map of the request parameters, with parameter names as map keys
and parameter values as map values.
|
Iterator<String> |
getParameterNames()
Return a Iterator over request parameter names.
|
String[] |
getParameterValues(String paramName)
Return the request parameter values for the given parameter name,
or
null if none. |
String |
getRemoteUser()
Return the remote user for this request, if any.
|
Principal |
getUserPrincipal()
Return the user principal for this request, if any.
|
boolean |
isSecure()
Return whether this request has been sent over a secure transport
mechanism (such as SSL).
|
boolean |
isUserInRole(String role)
Determine whether the user is in the given role for this request.
|
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttribute
String getHeader(String headerName)
null
if none.
Retrieves the first header value in case of a multi-value header.
HttpServletRequest.getHeader(String)
String[] getHeaderValues(String headerName)
null
if none.
A single-value header will be exposed as an array with a single element.
HttpServletRequest.getHeaders(String)
Iterator<String> getHeaderNames()
HttpServletRequest.getHeaderNames()
String getParameter(String paramName)
null
if none.
Retrieves the first parameter value in case of a multi-value parameter.
ServletRequest.getParameter(String)
String[] getParameterValues(String paramName)
null
if none.
A single-value parameter will be exposed as an array with a single element.
Iterator<String> getParameterNames()
ServletRequest.getParameterNames()
Map<String,String[]> getParameterMap()
A single-value parameter will be exposed as an array with a single element.
ServletRequest.getParameterMap()
Locale getLocale()
ServletRequest.getLocale()
String getContextPath()
HttpServletRequest.getContextPath()
String getRemoteUser()
HttpServletRequest.getRemoteUser()
Principal getUserPrincipal()
HttpServletRequest.getUserPrincipal()
boolean isUserInRole(String role)
HttpServletRequest.isUserInRole(String)
boolean isSecure()
ServletRequest.isSecure()
boolean checkNotModified(long lastModifiedTimestamp)
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.
lastModifiedTimestamp
- the last-modified timestamp in
milliseconds that the application determined for the underlying
resourceboolean checkNotModified(String etag)
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)
.
etag
- the entity tag that the application determined
for the underlying resource. This parameter will be padded
with quotes (") if necessary.boolean checkNotModified(String etag, long lastModifiedTimestamp)
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)
.
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
resourceString getDescription(boolean includeClientInfo)
includeClientInfo
- whether to include client-specific
information such as session id and user name