Package org.gatein.pc.portlet.state.producer

Class AbstractPortletStatePersistenceManager

java.lang.Object

org.gatein.pc.portlet.state.producer.AbstractPortletStatePersistenceManager

All Implemented Interfaces:

PortletStatePersistenceManager

Direct Known Subclasses:

PortletStatePersistenceManagerService

public abstract class AbstractPortletStatePersistenceManager
extends Object
implements PortletStatePersistenceManager

Version:

$Revision$

Author:

Chris Laprun

Constructor Summary

Constructors

Constructor	Description
AbstractPortletStatePersistenceManager()

Method Summary

Modifier and Type	Method	Description
String	cloneState(String stateId)	Clone an existing state.
String	cloneState(String stateId, org.gatein.pc.api.state.PropertyMap propertyMap)	Clone an existing state.
String	createState(String portletId, org.gatein.pc.api.state.PropertyMap propertyMap)	Create the initial state.
protected abstract String	createStateContext(String portletId, org.gatein.pc.api.state.PropertyMap propertyMap)
void	destroyState(String stateId)	Destroy the state.
protected abstract PortletStateContext	destroyStateContext(String stateId)
protected PortletState	getState(String stateId)
protected abstract PortletStateContext	getStateContext(String stateId)
PortletStateContext	loadState(String stateId)	Load the state.
void	updateState(String stateId, org.gatein.pc.api.state.PropertyMap propertyMap)	Update the state.
protected abstract void	updateStateContext(PortletStateContext stateContext)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractPortletStatePersistenceManager

public AbstractPortletStatePersistenceManager()

Method Details

loadState

public PortletStateContext loadState(String stateId)
                              throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Description copied from interface: PortletStatePersistenceManager

Load the state.

Specified by:

loadState in interface PortletStatePersistenceManager

Parameters:

stateId - the state id

Returns:

the value map or null if it does not exist

Throws:

IllegalArgumentException - if the state id is null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

getState

protected PortletState getState(String stateId)
                         throws NoSuchStateException,
InvalidStateIdException

Throws:

NoSuchStateException

InvalidStateIdException

createState

public String createState(String portletId,
 org.gatein.pc.api.state.PropertyMap propertyMap)

Description copied from interface: PortletStatePersistenceManager

Create the initial state.

Specified by:

createState in interface PortletStatePersistenceManager

Parameters:

portletId - the id that this state refers to

Returns:

the id of the state created

cloneState

public String cloneState(String stateId,
 org.gatein.pc.api.state.PropertyMap propertyMap)
                  throws NoSuchStateException,
InvalidStateIdException

Description copied from interface: PortletStatePersistenceManager

Clone an existing state.

Specified by:

cloneState in interface PortletStatePersistenceManager

Parameters:

stateId - the id that this state refers to

propertyMap - the values of the cloned state

Returns:

the state id

Throws:

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

cloneState

public String cloneState(String stateId)
                  throws IllegalArgumentException,
NoSuchStateException,
InvalidStateIdException

Description copied from interface: PortletStatePersistenceManager

Clone an existing state.

Specified by:

cloneState in interface PortletStatePersistenceManager

Parameters:

stateId - the id that this state refers to

Returns:

the state id

Throws:

IllegalArgumentException - if the state id is null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

updateState

public void updateState(String stateId,
 org.gatein.pc.api.state.PropertyMap propertyMap)
                 throws NoSuchStateException,
InvalidStateIdException

Description copied from interface: PortletStatePersistenceManager

Update the state.

Specified by:

updateState in interface PortletStatePersistenceManager

propertyMap - the updated state

Throws:

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

destroyState

public void destroyState(String stateId)
                  throws InvalidStateIdException,
NoSuchStateException

Description copied from interface: PortletStatePersistenceManager

Destroy the state.

Specified by:

destroyState in interface PortletStatePersistenceManager

Throws:

InvalidStateIdException - if the state id is not valid

NoSuchStateException - is the specified state does not exist

getStateContext

protected abstract PortletStateContext getStateContext(String stateId)
                                                throws InvalidStateIdException

Throws:

InvalidStateIdException

createStateContext

protected abstract String createStateContext(String portletId,
 org.gatein.pc.api.state.PropertyMap propertyMap)

destroyStateContext

protected abstract PortletStateContext destroyStateContext(String stateId)
                                                    throws InvalidStateIdException

Throws:

InvalidStateIdException

updateStateContext

protected abstract void updateStateContext(PortletStateContext stateContext)