|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.context.request.AbstractRequestAttributes org.springframework.web.context.request.ServletRequestAttributes org.springframework.web.context.request.ServletWebRequest
public class ServletWebRequest
WebRequest
adapter for an HttpServletRequest
.
Field Summary |
---|
Fields inherited from class org.springframework.web.context.request.ServletRequestAttributes |
---|
DESTRUCTION_CALLBACK_NAME_PREFIX |
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_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION |
Constructor Summary | |
---|---|
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 | ||
---|---|---|
boolean |
checkNotModified(long lastModifiedTimestamp)
Check whether the request qualifies as not modified given the supplied 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. |
|
Object |
getNativeRequest()
Return the underlying native request object, if available. |
|
|
getNativeRequest(Class<T> requiredType)
Return the underlying native request object, if available. |
|
Object |
getNativeResponse()
Return the underlying native response object, if available. |
|
|
getNativeResponse(Class<T> requiredType)
Return the underlying native request object, if available. |
|
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. |
|
HttpServletResponse |
getResponse()
Exposes the native HttpServletRequest that we're wrapping (if any). |
|
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(String role)
Determine whether the user is in the given role for this request. |
|
String |
toString()
|
Methods inherited from class org.springframework.web.context.request.ServletRequestAttributes |
---|
getAttribute, getAttributeNames, getRequest, getSession, getSessionId, getSessionMutex, 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 |
Constructor Detail |
---|
public ServletWebRequest(HttpServletRequest request)
request
- current HTTP requestpublic ServletWebRequest(HttpServletRequest request, HttpServletResponse response)
request
- current HTTP requestresponse
- current HTTP response (for automatic last-modified handling)Method Detail |
---|
public final HttpServletResponse getResponse()
HttpServletRequest
that we're wrapping (if any).
public Object getNativeRequest()
NativeWebRequest
getNativeRequest
in interface NativeWebRequest
HttpServletRequest
,
ActionRequest
,
RenderRequest
public Object getNativeResponse()
NativeWebRequest
getNativeResponse
in interface NativeWebRequest
HttpServletResponse
,
ActionResponse
,
RenderResponse
public <T> T getNativeRequest(Class<T> requiredType)
NativeWebRequest
getNativeRequest
in interface NativeWebRequest
requiredType
- the desired type of request object
null
if none
of that type is availableHttpServletRequest
,
ActionRequest
,
RenderRequest
public <T> T getNativeResponse(Class<T> requiredType)
NativeWebRequest
getNativeResponse
in interface NativeWebRequest
requiredType
- the desired type of response object
null
if none
of that type is availableHttpServletRequest
,
ActionRequest
,
RenderRequest
public String getHeader(String headerName)
WebRequest
null
if none.
Retrieves the first header value in case of a multi-value header.
getHeader
in interface WebRequest
HttpServletRequest.getHeader(String)
public String[] getHeaderValues(String headerName)
WebRequest
null
if none.
A single-value header will be exposed as an array with a single element.
getHeaderValues
in interface WebRequest
HttpServletRequest.getHeaders(String)
public Iterator<String> getHeaderNames()
WebRequest
getHeaderNames
in interface WebRequest
HttpServletRequest.getHeaderNames()
public String getParameter(String paramName)
WebRequest
null
if none.
Retrieves the first parameter value in case of a multi-value parameter.
getParameter
in interface WebRequest
ServletRequest.getParameter(String)
public String[] getParameterValues(String paramName)
WebRequest
null
if none.
A single-value parameter will be exposed as an array with a single element.
getParameterValues
in interface WebRequest
ServletRequest.getParameterValues(String)
public Iterator<String> getParameterNames()
WebRequest
getParameterNames
in interface WebRequest
ServletRequest.getParameterNames()
public Map<String,String[]> getParameterMap()
WebRequest
A single-value parameter will be exposed as an array with a single element.
getParameterMap
in interface WebRequest
ServletRequest.getParameterMap()
public Locale getLocale()
WebRequest
getLocale
in interface WebRequest
ServletRequest.getLocale()
public String getContextPath()
WebRequest
getContextPath
in interface WebRequest
HttpServletRequest.getContextPath()
public String getRemoteUser()
WebRequest
getRemoteUser
in interface WebRequest
HttpServletRequest.getRemoteUser()
public Principal getUserPrincipal()
WebRequest
getUserPrincipal
in interface WebRequest
HttpServletRequest.getUserPrincipal()
public boolean isUserInRole(String role)
WebRequest
isUserInRole
in interface WebRequest
HttpServletRequest.isUserInRole(String)
public boolean isSecure()
WebRequest
isSecure
in interface WebRequest
ServletRequest.isSecure()
public boolean checkNotModified(long lastModifiedTimestamp)
WebRequest
This will also transparently set the appropriate response headers, for both the modified case and the not-modified case.
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"; }
checkNotModified
in interface WebRequest
lastModifiedTimestamp
- the last-modified timestamp that
the application determined for the underlying resource
public boolean isNotModified()
public String getDescription(boolean includeClientInfo)
WebRequest
getDescription
in interface WebRequest
includeClientInfo
- whether to include client-specific
information such as session id and user name
public String toString()
toString
in class ServletRequestAttributes
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |