Spring Framework 6.1.4 · org.springframework.web.context.request.WebRequest

Method Summary

Modifier and Type	Method and Description
public boolean	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(long the last-modified timestamp in milliseconds that the application determined for the underlying resource lastModifiedTimestamp) Check whether the requested resource has been modified given the supplied last-modified timestamp (as determined by the application).
public boolean	Returns: true if the request does not require further processing. checkNotModified(String the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary. etag) Check whether the requested resource has been modified given the supplied `ETag` (entity tag), as determined by the application.
public boolean	Returns: true if the request does not require further processing. checkNotModified(String the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary. etag, long the last-modified timestamp in milliseconds that the application determined for the underlying resource lastModifiedTimestamp) Check whether the requested resource has been modified given the supplied `ETag` (entity tag) and last-modified timestamp, as determined by the application.
public String	getContextPath() Return the context path for this request (usually the base path that the current web application is mapped to).
public String	Returns: the requested description as String getDescription(boolean whether to include client-specific information such as session id and user name includeClientInfo) Get a short description of this request, typically containing request URI and session id.
public String	getHeader(String headerName) Return the request header of the given name, or `null` if none.
public Iterator<String>	getHeaderNames() Return an Iterator over request header names.
public String[]	getHeaderValues(String headerName) Return the request header values for the given header name, or `null` if none.
public Locale	getLocale() Return the primary Locale for this request.
public String	getParameter(String paramName) Return the request parameter of the given name, or `null` if none.
public Map<String, String[]>	getParameterMap() Return an immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.
public Iterator<String>	getParameterNames() Return an Iterator over request parameter names.
public String[]	getParameterValues(String paramName) Return the request parameter values for the given parameter name, or `null` if none.
public String	getRemoteUser() Return the remote user for this request, if any.
public Principal	getUserPrincipal() Return the user principal for this request, if any.
public boolean	isSecure() Return whether this request has been sent over a secure transport mechanism (such as SSL).
public boolean	isUserInRole(String role) Determine whether the user is in the given role for this request.

Inherited from org.springframework.web.context.request.RequestAttributes:: getAttribute getAttributeNames getSessionId getSessionMutex registerDestructionCallback removeAttribute resolveReference setAttribute

Method Detail

checkNotModified back to summary

checkNotModified	back to summary
public 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 to 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:long the last-modified timestamp in milliseconds that the application determined for the underlying resource Returns:boolean 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 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 to 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:long: the last-modified timestamp in milliseconds that the application determined for the underlying resource

Returns:boolean

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 back to summary

checkNotModified	back to summary
public 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 to 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:String the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary. Returns:boolean true if the request does not require further processing.

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

Returns:boolean

true if the request does not require further processing.

checkNotModified back to summary

checkNotModified	back to summary
public 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:String the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary. lastModifiedTimestamp:long the last-modified timestamp in milliseconds that the application determined for the underlying resource Returns:boolean true if the request does not require further processing. Since 4.2

public 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:String: the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary.
lastModifiedTimestamp:long: the last-modified timestamp in milliseconds that the application determined for the underlying resource

Returns:boolean

true if the request does not require further processing.

Since

4.2

getContextPath back to summary

getContextPath	back to summary
public String getContextPath() Return the context path for this request (usually the base path that the current web application is mapped to). See Also `jakarta.servlet.http.HttpServletRequest#getContextPath()`

public String getContextPath()

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

See Also: jakarta.servlet.http.HttpServletRequest#getContextPath()

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

getDescription

back to summary

public String getDescription(boolean includeClientInfo)

Get a short description of this request, typically containing request URI and session id.

Parameters

includeClientInfo:boolean: whether to include client-specific information such as session id and user name

Returns:String

the requested description as String

getHeader back to summary

getHeader	back to summary
public 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. Annotations @Nullable Since 3.0 See Also `jakarta.servlet.http.HttpServletRequest#getHeader(String)`

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

Annotations

@Nullable

Since

3.0

getHeaderNames back to summary

getHeaderNames	back to summary
public Iterator<String> getHeaderNames() Return an Iterator over request header names. Since 3.0 See Also `jakarta.servlet.http.HttpServletRequest#getHeaderNames()`

public Iterator<String> getHeaderNames()

Return an Iterator over request header names.

Since: 3.0
See Also: jakarta.servlet.http.HttpServletRequest#getHeaderNames()

getHeaderValues back to summary

getHeaderValues	back to summary
public 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. Annotations @Nullable Since 3.0 See Also `jakarta.servlet.http.HttpServletRequest#getHeaders(String)`

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

Annotations

@Nullable

Since

3.0

getLocale back to summary

getLocale	back to summary
public Locale getLocale() Return the primary Locale for this request. See Also `jakarta.servlet.http.HttpServletRequest#getLocale()`

public Locale getLocale()

Return the primary Locale for this request.

See Also: jakarta.servlet.http.HttpServletRequest#getLocale()

getParameter back to summary

getParameter	back to summary
public 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. Annotations @Nullable See Also `jakarta.servlet.http.HttpServletRequest#getParameter(String)`

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

Annotations

@Nullable

getParameterMap back to summary

getParameterMap	back to summary
public Map<String, String[]> getParameterMap() Return an 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 `jakarta.servlet.http.HttpServletRequest#getParameterMap()`

public Map<String, String[]> getParameterMap()

Return an 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: jakarta.servlet.http.HttpServletRequest#getParameterMap()

getParameterNames back to summary

getParameterNames	back to summary
public Iterator<String> getParameterNames() Return an Iterator over request parameter names. Since 3.0 See Also `jakarta.servlet.http.HttpServletRequest#getParameterNames()`

public Iterator<String> getParameterNames()

Return an Iterator over request parameter names.

Since: 3.0
See Also: jakarta.servlet.http.HttpServletRequest#getParameterNames()

getParameterValues back to summary

getParameterValues	back to summary
public 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. Annotations @Nullable See Also `jakarta.servlet.http.HttpServletRequest#getParameterValues(String)`

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

Annotations

@Nullable

getRemoteUser back to summary

getRemoteUser	back to summary
public String getRemoteUser() Return the remote user for this request, if any. Annotations @Nullable See Also `jakarta.servlet.http.HttpServletRequest#getRemoteUser()`

public String getRemoteUser()

Return the remote user for this request, if any.

Annotations

@Nullable

getUserPrincipal back to summary

getUserPrincipal	back to summary
public Principal getUserPrincipal() Return the user principal for this request, if any. Annotations @Nullable See Also `jakarta.servlet.http.HttpServletRequest#getUserPrincipal()`

public Principal getUserPrincipal()

Return the user principal for this request, if any.

Annotations

@Nullable

isSecure back to summary

isSecure	back to summary
public boolean isSecure() Return whether this request has been sent over a secure transport mechanism (such as SSL). See Also `jakarta.servlet.http.HttpServletRequest#isSecure()`

public boolean isSecure()

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

See Also: jakarta.servlet.http.HttpServletRequest#isSecure()

isUserInRole back to summary

isUserInRole	back to summary
public boolean isUserInRole(String role) Determine whether the user is in the given role for this request. See Also `jakarta.servlet.http.HttpServletRequest#isUserInRole(String)`

public boolean isUserInRole(String role)

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

See Also: jakarta.servlet.http.HttpServletRequest#isUserInRole(String)

public Interface WebRequest

Field Summary

Method Summary

Method Detail