类 ServletWebRequest

构造器详细资料

• ServletWebRequest

  public ServletWebRequest​(HttpServletRequest request)

  Create a new ServletWebRequest instance for the given request.

  参数:

  request - current HTTP request

• ServletWebRequest

  public ServletWebRequest​(HttpServletRequest request,
                           @Nullable
                           HttpServletResponse response)

  Create a new ServletWebRequest instance for the given request/response pair.

  参数:

  request - current HTTP request

  response - current HTTP response (for automatic last-modified handling)

方法详细资料

• getNativeRequest

  public Object getNativeRequest()

  从接口复制的说明: NativeWebRequest
  Return the underlying native request object.

  指定者:

  getNativeRequest 在接口中 NativeWebRequest

  另请参阅:

  HttpServletRequest

• getNativeResponse

  public Object getNativeResponse()

  从接口复制的说明: NativeWebRequest
  Return the underlying native response object, if any.

  指定者:

  getNativeResponse 在接口中 NativeWebRequest

  另请参阅:

  HttpServletResponse

• getNativeRequest

  public <T> T getNativeRequest​(@Nullable
                                Class<T> requiredType)

  从接口复制的说明: NativeWebRequest
  Return the underlying native request object, if available.

  指定者:

  getNativeRequest 在接口中 NativeWebRequest

  参数:

  requiredType - the desired type of request object

  返回:

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

  另请参阅:

  HttpServletRequest

• getNativeResponse

  public <T> T getNativeResponse​(@Nullable
                                 Class<T> requiredType)

  从接口复制的说明: NativeWebRequest
  Return the underlying native response object, if available.

  指定者:

  getNativeResponse 在接口中 NativeWebRequest

  参数:

  requiredType - the desired type of response object

  返回:

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

  另请参阅:

  HttpServletResponse

• getHttpMethod

  @Nullable
  public HttpMethod getHttpMethod()

  Return the HTTP method of the request.

  从以下版本开始:

  4.0.2

• getHeader

  @Nullable
  public String getHeader​(String headerName)

  从接口复制的说明: 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.

  指定者:

  getHeader 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.getHeader(String)

• getHeaderValues

  @Nullable
  public String[] getHeaderValues​(String headerName)

  从接口复制的说明: 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.

  指定者:

  getHeaderValues 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.getHeaders(String)

• getHeaderNames

  public Iterator<String> getHeaderNames()

  从接口复制的说明: WebRequest
  Return a Iterator over request header names.

  指定者:

  getHeaderNames 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.getHeaderNames()

• getParameter

  @Nullable
  public String getParameter​(String paramName)

  从接口复制的说明: 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.

  指定者:

  getParameter 在接口中 WebRequest

  另请参阅:

  ServletRequest.getParameter(String)

• getParameterValues

  @Nullable
  public String[] getParameterValues​(String paramName)

  从接口复制的说明: 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.

  指定者:

  getParameterValues 在接口中 WebRequest

  另请参阅:

  ServletRequest.getParameterValues(String)

• getParameterNames

  public Iterator<String> getParameterNames()

  从接口复制的说明: WebRequest
  Return a Iterator over request parameter names.

  指定者:

  getParameterNames 在接口中 WebRequest

  另请参阅:

  ServletRequest.getParameterNames()

• getParameterMap

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

  从接口复制的说明: 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.

  指定者:

  getParameterMap 在接口中 WebRequest

  另请参阅:

  ServletRequest.getParameterMap()

• getLocale

  public Locale getLocale()

  从接口复制的说明: WebRequest
  Return the primary Locale for this request.

  指定者:

  getLocale 在接口中 WebRequest

  另请参阅:

  ServletRequest.getLocale()

• getContextPath

  public String getContextPath()

  从接口复制的说明: WebRequest
  Return the context path for this request (usually the base path that the current web application is mapped to).

  指定者:

  getContextPath 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.getContextPath()

• getRemoteUser

  @Nullable
  public String getRemoteUser()

  从接口复制的说明: WebRequest
  Return the remote user for this request, if any.

  指定者:

  getRemoteUser 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.getRemoteUser()

• getUserPrincipal

  @Nullable
  public Principal getUserPrincipal()

  从接口复制的说明: WebRequest
  Return the user principal for this request, if any.

  指定者:

  getUserPrincipal 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.getUserPrincipal()

• isUserInRole

  public boolean isUserInRole​(String role)

  从接口复制的说明: WebRequest
  Determine whether the user is in the given role for this request.

  指定者:

  isUserInRole 在接口中 WebRequest

  另请参阅:

  HttpServletRequest.isUserInRole(String)

• isSecure

  public boolean isSecure()

  从接口复制的说明: WebRequest
  Return whether this request has been sent over a secure transport mechanism (such as SSL).

  指定者:

  isSecure 在接口中 WebRequest

  另请参阅:

  ServletRequest.isSecure()

• checkNotModified

  public boolean checkNotModified​(long lastModifiedTimestamp)

  从接口复制的说明: 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 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 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.

  指定者:

  checkNotModified 在接口中 WebRequest

  参数:

  lastModifiedTimestamp - the last-modified timestamp in milliseconds that the application determined for the underlying resource

  返回:

  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​(String etag)

  从接口复制的说明: 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 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 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).

  指定者:

  checkNotModified 在接口中 WebRequest

  参数:

  etag - the entity tag that the application determined for the underlying resource. This parameter will be padded with quotes (") if necessary.

  返回:

  true if the request does not require further processing.

• checkNotModified

  public boolean checkNotModified​(@Nullable
                                  String etag,
                                  long lastModifiedTimestamp)

  从接口复制的说明: 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 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 WebRequest.checkNotModified(long).

  指定者:

  checkNotModified 在接口中 WebRequest

  参数:

  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

  返回:

  true if the request does not require further processing.

• isNotModified

  public boolean isNotModified()

• getDescription

  public String getDescription​(boolean includeClientInfo)

  从接口复制的说明: WebRequest
  Get a short description of this request, typically containing request URI and session id.

  指定者:

  getDescription 在接口中 WebRequest

  参数:

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

  返回:

  the requested description as String

• toString

  public String toString()

  覆盖:

  toString 在类中 ServletRequestAttributes