org.springframework.web.context.request.NativeWebRequest |
Known Indirect Subclasses
|
Class Overview
Extension of the WebRequest
interface, exposing the
native request and response objects in a generic fashion.
Mainly intended for framework-internal usage,
in particular for generic argument resolution code.
Summary
[Expand]
Inherited Methods |
From interface
org.springframework.web.context.request.RequestAttributes
abstract
Object
|
getAttribute(String name, int scope)
Return the value for the scoped attribute of the given name, if any.
|
abstract
String[]
|
getAttributeNames(int scope)
Retrieve the names of all attributes in the scope.
|
abstract
String
|
getSessionId()
Return an id for the current underlying session.
|
abstract
Object
|
getSessionMutex()
Expose the best available mutex for the underlying session:
that is, an object to synchronize on for the underlying session.
|
abstract
void
|
registerDestructionCallback(String name, Runnable callback, int scope)
Register a callback to be executed on destruction of the
specified attribute in the given scope.
|
abstract
void
|
removeAttribute(String name, int scope)
Remove the scoped attribute of the given name, if it exists.
|
abstract
Object
|
resolveReference(String key)
Resolve the contextual reference for the given key, if any.
|
abstract
void
|
setAttribute(String name, Object value, int scope)
Set the value for the scoped attribute of the given name,
replacing an existing value (if any).
|
|
From interface
org.springframework.web.context.request.WebRequest
abstract
boolean
|
checkNotModified(String eTag)
Check whether the request qualifies as not modified given the
supplied ETag (entity tag), as determined by the application.
|
abstract
boolean
|
checkNotModified(long lastModifiedTimestamp)
Check whether the request qualifies as not modified given the
supplied last-modified timestamp (as determined by the application).
|
abstract
String
|
getContextPath()
Return the context path for this request
(usually the base path that the current web application is mapped to).
|
abstract
String
|
getDescription(boolean includeClientInfo)
Get a short description of this request,
typically containing request URI and session id.
|
abstract
String
|
getHeader(String headerName)
Return the request header of the given name, or null if none.
|
abstract
Iterator<String>
|
getHeaderNames()
Return a Iterator over request header names.
|
abstract
String[]
|
getHeaderValues(String headerName)
Return the request header values for the given header name,
or null if none.
|
abstract
Locale
|
getLocale()
Return the primary Locale for this request.
|
abstract
String
|
getParameter(String paramName)
Return the request parameter of the given name, or null if none.
|
abstract
Map<String, String[]>
|
getParameterMap()
Return a immutable Map of the request parameters, with parameter names as map keys
and parameter values as map values.
|
abstract
Iterator<String>
|
getParameterNames()
Return a Iterator over request parameter names.
|
abstract
String[]
|
getParameterValues(String paramName)
Return the request parameter values for the given parameter name,
or null if none.
|
abstract
String
|
getRemoteUser()
Return the remote user for this request, if any.
|
abstract
Principal
|
getUserPrincipal()
Return the user principal for this request, if any.
|
abstract
boolean
|
isSecure()
Return whether this request has been sent over a secure transport
mechanism (such as SSL).
|
abstract
boolean
|
isUserInRole(String role)
Determine whether the user is in the given role for this request.
|
|
Public Methods
public
abstract
T
getNativeRequest
(Class<T> requiredType)
Return the underlying native request object, if available.
Parameters
requiredType
| the desired type of request object |
Returns
- the matching request object, or
null
if none
of that type is available
See Also
- javax.servlet.http.HttpServletRequest
- javax.portlet.ActionRequest
- javax.portlet.RenderRequest
public
abstract
Object
getNativeRequest
()
Return the underlying native request object, if available.
See Also
- javax.servlet.http.HttpServletRequest
- javax.portlet.ActionRequest
- javax.portlet.RenderRequest
public
abstract
T
getNativeResponse
(Class<T> requiredType)
Return the underlying native request object, if available.
Parameters
requiredType
| the desired type of response object |
Returns
- the matching response object, or
null
if none
of that type is available
See Also
- javax.servlet.http.HttpServletRequest
- javax.portlet.ActionRequest
- javax.portlet.RenderRequest
public
abstract
Object
getNativeResponse
()
Return the underlying native response object, if available.
See Also
- javax.servlet.http.HttpServletResponse
- javax.portlet.ActionResponse
- javax.portlet.RenderResponse