org.apache.jetspeed.services.statemanager
Interface SessionState

public interface SessionState

SessionState is an interface for objects that provide name - value information sets with a unique key that can be used in the StateManager service

See the proposal: jakarta-jetspeed/proposals/StateManager.txt for more details.

Version:

$Revision: 1.5 $

Author:

Glenn R. Golden

See Also:

StateManagerService

Method Summary

void	clear() Remove all attributes.
java.lang.Object	getAttribute(java.lang.String name) Access the named attribute.
java.lang.String[]	getAttributeNames() Access an array of all names of attributes stored in the SessionState.
java.lang.String	getKey() Access the unique StateManager key for the SessionState.
void	removeAttribute(java.lang.String name) Remove the named attribute, if it exists.
void	retire() Retire, forget about and clean up this state.
void	setAttribute(java.lang.String name, java.lang.Object value) Set the named attribute value to the provided object.

Method Detail

getAttribute

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

Access the named attribute.

Parameters:

name - The attribute name.

Returns:

The named attribute value.

setAttribute

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

Set the named attribute value to the provided object.

Parameters:

name - The attribute name.

value - The value of the attribute (any object type).

removeAttribute

public void removeAttribute(java.lang.String name)

Remove the named attribute, if it exists.

Parameters:

name - The attribute name.

clear

public void clear()

Remove all attributes.

getAttributeNames

public java.lang.String[] getAttributeNames()

Access an array of all names of attributes stored in the SessionState.

Returns:

An array of all names of attribute stored in the SessionState.

getKey

public java.lang.String getKey()

Access the unique StateManager key for the SessionState.

Returns:

the unique StateManager key for the SessionState.

retire

public void retire()

Retire, forget about and clean up this state.