uk.org.ogsadai.sessions
Interface SessionAttribute

All Known Implementing Classes:

DynamicSessionAttribute, StaticSessionAttribute

public interface SessionAttribute

The interface for all state objects stored in sessions.

A session attribute represents a name-value pair. The name is fixed whereas the value may be changable, depending on the implementation.

Author:

The OGSA-DAI Project Team

Method Summary

javax.xml.namespace.QName	getName() Gets the name of the session attribute.
java.lang.Object	getValue() Gets the value of the session attribute.
boolean	isChangable() Returns true if the setValue method is implemented, or otherwise false.
void	setValue(java.lang.Object value) Sets the value of the attribute.

Method Detail

getName

public javax.xml.namespace.QName getName()

Gets the name of the session attribute.

Returns:

the qualified name which must not be null

getValue

public java.lang.Object getValue()

Gets the value of the session attribute.

Returns:

the value object which may be null.

setValue

public void setValue(java.lang.Object value)

Sets the value of the attribute.

This method is optional. If it is not supported then an UnsupportedOperationException should be raised and the isChangable() method should return false.

Parameters:

value - The session attribute value which may be null.

isChangable

public boolean isChangable()

Returns true if the setValue method is implemented, or otherwise false.

Returns:

changable value.