org.apache.wsrp4j.consumer.driver
Class GenericPortletWindowSessionImpl

java.lang.Object
  org.apache.wsrp4j.consumer.driver.GenericPortletWindowSessionImpl

All Implemented Interfaces:

PortletWindowSession

Direct Known Subclasses:

SimplePortletWindowSessionImpl

public class GenericPortletWindowSessionImpl

extends java.lang.Object

implements PortletWindowSession

Version:

$Id: GenericPortletWindowSessionImpl.java,v 1.4 2005/08/10 14:51:44 cziegeler Exp $

Field Summary

private oasis.names.tc.wsrp.v1.types.MarkupContext	markupCtx
private PortletSession	pSession
private java.lang.String	windowID

Constructor Summary

GenericPortletWindowSessionImpl(java.lang.String windowID, PortletSession pSession)

Method Summary

oasis.names.tc.wsrp.v1.types.MarkupContext	getCachedMarkup() Get the markup context which has been cached.
PortletSession	getPortletSession() Get the portlet session this window session belongs to.
java.lang.String	getWindowID() Get the ID of the portlets window this session belongs to.
void	setWindowID(java.lang.String windowID) Set the ID of the portlets window this sessions belongs to.
void	updateMarkupCache(oasis.names.tc.wsrp.v1.types.MarkupContext markupContext) Update the cache which holds the markup context.

Methods inherited from class java.lang.Object

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

Field Detail

markupCtx

private transient oasis.names.tc.wsrp.v1.types.MarkupContext markupCtx

windowID

private java.lang.String windowID

pSession

private PortletSession pSession

Constructor Detail

GenericPortletWindowSessionImpl

public GenericPortletWindowSessionImpl(java.lang.String windowID,
                                       PortletSession pSession)

Method Detail

getPortletSession

public PortletSession getPortletSession()

Description copied from interface: PortletWindowSession

Get the portlet session this window session belongs to.

Specified by:

getPortletSession in interface PortletWindowSession

Returns:

The PortletSession this window session belongs to.

getWindowID

public java.lang.String getWindowID()

Description copied from interface: PortletWindowSession

Get the ID of the portlets window this session belongs to.

Specified by:

getWindowID in interface PortletWindowSession

Returns:

The ID of the portlet window.

setWindowID

public void setWindowID(java.lang.String windowID)

Description copied from interface: PortletWindowSession

Set the ID of the portlets window this sessions belongs to.

Specified by:

setWindowID in interface PortletWindowSession

Parameters:

windowID - The ID of the portlet window.

getCachedMarkup

public oasis.names.tc.wsrp.v1.types.MarkupContext getCachedMarkup()

Description copied from interface: PortletWindowSession

Get the markup context which has been cached. This might be useful to retrieve the markup which was returned performBlockingInteraction calls in order to save an additional getMarkup call.

Specified by:

getCachedMarkup in interface PortletWindowSession

Returns:

The cached markup context or null in case the cache is empty.

updateMarkupCache

public void updateMarkupCache(oasis.names.tc.wsrp.v1.types.MarkupContext markupContext)

Description copied from interface: PortletWindowSession

Update the cache which holds the markup context. This might be useful to store the markup which was returned by performBlockingInteraction calls in order to save an additional getMarkup call. Updateing the cache with a null value clears the markup cache.

Specified by:

updateMarkupCache in interface PortletWindowSession

Parameters:

markupContext - The markup context or null in case the cache should be cleared.