org.gatein.pc.portlet.impl.state.consumer

Class AbstractConsumerPersistenceManagerService<S extends Serializable>

java.lang.Object

org.gatein.pc.portlet.impl.state.consumer.AbstractConsumerPersistenceManagerService<S>

All Implemented Interfaces:

ConsumerPersistenceManager<S>

Direct Known Subclasses:

ConsumerPersistenceManagerService

public abstract class AbstractConsumerPersistenceManagerService<S extends Serializable>
extends Object
implements ConsumerPersistenceManager<S>

Version:

$Revision: 1.1 $

Author:

Julien Viet

Constructor Summary

Constructors

Constructor and Description
AbstractConsumerPersistenceManagerService()

Method Summary

Methods

Modifier and Type	Method and Description
String	createState(ConsumerState<S> state) Create the initial state.
void	destroyState(String stateId) Destroy the state.
protected abstract ConsumerStateContext<S>	get(String stateId)
int	getSize()
ConsumerStateContext<S>	loadState(String stateId) Load the state.
protected abstract void	put(String stateId, ConsumerStateContext<S> state)
protected abstract void	remove(String stateId)
protected abstract int	size()
void	updateState(String stateId, ConsumerState<S> state) Update the state.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gatein.pc.portlet.state.consumer.ConsumerPersistenceManager

getStateType

Constructor Detail

AbstractConsumerPersistenceManagerService

public AbstractConsumerPersistenceManagerService()

Method Detail

get

protected abstract ConsumerStateContext<S> get(String stateId)

put

protected abstract void put(String stateId,
       ConsumerStateContext<S> state)

remove

protected abstract void remove(String stateId)

size

protected abstract int size()

loadState

public ConsumerStateContext<S> loadState(String stateId)
                                                       throws IllegalArgumentException,
                                                              NoSuchStateException,
                                                              InvalidStateIdException

Description copied from interface: ConsumerPersistenceManager

Load the state.

Specified by:

loadState in interface ConsumerPersistenceManager<S extends Serializable>

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

createState

public String createState(ConsumerState<S> state)
                   throws IllegalArgumentException

Description copied from interface: ConsumerPersistenceManager

Create the initial state.

Specified by:

createState in interface ConsumerPersistenceManager<S extends Serializable>

Parameters:

state - the state

Returns:

the id of the state created

Throws:

IllegalArgumentException - if the portlet id is null

updateState

public void updateState(String stateId,
               ConsumerState<S> state)
                 throws IllegalArgumentException,
                        NoSuchStateException,
                        InvalidStateIdException

Description copied from interface: ConsumerPersistenceManager

Update the state.

Specified by:

updateState in interface ConsumerPersistenceManager<S extends Serializable>

Parameters:

stateId - the state id

state - the updated state

Throws:

IllegalArgumentException - if the state id is null or the values are null

NoSuchStateException - is the specified state does not exist

InvalidStateIdException - if the state id is not valid

destroyState

public void destroyState(String stateId)
                  throws IllegalArgumentException,
                         NoSuchStateException,
                         InvalidStateIdException

Description copied from interface: ConsumerPersistenceManager

Destroy the state.

Specified by:

destroyState in interface ConsumerPersistenceManager<S extends Serializable>

Parameters:

stateId - 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

getSize

public int getSize()