org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp
Class PortletResponseImp

java.lang.Object
  javax.servlet.ServletResponseWrapper
      javax.servlet.http.HttpServletResponseWrapper
          org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.PortletResponseImp

All Implemented Interfaces:

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

Direct Known Subclasses:

MimeResponseImp, StateAwareResponseImp

public class PortletResponseImp
extends javax.servlet.http.HttpServletResponseWrapper
implements javax.portlet.PortletResponse

Author:

: Mestrallet Benjamin benjmestrallet@users.sourceforge.net

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

PortletResponseImp(ResponseContext resCtx)

Method Summary

void	addProperty(javax.servlet.http.Cookie cookie) Overridden method.
void	addProperty(String key, Element element) Overridden method.
void	addProperty(String name, String value) Overridden method.
Element	createElement(String name) Overridden method.
javax.portlet.PortletURL	createRenderURL()
String	encodeURL(String path) Overridden method.
protected org.exoplatform.container.ExoContainer	getCont()
protected Input	getInput()
String	getNamespace() Overridden method.
Output	getOutput()
protected Portlet	getPortletDatas()
protected String	getProperty(String name)
protected ResponseContext	getResCtx()
protected String	getWindowId()
boolean	isAlreadyForwarded()
protected boolean	isCurrentlySecured()
protected boolean	isRedirectionPossible()
boolean	isSendRedirectAlreadyOccured()
protected void	removeProperty(String name)
void	setAlreadyForwarded() Already forwarded.
protected void	setInput(Input input)
void	setOutput(Output o)
protected void	setPortletDatas(Portlet portletDatas)
void	setProperty(String name, String value) Overridden method.
protected void	setRedirectionPossible(boolean redirectionPossible)
protected void	setResCtx(ResponseContext resCtx)
void	setSendRedirectAlreadyOccured(boolean sendRedirectAlreadyOccured)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

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

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, 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 javax.servlet.ServletResponse

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

Constructor Detail

PortletResponseImp

public PortletResponseImp(ResponseContext resCtx)

Parameters:

resCtx - response context

Method Detail

addProperty

public final void addProperty(String name,
                              String value)

Overridden method.

Specified by:

addProperty in interface javax.portlet.PortletResponse

Parameters:

name - name

value - value

See Also:

PortletResponse.addProperty(java.lang.String, java.lang.String)

setProperty

public final void setProperty(String name,
                              String value)

Overridden method.

Specified by:

setProperty in interface javax.portlet.PortletResponse

Parameters:

name - name

value - value

See Also:

PortletResponse.setProperty(java.lang.String, java.lang.String)

getProperty

protected final String getProperty(String name)

Parameters:

name - name

Returns:

value

removeProperty

protected final void removeProperty(String name)

Parameters:

name - name

getNamespace

public final String getNamespace()

Overridden method.

Specified by:

getNamespace in interface javax.portlet.PortletResponse

Returns:

namespace

See Also:

PortletResponse.getNamespace()

encodeURL

public final String encodeURL(String path)

Overridden method.

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

Parameters:

path - url

Returns:

encoded url

See Also:

HttpServletResponseWrapper.encodeURL(java.lang.String)

getOutput

public final Output getOutput()

Returns:

output

setOutput

public final void setOutput(Output o)

Parameters:

o - output

isSendRedirectAlreadyOccured

public final boolean isSendRedirectAlreadyOccured()

Returns:

is redirected

setSendRedirectAlreadyOccured

public final void setSendRedirectAlreadyOccured(boolean sendRedirectAlreadyOccured)

Parameters:

sendRedirectAlreadyOccured - is redirected

addProperty

public final void addProperty(javax.servlet.http.Cookie cookie)

Overridden method.

Specified by:

addProperty in interface javax.portlet.PortletResponse

Parameters:

cookie - cookie

See Also:

PortletResponse.addProperty(javax.servlet.http.Cookie)

addProperty

public final void addProperty(String key,
                              Element element)

Overridden method.

Specified by:

addProperty in interface javax.portlet.PortletResponse

Parameters:

key - key

element - element

See Also:

PortletResponse.addProperty(java.lang.String, org.w3c.dom.Element)

createRenderURL

public final javax.portlet.PortletURL createRenderURL()
                                               throws IllegalStateException

Returns:

render url

Throws:

IllegalStateException - exception

createElement

public final Element createElement(String name)
                            throws DOMException

Overridden method.

Specified by:

createElement in interface javax.portlet.PortletResponse

Parameters:

name - element name

Returns:

element

Throws:

DOMException - exception

See Also:

PortletResponse.createElement(java.lang.String)

setAlreadyForwarded

public final void setAlreadyForwarded()

Already forwarded.

isAlreadyForwarded

public final boolean isAlreadyForwarded()

Returns:

is already forwarded

getWindowId

protected final String getWindowId()

Returns:

window id

isCurrentlySecured

protected final boolean isCurrentlySecured()

Returns:

is currently secured

setPortletDatas

protected final void setPortletDatas(Portlet portletDatas)

Parameters:

portletDatas - the portletDatas to set

getPortletDatas

protected final Portlet getPortletDatas()

Returns:

the portletDatas

setRedirectionPossible

protected final void setRedirectionPossible(boolean redirectionPossible)

Parameters:

redirectionPossible - the redirectionPossible to set

isRedirectionPossible

protected final boolean isRedirectionPossible()

Returns:

the redirectionPossible

setInput

protected final void setInput(Input input)

Parameters:

input - the input to set

getInput

protected final Input getInput()

Returns:

the input

getCont

protected final org.exoplatform.container.ExoContainer getCont()

Returns:

the cont

setResCtx

protected final void setResCtx(ResponseContext resCtx)

Parameters:

resCtx - the resCtx to set

getResCtx

protected final ResponseContext getResCtx()

Returns:

the resCtx