|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.portlet.filter.PortletRequestWrapper javax.portlet.filter.ResourceRequestWrapper
public class ResourceRequestWrapper
The ResourceRequestWrapper
provides a convenient
implementation of the ResourceRequest
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.
ResourceRequest
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.portlet.PortletRequest |
---|
PortletRequest.P3PUserInfos |
Field Summary |
---|
Fields inherited from interface javax.portlet.ResourceRequest |
---|
ETAG |
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 | |
---|---|
ResourceRequestWrapper(ResourceRequest request)
Creates an ResourceRequest adaptor
wrapping the given request object. |
Method Summary | |
---|---|
java.lang.String |
getCacheability()
The default behavior of this method is to call getCacheability() on the wrapped response object. |
java.lang.String |
getCharacterEncoding()
The default behavior of this method is to call getCharacterEncoding() on the wrapped request object. |
int |
getContentLength()
The default behavior of this method is to call getContentLength() on the wrapped request object. |
java.lang.String |
getContentType()
The default behavior of this method is to call getContentType() on the wrapped request object. |
java.lang.String |
getETag()
The default behavior of this method is to call getETag() on the wrapped request object. |
java.lang.String |
getMethod()
The default behavior of this method is to call getMethod() on the wrapped request object. |
java.io.InputStream |
getPortletInputStream()
The default behavior of this method is to call getPortletInputStream() on the wrapped request object. |
java.util.Map<java.lang.String,java.lang.String[]> |
getPrivateRenderParameterMap()
The default behavior of this method is to call getPrivateRenderParameterMap() on the wrapped request object. |
java.io.BufferedReader |
getReader()
The default behavior of this method is to call getReader() on the wrapped request object. |
ResourceRequest |
getRequest()
Return the wrapped request object. |
java.lang.String |
getResourceID()
The default behavior of this method is to call getResourceID() on the wrapped request object. |
void |
setCharacterEncoding(java.lang.String enc)
The default behavior of this method is to call setCharacterEncoding(String enc)
on the wrapped request object. |
void |
setRequest(ResourceRequest request)
Sets the request object being wrapped. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.portlet.ResourceRequest |
---|
getResponseContentType, getResponseContentTypes |
Constructor Detail |
---|
public ResourceRequestWrapper(ResourceRequest request)
ResourceRequest
adaptor
wrapping the given request object.
request
- the resource request to wrap
java.lang.IllegalArgumentException
- if the request is null
Method Detail |
---|
public java.io.InputStream getPortletInputStream() throws java.io.IOException
getPortletInputStream()
on the wrapped request object.
getPortletInputStream
in interface ClientDataRequest
java.io.IOException
- if an input or output exception occurredpublic java.io.BufferedReader getReader() throws java.io.UnsupportedEncodingException, java.io.IOException
getReader()
on the wrapped request object.
getReader
in interface ClientDataRequest
BufferedReader
containing the body of the request
java.io.UnsupportedEncodingException
- if the character set encoding used is
not supported and the text cannot be decoded
java.io.IOException
- if an input or output exception occurredClientDataRequest.getPortletInputStream()
public void setCharacterEncoding(java.lang.String enc) throws java.io.UnsupportedEncodingException
setCharacterEncoding(String enc)
on the wrapped request object.
setCharacterEncoding
in interface ClientDataRequest
enc
- a String
containing the name of
the character encoding.
java.io.UnsupportedEncodingException
- if this is not a valid encodingpublic ResourceRequest getRequest()
getRequest
in class PortletRequestWrapper
public void setRequest(ResourceRequest request)
request
- the request to set
java.lang.IllegalArgumentException
- if the request is null.public java.lang.String getCharacterEncoding()
getCharacterEncoding()
on the wrapped request object.
getCharacterEncoding
in interface ClientDataRequest
String
containing the name of
the character encoding, or null
if the request does not specify a character encoding.public int getContentLength()
getContentLength()
on the wrapped request object.
getContentLength
in interface ClientDataRequest
public java.lang.String getContentType()
getContentType()
on the wrapped request object.
getContentType
in interface ClientDataRequest
String
containing the name
of the MIME type of the request, or null
if the type is not known.public java.lang.String getETag()
getETag()
on the wrapped request object.
getETag
in interface ResourceRequest
null
if no cached response exists.public java.lang.String getMethod()
getMethod()
on the wrapped request object.
getMethod
in interface ClientDataRequest
public java.lang.String getResourceID()
getResourceID()
on the wrapped request object.
getResourceID
in interface ResourceRequest
null
if no resource ID was set on the URL.public java.util.Map<java.lang.String,java.lang.String[]> getPrivateRenderParameterMap()
getPrivateRenderParameterMap()
on the wrapped request object.
getPrivateRenderParameterMap
in interface ResourceRequest
Map
containing private parameter names as
keys and private parameter values as map values, or an empty Map
if no private parameters exist. The keys in the parameter
map are of type String. The values in the parameter map are of type
String array (String[]
).public java.lang.String getCacheability()
getCacheability()
on the wrapped response object.
getCacheability
in interface ResourceRequest
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |