public class PortletWebRequest extends PortletRequestAttributes implements NativeWebRequest
WebRequest adapter
for a PortletRequest.DESTRUCTION_CALLBACK_NAME_PREFIXrequestDestructionCallbacksREFERENCE_REQUEST, REFERENCE_SESSION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION| Constructor and Description |
|---|
PortletWebRequest(PortletRequest request)
Create a new PortletWebRequest instance for the given request.
|
PortletWebRequest(PortletRequest request,
PortletResponse response)
Create a new PortletWebRequest instance for the given request/response pair.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
checkNotModified(long lastModifiedTimestamp)
Last-modified handling not supported for portlet requests:
As a consequence, this method always returns
false. |
boolean |
checkNotModified(java.lang.String eTag)
Last-modified handling not supported for portlet requests:
As a consequence, this method always returns
false. |
boolean |
checkNotModified(java.lang.String etag,
long lastModifiedTimestamp)
Last-modified handling not supported for portlet requests:
As a consequence, this method always returns
false. |
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.Object |
getNativeRequest()
Return the underlying native request object.
|
<T> T |
getNativeRequest(java.lang.Class<T> requiredType)
Return the underlying native request object, if available.
|
java.lang.Object |
getNativeResponse()
Return the underlying native response object, if any.
|
<T> T |
getNativeResponse(java.lang.Class<T> requiredType)
Return the underlying native response object, if available.
|
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.
|
java.lang.String |
toString() |
getAttribute, getAttributeNames, getRequest, getResponse, getSession, getSessionId, getSessionMutex, registerDestructionCallback, registerSessionDestructionCallback, removeAttribute, resolveReference, setAttribute, updateAccessedSessionAttributesisRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompletedclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttributepublic PortletWebRequest(PortletRequest request)
request - current portlet requestpublic PortletWebRequest(PortletRequest request, PortletResponse response)
request - current portlet requestresponse - current portlet responsepublic java.lang.Object getNativeRequest()
NativeWebRequestgetNativeRequest in interface NativeWebRequestHttpServletRequest,
ActionRequest,
RenderRequestpublic java.lang.Object getNativeResponse()
NativeWebRequestgetNativeResponse in interface NativeWebRequestHttpServletResponse,
ActionResponse,
RenderResponsepublic <T> T getNativeRequest(java.lang.Class<T> requiredType)
NativeWebRequestgetNativeRequest in interface NativeWebRequestrequiredType - the desired type of request objectnull if none
of that type is availableHttpServletRequest,
ActionRequest,
RenderRequestpublic <T> T getNativeResponse(java.lang.Class<T> requiredType)
NativeWebRequestgetNativeResponse in interface NativeWebRequestrequiredType - the desired type of response objectnull if none
of that type is availableHttpServletResponse,
ActionResponse,
RenderResponsepublic java.lang.String getHeader(java.lang.String headerName)
WebRequestnull if none.
Retrieves the first header value in case of a multi-value header.
getHeader in interface WebRequestHttpServletRequest.getHeader(String)public java.lang.String[] getHeaderValues(java.lang.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 java.util.Iterator<java.lang.String> getHeaderNames()
WebRequestgetHeaderNames in interface WebRequestHttpServletRequest.getHeaderNames()public java.lang.String getParameter(java.lang.String paramName)
WebRequestnull if none.
Retrieves the first parameter value in case of a multi-value parameter.
getParameter in interface WebRequestServletRequest.getParameter(String)public java.lang.String[] getParameterValues(java.lang.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 java.util.Iterator<java.lang.String> getParameterNames()
WebRequestgetParameterNames in interface WebRequestServletRequest.getParameterNames()public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
WebRequestA single-value parameter will be exposed as an array with a single element.
getParameterMap in interface WebRequestServletRequest.getParameterMap()public java.util.Locale getLocale()
WebRequestgetLocale in interface WebRequestServletRequest.getLocale()public java.lang.String getContextPath()
WebRequestgetContextPath in interface WebRequestHttpServletRequest.getContextPath()public java.lang.String getRemoteUser()
WebRequestgetRemoteUser in interface WebRequestHttpServletRequest.getRemoteUser()public java.security.Principal getUserPrincipal()
WebRequestgetUserPrincipal in interface WebRequestHttpServletRequest.getUserPrincipal()public boolean isUserInRole(java.lang.String role)
WebRequestisUserInRole in interface WebRequestHttpServletRequest.isUserInRole(String)public boolean isSecure()
WebRequestisSecure in interface WebRequestServletRequest.isSecure()public boolean checkNotModified(long lastModifiedTimestamp)
false.checkNotModified in interface WebRequestlastModifiedTimestamp - the last-modified timestamp in
milliseconds that the application determined for the underlying
resourcepublic boolean checkNotModified(java.lang.String eTag)
false.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 checkNotModified(java.lang.String etag,
long lastModifiedTimestamp)
false.checkNotModified in interface WebRequestetag - 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
resourcepublic java.lang.String getDescription(boolean includeClientInfo)
WebRequestgetDescription in interface WebRequestincludeClientInfo - whether to include client-specific
information such as session id and user namepublic java.lang.String toString()
toString in class PortletRequestAttributes