|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.springframework.web.context.request.AbstractRequestAttributes
org.springframework.web.portlet.context.PortletRequestAttributes
org.springframework.web.portlet.context.PortletWebRequest
public class PortletWebRequest
WebRequest adapter
for a PortletRequest.
| Field Summary |
|---|
| Fields inherited from class org.springframework.web.context.request.AbstractRequestAttributes |
|---|
requestDestructionCallbacks |
| Fields inherited from interface org.springframework.web.context.request.RequestAttributes |
|---|
SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION |
| Constructor Summary | |
|---|---|
PortletWebRequest(javax.portlet.PortletRequest request)
Create a new PortletWebRequest instance for the given request. |
|
PortletWebRequest(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
Create a new PortletWebRequest instance for the given request/response pair. |
|
| Method Summary | |
|---|---|
boolean |
checkNotModified(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. |
Locale |
getLocale()
Return the primary Locale for this request. |
Object |
getNativeRequest()
Return the underlying native request object, if available. |
Object |
getNativeResponse()
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 |
getParameterMap()
Return a immutable Map of the request parameters, with parameter names as map keys and parameter values as map values. |
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. |
javax.portlet.PortletResponse |
getResponse()
Exposes the native PortletResponse that we're wrapping (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()
|
| Methods inherited from class org.springframework.web.portlet.context.PortletRequestAttributes |
|---|
getAttribute, getAttributeNames, getRequest, getSession, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, setAttribute, updateAccessedSessionAttributes |
| Methods inherited from class org.springframework.web.context.request.AbstractRequestAttributes |
|---|
isRequestActive, registerRequestDestructionCallback, removeRequestDestructionCallback, requestCompleted |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.springframework.web.context.request.RequestAttributes |
|---|
getAttribute, getAttributeNames, getSessionId, getSessionMutex, registerDestructionCallback, removeAttribute, setAttribute |
| Constructor Detail |
|---|
public PortletWebRequest(javax.portlet.PortletRequest request)
request - current portlet request
public PortletWebRequest(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
request - current portlet requestresponse - current portlet response| Method Detail |
|---|
public final javax.portlet.PortletResponse getResponse()
PortletResponse that we're wrapping (if any).
public Object getNativeRequest()
NativeWebRequest
getNativeRequest in interface NativeWebRequestHttpServletRequest,
ActionRequest,
RenderRequestpublic Object getNativeResponse()
NativeWebRequest
getNativeResponse in interface NativeWebRequestHttpServletResponse,
ActionResponse,
RenderResponsepublic String getParameter(String paramName)
WebRequestnull if none.
Retrieves the first parameter value in case of a multi-value parameter.
getParameter in interface WebRequestServletRequest.getParameter(String)public String[] getParameterValues(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 Map getParameterMap()
WebRequestA single-value parameter will be exposed as an array with a single element.
getParameterMap in interface WebRequestServletRequest.getParameterMap()public Locale getLocale()
WebRequest
getLocale in interface WebRequestServletRequest.getLocale()public String getContextPath()
WebRequest
getContextPath in interface WebRequestHttpServletRequest.getContextPath()public String getRemoteUser()
WebRequest
getRemoteUser in interface WebRequestHttpServletRequest.getRemoteUser()public Principal getUserPrincipal()
WebRequest
getUserPrincipal in interface WebRequestHttpServletRequest.getUserPrincipal()public boolean isUserInRole(String role)
WebRequest
isUserInRole in interface WebRequestHttpServletRequest.isUserInRole(String)public boolean isSecure()
WebRequest
isSecure in interface WebRequestServletRequest.isSecure()public boolean checkNotModified(long lastModifiedTimestamp)
false.
checkNotModified in interface WebRequestlastModifiedTimestamp - the last-modified timestamp that
the application determined for the underlying resource
public String getDescription(boolean includeClientInfo)
WebRequest
getDescription in interface WebRequestincludeClientInfo - whether to include client-specific
information such as session id and user name
public String toString()
toString in class PortletRequestAttributes
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||