org.apache.jetspeed.om.window.impl
Class PortletWindowImpl

java.lang.Object
  org.apache.jetspeed.om.window.impl.PortletWindowImpl

All Implemented Interfaces:

java.io.Serializable, RenderTrackable, org.apache.pluto.container.PortletWindow, org.apache.pluto.container.PortletWindowID

public class PortletWindowImpl
extends java.lang.Object
implements PortletWindow, PortletWindowID, RenderTrackable

The PortletWindow implementation represents a single window of an portlet instance as it can be shown only once on a single page. Adding the same portlet e.g. twice on a page results in two different windows.

Version:

$Id: PortletWindowImpl.java 911881 2010-02-19 17:58:50Z rwatler $

Author:

David Sean Taylor

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jetspeed.container.PortletWindow

PortletWindow.Action

Field Summary

protected long	expiration
protected int	timeoutCount

Constructor Summary

PortletWindowImpl(RequestContext requestContext, ContentFragment fragment)

PortletWindowImpl(RequestContext requestContext, ContentFragment fragment, PortletDefinition pd)

Method Summary

void	clearInvocationState()
PortletWindow.Action	getAction()
java.lang.Object	getAttribute(java.lang.String name)
java.util.Map<java.lang.String,java.lang.Object>	getAttributes()
long	getExpiration()
ContentFragment	getFragment()
java.util.List<KeyValue<java.lang.String,HeadElement>>	getHeadElements()
PortletWindowID	getId() Returns the identifier of this portlet instance window as object id
PortletDefinition	getPortletDefinition() Returns the portlet definition
java.lang.String	getPortletEntityId()
PortletInstance	getPortletInstance()
javax.portlet.PortletMode	getPortletMode()
javax.portlet.PortletRequest	getPortletRequest()
org.apache.pluto.container.PortletRequestContext	getPortletRequestContext()
javax.portlet.PortletResponse	getPortletResponse()
org.apache.pluto.container.PortletResponseContext	getPortletResponseContext()
int	getRenderTimeoutCount()
RequestContext	getRequestContext()
java.lang.String	getStringId()
java.lang.String	getWindowId()
javax.portlet.WindowState	getWindowState()
void	incrementRenderTimeoutCount()
boolean	isInstantlyRendered() Checks if the content is instantly rendered from JPT.
boolean	isValid()
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setExpiration(long expiration)
void	setInvocationState(PortletWindow.Action action, org.apache.pluto.container.PortletRequestContext portletRequestContext, org.apache.pluto.container.PortletResponseContext portletResponseContext, javax.portlet.PortletRequest portletRequest, javax.portlet.PortletResponse portletResponse, PortletInstance portletInstance)
void	setRenderTimeoutCount(int timeoutCount)
void	success()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

timeoutCount

protected int timeoutCount

expiration

protected long expiration

Constructor Detail

PortletWindowImpl

public PortletWindowImpl(RequestContext requestContext,
                         ContentFragment fragment)

PortletWindowImpl

public PortletWindowImpl(RequestContext requestContext,
                         ContentFragment fragment,
                         PortletDefinition pd)

Method Detail

isValid

public boolean isValid()

getWindowId

public java.lang.String getWindowId()

getId

public PortletWindowID getId()

Returns the identifier of this portlet instance window as object id

Specified by:

getId in interface org.apache.pluto.container.PortletWindow

Returns:

the object identifier

getPortletEntityId

public java.lang.String getPortletEntityId()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStringId

public java.lang.String getStringId()

Specified by:

getStringId in interface org.apache.pluto.container.PortletWindowID

getPortletDefinition

public PortletDefinition getPortletDefinition()

Returns the portlet definition

Specified by:

getPortletDefinition in interface org.apache.pluto.container.PortletWindow

Returns:

the portlet definition

getFragment

public ContentFragment getFragment()

isInstantlyRendered

public boolean isInstantlyRendered()

Checks if the content is instantly rendered from JPT.

getRequestContext

public RequestContext getRequestContext()

getPortletMode

public javax.portlet.PortletMode getPortletMode()

Specified by:

getPortletMode in interface org.apache.pluto.container.PortletWindow

getWindowState

public javax.portlet.WindowState getWindowState()

Specified by:

getWindowState in interface org.apache.pluto.container.PortletWindow

getAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

removeAttribute

public void removeAttribute(java.lang.String name)

getRenderTimeoutCount

public int getRenderTimeoutCount()

Specified by:

getRenderTimeoutCount in interface RenderTrackable

incrementRenderTimeoutCount

public void incrementRenderTimeoutCount()

Specified by:

incrementRenderTimeoutCount in interface RenderTrackable

setExpiration

public void setExpiration(long expiration)

Specified by:

setExpiration in interface RenderTrackable

getExpiration

public long getExpiration()

Specified by:

getExpiration in interface RenderTrackable

success

public void success()

Specified by:

success in interface RenderTrackable

setRenderTimeoutCount

public void setRenderTimeoutCount(int timeoutCount)

Specified by:

setRenderTimeoutCount in interface RenderTrackable

setInvocationState

public void setInvocationState(PortletWindow.Action action,
                               org.apache.pluto.container.PortletRequestContext portletRequestContext,
                               org.apache.pluto.container.PortletResponseContext portletResponseContext,
                               javax.portlet.PortletRequest portletRequest,
                               javax.portlet.PortletResponse portletResponse,
                               PortletInstance portletInstance)

clearInvocationState

public void clearInvocationState()

getAction

public PortletWindow.Action getAction()

getPortletRequest

public javax.portlet.PortletRequest getPortletRequest()

getPortletResponseContext

public org.apache.pluto.container.PortletResponseContext getPortletResponseContext()

getPortletRequestContext

public org.apache.pluto.container.PortletRequestContext getPortletRequestContext()

getPortletResponse

public javax.portlet.PortletResponse getPortletResponse()

getPortletInstance

public PortletInstance getPortletInstance()

getHeadElements

public java.util.List<KeyValue<java.lang.String,HeadElement>> getHeadElements()