public class PortletWebRequest extends PortletRequestAttributes implements NativeWebRequest
WebRequest
adapter
for a PortletRequest
.DESTRUCTION_CALLBACK_NAME_PREFIX
requestDestructionCallbacks
REFERENCE_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(String eTag)
Last-modified handling not supported for portlet requests:
As a consequence, this method always returns
false . |
boolean |
checkNotModified(String etag,
long lastModifiedTimestamp)
Last-modified handling not supported for portlet requests:
As a consequence, this method always returns
false . |
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.
|
<T> T |
getNativeRequest(Class<T> requiredType)
Return the underlying native request object, if available.
|
Object |
getNativeResponse()
Return the underlying native response object, if available.
|
<T> T |
getNativeResponse(Class<T> requiredType)
Return the underlying native response 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.
|
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(String role)
Determine whether the user is in the given role for this request.
|
String |
toString() |
getAttribute, getAttributeNames, getRequest, getResponse, getSession, getSessionId, getSessionMutex, registerDestructionCallback, registerSessionDestructionCallback, removeAttribute, resolveReference, setAttribute, updateAccessedSessionAttributes
isRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, resolveReference, setAttribute
public PortletWebRequest(PortletRequest request)
request
- current portlet requestpublic PortletWebRequest(PortletRequest request, PortletResponse response)
request
- current portlet requestresponse
- current portlet responsepublic 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 objectnull
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 objectnull
if none
of that type is availableHttpServletResponse
,
ActionResponse
,
RenderResponse
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)
false
.checkNotModified
in interface WebRequest
lastModifiedTimestamp
- the last-modified timestamp that
the application determined for the underlying resourcepublic boolean checkNotModified(String eTag)
false
.checkNotModified
in interface WebRequest
eTag
- the entity tag that the application determined
for the underlying resource. This parameter will be padded
with quotes (") if necessary.public boolean checkNotModified(String etag, long lastModifiedTimestamp)
false
.checkNotModified
in interface WebRequest
etag
- 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 that
the application determined for the underlying resourcepublic String getDescription(boolean includeClientInfo)
WebRequest
getDescription
in interface WebRequest
includeClientInfo
- whether to include client-specific
information such as session id and user namepublic String toString()
toString
in class PortletRequestAttributes