public Class FacesWebRequest

Create a new FacesWebRequest adapter for the given FacesContext.

Parameters

facesContext:FacesContext

the current FacesContext

See Also

jakarta.faces.context.FacesContext#getCurrentInstance()

Implements org.springframework.web.context.request.WebRequest.checkNotModified.

Doc from org.springframework.web.context.request.WebRequest.checkNotModified.

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.

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

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.checkNotModified.

Doc from org.springframework.web.context.request.WebRequest.checkNotModified.

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";
}

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.

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.checkNotModified.

Doc from org.springframework.web.context.request.WebRequest.checkNotModified.

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.

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.

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.getContextPath.

Doc from org.springframework.web.context.request.WebRequest.getContextPath.

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

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.getDescription.

Doc from org.springframework.web.context.request.WebRequest.getDescription.

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

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.getHeader.

Doc from org.springframework.web.context.request.WebRequest.getHeader.

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

@Override

@Nullable

Implements org.springframework.web.context.request.WebRequest.getHeaderNames.

Doc from org.springframework.web.context.request.WebRequest.getHeaderNames.

Return an Iterator over request header names.

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.getHeaderValues.

Doc from org.springframework.web.context.request.WebRequest.getHeaderValues.

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

@Override

@Nullable

Implements org.springframework.web.context.request.WebRequest.getLocale.

Doc from org.springframework.web.context.request.WebRequest.getLocale.

Return the primary Locale for this request.

Annotations

@Override

Implements org.springframework.web.context.request.NativeWebRequest.getNativeRequest.

Doc from org.springframework.web.context.request.NativeWebRequest.getNativeRequest.

Return the underlying native request object.

Annotations

@Override

Implements org.springframework.web.context.request.NativeWebRequest.getNativeRequest.

Doc from org.springframework.web.context.request.NativeWebRequest.getNativeRequest.

Return the underlying native request object, if available.

Parameters

requiredType:Class<T>

the desired type of request object

Returns:T

the matching request object, or null if none of that type is available

Annotations

@Override

@SuppressWarnings:unchecked

Implements org.springframework.web.context.request.NativeWebRequest.getNativeResponse.

Doc from org.springframework.web.context.request.NativeWebRequest.getNativeResponse.

Return the underlying native response object, if any.

Annotations

@Override

Implements org.springframework.web.context.request.NativeWebRequest.getNativeResponse.

Doc from org.springframework.web.context.request.NativeWebRequest.getNativeResponse.

Return the underlying native response object, if available.

Parameters

requiredType:Class<T>

the desired type of response object

Returns:T

the matching response object, or null if none of that type is available

Annotations

@Override

@SuppressWarnings:unchecked

Implements org.springframework.web.context.request.WebRequest.getParameter.

Doc from org.springframework.web.context.request.WebRequest.getParameter.

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

@Override

@Nullable

Implements org.springframework.web.context.request.WebRequest.getParameterMap.

Doc from org.springframework.web.context.request.WebRequest.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.

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.getParameterNames.

Doc from org.springframework.web.context.request.WebRequest.getParameterNames.

Return an Iterator over request parameter names.

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.getParameterValues.

Doc from org.springframework.web.context.request.WebRequest.getParameterValues.

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

@Override

@Nullable

Implements org.springframework.web.context.request.WebRequest.getRemoteUser.

Doc from org.springframework.web.context.request.WebRequest.getRemoteUser.

Return the remote user for this request, if any.

Annotations

@Override

@Nullable

Implements org.springframework.web.context.request.WebRequest.getUserPrincipal.

Doc from org.springframework.web.context.request.WebRequest.getUserPrincipal.

Return the user principal for this request, if any.

Annotations

@Override

@Nullable

Implements org.springframework.web.context.request.WebRequest.isSecure.

Doc from org.springframework.web.context.request.WebRequest.isSecure.

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

Annotations

@Override

Implements org.springframework.web.context.request.WebRequest.isUserInRole.

Doc from org.springframework.web.context.request.WebRequest.isUserInRole.

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

Annotations

@Override

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override