Package javax.portlet.filter
Class ActionRequestWrapper
- java.lang.Object
-
- javax.portlet.filter.PortletRequestWrapper
-
- javax.portlet.filter.ActionRequestWrapper
-
- All Implemented Interfaces:
ActionRequest
,ClientDataRequest
,PortletRequest
public class ActionRequestWrapper extends PortletRequestWrapper implements ActionRequest
TheActionRequestWrapper
provides a convenient implementation of theActionRequest
interface that can be subclassed by developers wishing to adapt the request. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped request object.- Since:
- 2.0
- See Also:
ActionRequest
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest
PortletRequest.P3PUserInfos
-
-
Field Summary
Fields Modifier and Type Field Description (package private) ActionRequest
request
-
Fields inherited from interface javax.portlet.ActionRequest
ACTION_NAME
-
Fields inherited from interface javax.portlet.PortletRequest
ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO
-
-
Constructor Summary
Constructors Constructor Description ActionRequestWrapper(ActionRequest request)
Creates anActionRequest
adaptor wrapping the given request object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCharacterEncoding()
The default behavior of this method is to callgetCharacterEncoding()
on the wrapped request object.int
getContentLength()
The default behavior of this method is to callgetContentLength()
on the wrapped request object.java.lang.String
getContentType()
The default behavior of this method is to callgetContentType()
on the wrapped request object.java.lang.String
getMethod()
The default behavior of this method is to callgetMethod()
on the wrapped request object.java.io.InputStream
getPortletInputStream()
The default behavior of this method is to callgetPortletInputStream()
on the wrapped request object.java.io.BufferedReader
getReader()
The default behavior of this method is to callgetReader()
on the wrapped request object.ActionRequest
getRequest()
Return the wrapped request object.void
setCharacterEncoding(java.lang.String enc)
The default behavior of this method is to callsetCharacterEncoding(String enc)
on the wrapped request object.void
setRequest(ActionRequest request)
Sets the request object being wrapped.-
Methods inherited from class javax.portlet.filter.PortletRequestWrapper
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute, setRequest
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.portlet.PortletRequest
getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute
-
-
-
-
Field Detail
-
request
ActionRequest request
-
-
Constructor Detail
-
ActionRequestWrapper
public ActionRequestWrapper(ActionRequest request)
Creates anActionRequest
adaptor wrapping the given request object.- Parameters:
request
- the action request to wrap- Throws:
java.lang.IllegalArgumentException
- if the request isnull
-
-
Method Detail
-
getCharacterEncoding
public java.lang.String getCharacterEncoding()
The default behavior of this method is to callgetCharacterEncoding()
on the wrapped request object.- Specified by:
getCharacterEncoding
in interfaceClientDataRequest
- Returns:
- a
String
containing the name of the character encoding, ornull
if the request does not specify a character encoding.
-
getContentLength
public int getContentLength()
The default behavior of this method is to callgetContentLength()
on the wrapped request object.- Specified by:
getContentLength
in interfaceClientDataRequest
- Returns:
- an integer containing the length of the request body or -1 if the length is not known
-
getContentType
public java.lang.String getContentType()
The default behavior of this method is to callgetContentType()
on the wrapped request object.- Specified by:
getContentType
in interfaceClientDataRequest
- Returns:
- a
String
containing the name of the MIME type of the request, or null if the type is not known.
-
getPortletInputStream
public java.io.InputStream getPortletInputStream() throws java.io.IOException
The default behavior of this method is to callgetPortletInputStream()
on the wrapped request object.- Specified by:
getPortletInputStream
in interfaceClientDataRequest
- Returns:
- an input stream containing the body of the request
- Throws:
java.io.IOException
- if an input or output exception occurred
-
getReader
public java.io.BufferedReader getReader() throws java.io.UnsupportedEncodingException, java.io.IOException
The default behavior of this method is to callgetReader()
on the wrapped request object.- Specified by:
getReader
in interfaceClientDataRequest
- Returns:
- a
BufferedReader
containing the body of the request - Throws:
java.io.UnsupportedEncodingException
- if the character set encoding used is not supported and the text cannot be decodedjava.io.IOException
- if an input or output exception occurred- See Also:
ClientDataRequest.getPortletInputStream()
-
setCharacterEncoding
public void setCharacterEncoding(java.lang.String enc) throws java.io.UnsupportedEncodingException
The default behavior of this method is to callsetCharacterEncoding(String enc)
on the wrapped request object.- Specified by:
setCharacterEncoding
in interfaceClientDataRequest
- Parameters:
enc
- aString
containing the name of the character encoding.- Throws:
java.io.UnsupportedEncodingException
- if this is not a valid encoding
-
getRequest
public ActionRequest getRequest()
Return the wrapped request object.- Overrides:
getRequest
in classPortletRequestWrapper
- Returns:
- the wrapped request
-
setRequest
public void setRequest(ActionRequest request)
Sets the request object being wrapped.- Parameters:
request
- the request to set- Throws:
java.lang.IllegalArgumentException
- if the request is null.
-
getMethod
public java.lang.String getMethod()
The default behavior of this method is to callgetMethod()
on the wrapped request object.- Specified by:
getMethod
in interfaceClientDataRequest
- Returns:
- a String specifying the name of the HTTP method with which this request was made
-
-