com.ibm.wps.pe.pc.legacy.cmpf
Class PortletResponseWrapper

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          com.ibm.wps.pe.pc.legacy.cmpf.PortletResponseWrapper

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, org.apache.jetspeed.portlet.PortletResponse

public class PortletResponseWrapper
extends javax.servlet.http.HttpServletResponseWrapper
implements org.apache.jetspeed.portlet.PortletResponse

Provides a convenient implementation of the PortletResponse interface that can be subclassed by developers who wish to wrap the response from a Portlet. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped response object.

Since:

5.0

See Also:

PortletResponse

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

PortletResponseWrapper(org.apache.jetspeed.portlet.PortletResponse response)
Creates a PortletResponse adaptor wrapping the specified response object.

Method Summary

org.apache.jetspeed.portlet.PortletURI	createReturnURI()
org.apache.jetspeed.portlet.PortletURI	createURI()
org.apache.jetspeed.portlet.PortletURI	createURI(org.apache.jetspeed.portlet.PortletWindow.State state)
java.lang.String	encodeNamespace(java.lang.String aValue)
java.lang.String	encodeURI(java.lang.String path)
java.lang.String	getCharacterSet()
java.lang.String	getContentType()
protected org.apache.jetspeed.portlet.PortletResponse	getPortletResponse() Return the wrapped ServletResponse object.

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jetspeed.portlet.PortletResponse

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeURL, getCharacterEncoding, getWriter, setDateHeader, setHeader, setIntHeader

Methods inherited from interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl, encodeRedirectURL, encodeUrl, sendError, sendError, sendRedirect, setStatus, setStatus

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getLocale, getOutputStream, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Constructor Detail

PortletResponseWrapper

public PortletResponseWrapper(org.apache.jetspeed.portlet.PortletResponse response)

Creates a PortletResponse adaptor wrapping the specified response object.

Parameters:

response - the portlet response

Throws:

java.lang.IllegalArgumentException - if the response is null.

Method Detail

getPortletResponse

protected org.apache.jetspeed.portlet.PortletResponse getPortletResponse()

Return the wrapped ServletResponse object.

createURI

public org.apache.jetspeed.portlet.PortletURI createURI()

Specified by:

createURI in interface org.apache.jetspeed.portlet.PortletResponse

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

Specified by:

getContentType in interface org.apache.jetspeed.portlet.PortletResponse

Overrides:

getContentType in class javax.servlet.ServletResponseWrapper

createURI

public org.apache.jetspeed.portlet.PortletURI createURI(org.apache.jetspeed.portlet.PortletWindow.State state)

Specified by:

createURI in interface org.apache.jetspeed.portlet.PortletResponse

getCharacterSet

public java.lang.String getCharacterSet()

Specified by:

getCharacterSet in interface org.apache.jetspeed.portlet.PortletResponse

encodeNamespace

public java.lang.String encodeNamespace(java.lang.String aValue)

Specified by:

encodeNamespace in interface org.apache.jetspeed.portlet.PortletResponse

createReturnURI

public org.apache.jetspeed.portlet.PortletURI createReturnURI()

Specified by:

createReturnURI in interface org.apache.jetspeed.portlet.PortletResponse

encodeURI

public java.lang.String encodeURI(java.lang.String path)

Specified by:

encodeURI in interface org.apache.jetspeed.portlet.PortletResponse