Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.portlet.filter
Class ResourceRequestWrapper

    java.lang.Object
      javax.portlet.filter.PortletRequestWrapper
          javax.portlet.filter.ResourceRequestWrapper

All Implemented Interfaces
  ClientDataRequest, PortletRequest, ResourceRequest

    public class ResourceRequestWrapper

extends PortletRequestWrapper
implements ResourceRequest

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.

Since:
  2.0
See Also
  `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
`String` | `getCacheability()` The default behavior of this method is to call `getCacheability()` on the wrapped response object.
`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.
`String` | `getContentType()` The default behavior of this method is to call `getContentType()` on the wrapped request object.
`String` | `getETag()` The default behavior of this method is to call `getETag()` on the wrapped request object.
`String` | `getMethod()` The default behavior of this method is to call `getMethod()` on the wrapped request object.
`InputStream` | `getPortletInputStream()` The default behavior of this method is to call `getPortletInputStream()` on the wrapped request object.
`Map<String,String[]>` | `getPrivateRenderParameterMap()` The default behavior of this method is to call `getPrivateRenderParameterMap()` on the wrapped request object.
`BufferedReader` | `getReader()` The default behavior of this method is to call `getReader()` on the wrapped request object.
`ResourceRequest` | `getRequest()` Return the wrapped request object.
`String` | `getResourceID()` The default behavior of this method is to call `getResourceID()` on the wrapped request object.
`void` | `setCharacterEncoding(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 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.ResourceRequest
`getResponseContentType, getResponseContentTypes`

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, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute`

Constructor Detail

### ResourceRequestWrapper

    public ResourceRequestWrapper(ResourceRequest request)

  Creates an `ResourceRequest` adaptor wrapping the given request object.

  Parameters
    `request` - the resource request to wrap
  Throws
    `IllegalArgumentException` - if the request is `null`

Method Detail

### getPortletInputStream

    public InputStream getPortletInputStream()
                                      throws IOException

  The default behavior of this method is to call `getPortletInputStream()` on the wrapped request object.

  Specified by:
    `getPortletInputStream` in interface `ClientDataRequest`
  Returns
    an input stream containing the body of the request
  Throws
    `IOException` - if an input or output exception occurred

### getReader

    public BufferedReader getReader()
                             throws UnsupportedEncodingException,
                                    IOException

  The default behavior of this method is to call `getReader()` on the wrapped request object.

  Specified by:
    `getReader` in interface `ClientDataRequest`
  Returns
    a `BufferedReader` containing the body of the request
  Throws
    `UnsupportedEncodingException` - if the character set encoding used is not supported and the text cannot be decoded
    `IOException` - if an input or output exception occurred
  See Also
    `ClientDataRequest.getPortletInputStream()`

### setCharacterEncoding

    public void setCharacterEncoding(String enc)
                              throws UnsupportedEncodingException

  The default behavior of this method is to call `setCharacterEncoding(String enc)` on the wrapped request object.

  Specified by:
    `setCharacterEncoding` in interface `ClientDataRequest`
  Parameters
    `enc` - a `String` containing the name of the character encoding.
  Throws
    `UnsupportedEncodingException` - if this is not a valid encoding

### getRequest

    public ResourceRequest getRequest()

  Return the wrapped request object.

  Overrides:
    `getRequest` in class `PortletRequestWrapper`
  Returns
    the wrapped request

### setRequest

    public void setRequest(ResourceRequest request)

  Sets the request object being wrapped.

  Parameters
    `request` - the request to set
  Throws
    `IllegalArgumentException` - if the request is null.

### getCharacterEncoding

    public String getCharacterEncoding()

  The default behavior of this method is to call `getCharacterEncoding()` on the wrapped request object.

  Specified by:
    `getCharacterEncoding` in interface `ClientDataRequest`
  Returns
    a `String` containing the name of the character encoding, or `null` if the request does not specify a character encoding.

### getContentLength

    public int getContentLength()

  The default behavior of this method is to call `getContentLength()` on the wrapped request object.

  Specified by:
    `getContentLength` in interface `ClientDataRequest`
  Returns
    an integer containing the length of the request body or -1 if the length is not known

### getContentType

    public String getContentType()

  The default behavior of this method is to call `getContentType()` on the wrapped request object.

  Specified by:
    `getContentType` in interface `ClientDataRequest`
  Returns
    a `String` containing the name of the MIME type of the request, or null if the type is not known.

### getETag

    public String getETag()

  The default behavior of this method is to call `getETag()` on the wrapped request object.

  Specified by:
    `getETag` in interface `ResourceRequest`
  Returns
    the validation tag if the portlet container has a cached response for this validation tag, or `null` if no cached response exists.

### getMethod

    public String getMethod()

  The default behavior of this method is to call `getMethod()` on the wrapped request object.

  Specified by:
    `getMethod` in interface `ClientDataRequest`
  Returns
    a String specifying the name of the HTTP method with which this request was made

### getResourceID

    public String getResourceID()

  The default behavior of this method is to call `getResourceID()` on the wrapped request object.

  Specified by:
    `getResourceID` in interface `ResourceRequest`
  Returns
    the resource ID set on the ResourceURL,or `null` if no resource ID was set on the URL.

### getPrivateRenderParameterMap

    public Map<String,String[]> getPrivateRenderParameterMap()

  The default behavior of this method is to call `getPrivateRenderParameterMap()` on the wrapped request object.

  Specified by:
    `getPrivateRenderParameterMap` in interface `ResourceRequest`
  Returns
    an immutable `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[]`).

### getCacheability

    public String getCacheability()

  The default behavior of this method is to call `getCacheability()` on the wrapped response object.

  Specified by:
    `getCacheability` in interface `ResourceRequest`
  Returns
    the cache level of this resource request.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
Other names may be trademarks of their respective owners.