public class PortletWebRequest extends PortletRequestAttributes implements NativeWebRequest
WebRequest
adapter
for a javax.portlet.PortletRequest
.Modifier and Type | Field and Description |
---|---|
private PortletResponse |
response |
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(java.lang.String eTag)
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, if available.
|
<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 available.
|
<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.
|
PortletResponse |
getResponse()
Exposes the native
PortletResponse that we're wrapping (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, 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 final PortletResponse getResponse()
PortletResponse
that we're wrapping (if any).public java.lang.Object getNativeRequest()
NativeWebRequest
getNativeRequest
in interface NativeWebRequest
javax.servlet.http.HttpServletRequest
,
javax.portlet.ActionRequest
,
javax.portlet.RenderRequest
public java.lang.Object getNativeResponse()
NativeWebRequest
getNativeResponse
in interface NativeWebRequest
javax.servlet.http.HttpServletResponse
,
javax.portlet.ActionResponse
,
javax.portlet.RenderResponse
public <T> T getNativeRequest(java.lang.Class<T> requiredType)
NativeWebRequest
getNativeRequest
in interface NativeWebRequest
requiredType
- the desired type of request objectnull
if none
of that type is availablejavax.servlet.http.HttpServletRequest
,
javax.portlet.ActionRequest
,
javax.portlet.RenderRequest
public <T> T getNativeResponse(java.lang.Class<T> requiredType)
NativeWebRequest
getNativeResponse
in interface NativeWebRequest
requiredType
- the desired type of response objectnull
if none
of that type is availablejavax.servlet.http.HttpServletResponse
,
javax.portlet.ActionResponse
,
javax.portlet.RenderResponse
public java.lang.String getHeader(java.lang.String headerName)
WebRequest
null
if none.
Retrieves the first header value in case of a multi-value header.
getHeader
in interface WebRequest
javax.servlet.http.HttpServletRequest#getHeader(String)
public java.lang.String[] getHeaderValues(java.lang.String headerName)
WebRequest
null
if none.
A single-value header will be exposed as an array with a single element.
getHeaderValues
in interface WebRequest
javax.servlet.http.HttpServletRequest#getHeaders(String)
public java.util.Iterator<java.lang.String> getHeaderNames()
WebRequest
getHeaderNames
in interface WebRequest
javax.servlet.http.HttpServletRequest#getHeaderNames()
public java.lang.String getParameter(java.lang.String paramName)
WebRequest
null
if none.
Retrieves the first parameter value in case of a multi-value parameter.
getParameter
in interface WebRequest
javax.servlet.http.HttpServletRequest#getParameter(String)
public java.lang.String[] getParameterValues(java.lang.String paramName)
WebRequest
null
if none.
A single-value parameter will be exposed as an array with a single element.
getParameterValues
in interface WebRequest
javax.servlet.http.HttpServletRequest#getParameterValues(String)
public java.util.Iterator<java.lang.String> getParameterNames()
WebRequest
getParameterNames
in interface WebRequest
javax.servlet.http.HttpServletRequest#getParameterNames()
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
WebRequest
A single-value parameter will be exposed as an array with a single element.
getParameterMap
in interface WebRequest
javax.servlet.http.HttpServletRequest#getParameterMap()
public java.util.Locale getLocale()
WebRequest
getLocale
in interface WebRequest
javax.servlet.http.HttpServletRequest#getLocale()
public java.lang.String getContextPath()
WebRequest
getContextPath
in interface WebRequest
javax.servlet.http.HttpServletRequest#getContextPath()
public java.lang.String getRemoteUser()
WebRequest
getRemoteUser
in interface WebRequest
javax.servlet.http.HttpServletRequest#getRemoteUser()
public java.security.Principal getUserPrincipal()
WebRequest
getUserPrincipal
in interface WebRequest
javax.servlet.http.HttpServletRequest#getUserPrincipal()
public boolean isUserInRole(java.lang.String role)
WebRequest
isUserInRole
in interface WebRequest
javax.servlet.http.HttpServletRequest#isUserInRole(String)
public boolean isSecure()
WebRequest
isSecure
in interface WebRequest
javax.servlet.http.HttpServletRequest#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(java.lang.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 java.lang.String getDescription(boolean includeClientInfo)
WebRequest
getDescription
in interface WebRequest
includeClientInfo
- whether to include client-specific
information such as session id and user namepublic java.lang.String toString()
toString
in class PortletRequestAttributes