|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WebRequest
Generic interface for a web request. Mainly intended for generic web request interceptors, giving them access to general request metadata, not for actual handling of the request.
WebRequestInterceptor
Field Summary |
---|
Fields inherited from interface org.springframework.web.context.request.RequestAttributes |
---|
REFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION |
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). |
java.lang.String |
getContextPath()
Return the context path for this request (usually the base path that the current web application is mapped to). |
java.lang.String |
getDescription(boolean includeClientInfo)
Get a short description of this request, typically containing request URI and session id. |
java.lang.String |
getHeader(java.lang.String headerName)
Return the request header of the given name, or null if none. |
java.util.Iterator<java.lang.String> |
getHeaderNames()
Return a Iterator over request header names. |
java.lang.String[] |
getHeaderValues(java.lang.String headerName)
Return the request header values for the given header name, or null if none. |
java.util.Locale |
getLocale()
Return the primary Locale for this request. |
java.lang.String |
getParameter(java.lang.String paramName)
Return the request parameter of the given name, or null if none. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameterMap()
Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values. |
java.util.Iterator<java.lang.String> |
getParameterNames()
Return a Iterator over request parameter names. |
java.lang.String[] |
getParameterValues(java.lang.String paramName)
Return the request parameter values for the given parameter name, or null if none. |
java.lang.String |
getRemoteUser()
Return the remote user for this request, if any. |
java.security.Principal |
getUserPrincipal()
Return the user principal for this request, if any. |
boolean |
isSecure()
Return whether this request has been sent over a secure transport mechanism (such as SSL). |
boolean |
isUserInRole(java.lang.String role)
Determine whether the user is in the given role for this request. |
Methods inherited from interface org.springframework.web.context.request.RequestAttributes |
---|
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttribute |
Method Detail |
---|
java.lang.String getHeader(java.lang.String headerName)
null
if none.
Retrieves the first header value in case of a multi-value header.
javax.servlet.http.HttpServletRequest#getHeader(String)
java.lang.String[] getHeaderValues(java.lang.String headerName)
null
if none.
A single-value header will be exposed as an array with a single element.
javax.servlet.http.HttpServletRequest#getHeaders(String)
java.util.Iterator<java.lang.String> getHeaderNames()
javax.servlet.http.HttpServletRequest#getHeaderNames()
java.lang.String getParameter(java.lang.String paramName)
null
if none.
Retrieves the first parameter value in case of a multi-value parameter.
javax.servlet.http.HttpServletRequest#getParameter(String)
java.lang.String[] getParameterValues(java.lang.String paramName)
null
if none.
A single-value parameter will be exposed as an array with a single element.
javax.servlet.http.HttpServletRequest#getParameterValues(String)
java.util.Iterator<java.lang.String> getParameterNames()
javax.servlet.http.HttpServletRequest#getParameterNames()
java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
A single-value parameter will be exposed as an array with a single element.
javax.servlet.http.HttpServletRequest#getParameterMap()
java.util.Locale getLocale()
javax.servlet.http.HttpServletRequest#getLocale()
java.lang.String getContextPath()
javax.servlet.http.HttpServletRequest#getContextPath()
java.lang.String getRemoteUser()
javax.servlet.http.HttpServletRequest#getRemoteUser()
java.security.Principal getUserPrincipal()
javax.servlet.http.HttpServletRequest#getUserPrincipal()
boolean isUserInRole(java.lang.String role)
javax.servlet.http.HttpServletRequest#isUserInRole(String)
boolean isSecure()
javax.servlet.http.HttpServletRequest#isSecure()
boolean checkNotModified(long lastModifiedTimestamp)
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"; }
lastModifiedTimestamp
- the last-modified timestamp that
the application determined for the underlying resource
java.lang.String getDescription(boolean includeClientInfo)
includeClientInfo
- whether to include client-specific
information such as session id and user name
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |