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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ActionResponseImp, EventResponseImp

public class StateAwareResponseImp
extends PortletResponseImp
implements javax.portlet.StateAwareResponse

Author : Alexey Zavizionov alexey.zavizionov@exoplatform.com.ua 25.05.2007.

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

StateAwareResponseImp(ResponseContext resCtx)

Method Summary

javax.portlet.PortletMode	getPortletMode() Overridden method.
java.util.Map	getRenderParameterMap() Overridden method.
javax.portlet.WindowState	getWindowState() Overridden method.
void	removePublicRenderParameter(java.lang.String param) Overridden method.
void	setEvent(javax.xml.namespace.QName name, java.io.Serializable value) Overridden method.
void	setEvent(java.lang.String name, java.io.Serializable value) Overridden method.
void	setPortletMode(javax.portlet.PortletMode portletMode) Overridden method.
void	setRenderParameter(java.lang.String s, java.lang.String s1) Overridden method.
void	setRenderParameter(java.lang.String s, java.lang.String[] strings) Overridden method.
void	setRenderParameters(java.util.Map<java.lang.String,java.lang.String[]> map) Overridden method.
void	setWindowState(javax.portlet.WindowState windowState) Overridden method.
protected boolean	validateByJAXB8_5_2List(java.lang.Object payload)
protected boolean	validateWithJAXB(javax.xml.namespace.QName name, java.io.Serializable payload)

Methods inherited from class org.exoplatform.services.portletcontainer.plugins.pc.portletAPIImp.PortletResponseImp

addProperty, addProperty, addProperty, createElement, createRenderURL, encodeURL, getCont, getInput, getNamespace, getOutput, getPortletDatas, getProperty, getResCtx, getWindowId, isAlreadyForwarded, isCurrentlySecured, isRedirectionPossible, isSendRedirectAlreadyOccured, removeProperty, setAlreadyForwarded, setInput, setOutput, setPortletDatas, setProperty, setRedirectionPossible, setResCtx, setSendRedirectAlreadyOccured

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.portlet.PortletResponse

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty

Methods inherited from interface javax.servlet.ServletResponse

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

Constructor Detail

StateAwareResponseImp

public StateAwareResponseImp(ResponseContext resCtx)

Parameters:

resCtx - response context

Method Detail

setWindowState

public final void setWindowState(javax.portlet.WindowState windowState)
                          throws javax.portlet.WindowStateException

Overridden method.

Specified by:

setWindowState in interface javax.portlet.StateAwareResponse

Parameters:

windowState - window state

Throws:

javax.portlet.WindowStateException - exception

See Also:

StateAwareResponse.setWindowState(javax.portlet.WindowState)

setPortletMode

public final void setPortletMode(javax.portlet.PortletMode portletMode)
                          throws javax.portlet.PortletModeException

Overridden method.

Specified by:

setPortletMode in interface javax.portlet.StateAwareResponse

Parameters:

portletMode - portlet mode

Throws:

javax.portlet.PortletModeException - exception

See Also:

StateAwareResponse.setPortletMode(javax.portlet.PortletMode)

setRenderParameters

public final void setRenderParameters(java.util.Map<java.lang.String,java.lang.String[]> map)

Overridden method.

Specified by:

setRenderParameters in interface javax.portlet.StateAwareResponse

Parameters:

map - map

See Also:

StateAwareResponse.setRenderParameters(java.util.Map)

setRenderParameter

public final void setRenderParameter(java.lang.String s,
                                     java.lang.String s1)

Overridden method.

Specified by:

setRenderParameter in interface javax.portlet.StateAwareResponse

Parameters:

s - name

s1 - value

See Also:

StateAwareResponse.setRenderParameter(java.lang.String, java.lang.String)

setRenderParameter

public final void setRenderParameter(java.lang.String s,
                                     java.lang.String[] strings)

Overridden method.

Specified by:

setRenderParameter in interface javax.portlet.StateAwareResponse

Parameters:

s - name

strings - values

See Also:

StateAwareResponse.setRenderParameter(java.lang.String, java.lang.String[])

getPortletMode

public final javax.portlet.PortletMode getPortletMode()

Overridden method.

Specified by:

getPortletMode in interface javax.portlet.StateAwareResponse

Returns:

portlet mode

See Also:

StateAwareResponse.getPortletMode()

getRenderParameterMap

public final java.util.Map getRenderParameterMap()

Overridden method.

Specified by:

getRenderParameterMap in interface javax.portlet.StateAwareResponse

Returns:

render parameters

See Also:

StateAwareResponse.getRenderParameterMap()

getWindowState

public final javax.portlet.WindowState getWindowState()

Overridden method.

Specified by:

getWindowState in interface javax.portlet.StateAwareResponse

Returns:

window state

See Also:

StateAwareResponse.getWindowState()

validateByJAXB8_5_2List

protected boolean validateByJAXB8_5_2List(java.lang.Object payload)

Parameters:

payload - event payload

Returns:

is it default JAXB serializable object

validateWithJAXB

protected boolean validateWithJAXB(javax.xml.namespace.QName name,
                                   java.io.Serializable payload)

Parameters:

payload - event payload

Returns:

is it JAXB serializable object. Return false if the value is not serializable, the value does not have a valid JAXB binding, the object type of the value is not the same as specified in the portlet deployment descriptor for this event name.

setEvent

public final void setEvent(javax.xml.namespace.QName name,
                           java.io.Serializable value)

Overridden method.

Specified by:

setEvent in interface javax.portlet.StateAwareResponse

Parameters:

name - name

value - event payload

See Also:

StateAwareResponse.setEvent(javax.xml.namespace.QName, java.io.Serializable)

setEvent

public final void setEvent(java.lang.String name,
                           java.io.Serializable value)

Overridden method.

Specified by:

setEvent in interface javax.portlet.StateAwareResponse

Parameters:

name - name

value - event payload

See Also:

StateAwareResponse.setEvent(java.lang.String, java.io.Serializable)

removePublicRenderParameter

public final void removePublicRenderParameter(java.lang.String param)

Overridden method.

Specified by:

removePublicRenderParameter in interface javax.portlet.StateAwareResponse

Parameters:

param - param

See Also:

StateAwareResponse.removePublicRenderParameter(java.lang.String)