|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.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). |
|
boolean |
checkNotModified(String eTag)
Check whether the request qualifies as not modified given the supplied ETag (entity tag), 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 request
public 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 NativeWebRequestHttpServletRequest,
ActionRequest,
RenderRequestpublic Object getNativeResponse()
NativeWebRequest
getNativeResponse in interface NativeWebRequestHttpServletResponse,
ActionResponse,
RenderResponsepublic <T> T getNativeRequest(Class<T> requiredType)
NativeWebRequest
getNativeRequest in interface NativeWebRequestrequiredType - the desired type of request object
null if none
of that type is availableHttpServletRequest,
ActionRequest,
RenderRequestpublic <T> T getNativeResponse(Class<T> requiredType)
NativeWebRequest
getNativeResponse in interface NativeWebRequestrequiredType - the desired type of response object
null if none
of that type is availableHttpServletRequest,
ActionRequest,
RenderRequestpublic String getHeader(String headerName)
WebRequestnull if none.
Retrieves the first header value in case of a multi-value header.
getHeader in interface WebRequestHttpServletRequest.getHeader(String)public String[] getHeaderValues(String headerName)
WebRequestnull if none.
A single-value header will be exposed as an array with a single element.
getHeaderValues in interface WebRequestHttpServletRequest.getHeaders(String)public Iterator<String> getHeaderNames()
WebRequest
getHeaderNames in interface WebRequestHttpServletRequest.getHeaderNames()public String getParameter(String paramName)
WebRequestnull if none.
Retrieves the first parameter value in case of a multi-value parameter.
getParameter in interface WebRequestServletRequest.getParameter(String)public String[] getParameterValues(String paramName)
WebRequestnull if none.
A single-value parameter will be exposed as an array with a single element.
getParameterValues in interface WebRequestServletRequest.getParameterValues(String)public Iterator<String> getParameterNames()
WebRequest
getParameterNames in interface WebRequestServletRequest.getParameterNames()public Map<String,String[]> getParameterMap()
WebRequestA single-value parameter will be exposed as an array with a single element.
getParameterMap in interface WebRequestServletRequest.getParameterMap()public Locale getLocale()
WebRequest
getLocale in interface WebRequestServletRequest.getLocale()public String getContextPath()
WebRequest
getContextPath in interface WebRequestHttpServletRequest.getContextPath()public String getRemoteUser()
WebRequest
getRemoteUser in interface WebRequestHttpServletRequest.getRemoteUser()public Principal getUserPrincipal()
WebRequest
getUserPrincipal in interface WebRequestHttpServletRequest.getUserPrincipal()public boolean isUserInRole(String role)
WebRequest
isUserInRole in interface WebRequestHttpServletRequest.isUserInRole(String)public boolean isSecure()
WebRequest
isSecure in interface WebRequestServletRequest.isSecure()public boolean checkNotModified(long lastModifiedTimestamp)
WebRequestThis 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";
}
Note: that you typically want to use either
this WebRequest.checkNotModified(long) method; or
WebRequest.checkNotModified(String), but not both.
checkNotModified in interface WebRequestlastModifiedTimestamp - the last-modified timestamp that
the application determined for the underlying resource
public boolean checkNotModified(String eTag)
WebRequestETag (entity tag), as determined by the application.
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) {
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: that you typically want to use either
this WebRequest.checkNotModified(String) method; or
WebRequest.checkNotModified(long), but not both.
checkNotModified in interface WebRequesteTag - the entity tag that the application determined
for the underlying resource. This parameter will be padded
with quotes (") if necessary.
public boolean isNotModified()
public String getDescription(boolean includeClientInfo)
WebRequest
getDescription in interface WebRequestincludeClientInfo - 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 | ||||||||