org.apache.pluto.core.impl

Class PortletResponseImpl

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.apache.pluto.core.impl.PortletResponseImpl

All Implemented Interfaces:

javax.portlet.PortletResponse, javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, InternalPortletResponse

Direct Known Subclasses:

ActionResponseImpl, RenderResponseImpl

public abstract class PortletResponseImpl
extends javax.servlet.http.HttpServletResponseWrapper
implements InternalPortletResponse, javax.portlet.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_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

Constructors

Constructor and Description
PortletResponseImpl(PortletWindow portletWindow, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.servlet.http.HttpServletResponse	_getHttpServletResponse()
void	addCookie(javax.servlet.http.Cookie cookie)
void	addDateHeader(java.lang.String name, long date)
void	addHeader(java.lang.String name, java.lang.String value)
void	addIntHeader(java.lang.String name, int value)
void	addProperty(java.lang.String key, java.lang.String value)
boolean	containsHeader(java.lang.String name)
java.lang.String	encodeRedirectUrl(java.lang.String url) Deprecated. use encodeRedirectURL instead
java.lang.String	encodeRedirectURL(java.lang.String url)
java.lang.String	encodeUrl(java.lang.String url)
java.lang.String	encodeURL(java.lang.String path)
protected javax.servlet.http.HttpServletRequest	getHttpServletRequest()
PortletWindow	getInternalPortletWindow()
javax.servlet.ServletOutputStream	getOutputStream()
java.io.PrintWriter	getWriter()
boolean	isIncluded()
void	lateInit(javax.servlet.http.HttpServletRequest webModuleServletRequest, javax.servlet.http.HttpServletResponse webModuleServletResponse)
void	sendError(int sc)
void	sendError(int sc, java.lang.String msg)
void	sendRedirect(java.lang.String location)
void	setContentLength(int len)
void	setDateHeader(java.lang.String name, long date)
void	setHeader(java.lang.String name, java.lang.String value)
void	setIncluded(boolean included)
void	setIntHeader(java.lang.String name, int value)
void	setLocale(java.util.Locale loc)
void	setProperty(java.lang.String key, java.lang.String value)
void	setStatus(int sc)
void	setStatus(int sc, java.lang.String sm) Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getLocale, getResponse, isCommitted, reset, resetBuffer, setBufferSize, setContentType, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getLocale, isCommitted, reset, resetBuffer, setBufferSize, setContentType

Constructor Detail

PortletResponseImpl

public PortletResponseImpl(PortletWindow portletWindow,
                   javax.servlet.http.HttpServletRequest servletRequest,
                   javax.servlet.http.HttpServletResponse servletResponse)

Method Detail

addProperty

public void addProperty(java.lang.String key,
               java.lang.String value)

Specified by:

addProperty in interface javax.portlet.PortletResponse

setProperty

public void setProperty(java.lang.String key,
               java.lang.String value)

Specified by:

setProperty in interface javax.portlet.PortletResponse

encodeURL

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

Specified by:

encodeURL in interface javax.portlet.PortletResponse

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeURL in class javax.servlet.http.HttpServletResponseWrapper

lateInit

public void lateInit(javax.servlet.http.HttpServletRequest webModuleServletRequest,
            javax.servlet.http.HttpServletResponse webModuleServletResponse)

Specified by:

lateInit in interface InternalPortletResponse

_getHttpServletResponse

protected javax.servlet.http.HttpServletResponse _getHttpServletResponse()

getHttpServletRequest

protected javax.servlet.http.HttpServletRequest getHttpServletRequest()

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

Overrides:

addCookie in class javax.servlet.http.HttpServletResponseWrapper

containsHeader

public boolean containsHeader(java.lang.String name)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

containsHeader in class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String url)

Deprecated. use encodeRedirectURL instead

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectUrl in class javax.servlet.http.HttpServletResponseWrapper

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String url)

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeRedirectURL in class javax.servlet.http.HttpServletResponseWrapper

sendRedirect

public void sendRedirect(java.lang.String location)
                  throws java.io.IOException

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Overrides:

sendRedirect in class javax.servlet.http.HttpServletResponseWrapper

Throws:

java.io.IOException

setDateHeader

public void setDateHeader(java.lang.String name,
                 long date)

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setDateHeader in class javax.servlet.http.HttpServletResponseWrapper

sendError

public void sendError(int sc,
             java.lang.String msg)
               throws java.io.IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

java.io.IOException

sendError

public void sendError(int sc)
               throws java.io.IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Overrides:

sendError in class javax.servlet.http.HttpServletResponseWrapper

Throws:

java.io.IOException

addHeader

public void addHeader(java.lang.String name,
             java.lang.String value)

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addHeader in class javax.servlet.http.HttpServletResponseWrapper

setIntHeader

public void setIntHeader(java.lang.String name,
                int value)

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setIntHeader in class javax.servlet.http.HttpServletResponseWrapper

addDateHeader

public void addDateHeader(java.lang.String name,
                 long date)

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addDateHeader in class javax.servlet.http.HttpServletResponseWrapper

setHeader

public void setHeader(java.lang.String name,
             java.lang.String value)

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

setHeader in class javax.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int sc)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

setStatus

public void setStatus(int sc,
             java.lang.String sm)

Deprecated. As of version 2.1, due to ambiguous meaning of the message parameter. To set a status code use setStatus(int), to send an error with a description use sendError(int, String). Sets the status code and message for this response.

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

Overrides:

setStatus in class javax.servlet.http.HttpServletResponseWrapper

addIntHeader

public void addIntHeader(java.lang.String name,
                int value)

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

Overrides:

addIntHeader in class javax.servlet.http.HttpServletResponseWrapper

setContentLength

public void setContentLength(int len)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

Overrides:

setContentLength in class javax.servlet.ServletResponseWrapper

encodeUrl

public java.lang.String encodeUrl(java.lang.String url)

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

Overrides:

encodeUrl in class javax.servlet.http.HttpServletResponseWrapper

setLocale

public void setLocale(java.util.Locale loc)

Specified by:

setLocale in interface javax.servlet.ServletResponse

Overrides:

setLocale in class javax.servlet.ServletResponseWrapper

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.lang.IllegalStateException,
                                                         java.io.IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Overrides:

getOutputStream in class javax.servlet.ServletResponseWrapper

Throws:

java.lang.IllegalStateException

java.io.IOException

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.UnsupportedEncodingException,
                                     java.lang.IllegalStateException,
                                     java.io.IOException

Specified by:

getWriter in interface javax.servlet.ServletResponse

Overrides:

getWriter in class javax.servlet.ServletResponseWrapper

Throws:

java.io.UnsupportedEncodingException

java.lang.IllegalStateException

java.io.IOException

getInternalPortletWindow

public PortletWindow getInternalPortletWindow()

Specified by:

getInternalPortletWindow in interface InternalPortletResponse

setIncluded

public void setIncluded(boolean included)

Specified by:

setIncluded in interface InternalPortletResponse

isIncluded

public boolean isIncluded()

Specified by:

isIncluded in interface InternalPortletResponse