uk.org.ogsadai.sessions.impl
Interface SessionConfiguration

All Known Implementing Classes:

TransientSessionConfiguration

public interface SessionConfiguration

An interface for classes representing session configurations.

Author:

The OGSA-DAI Project Team

Method Summary

long	getDefaultTimeout() Gets the default timeout value for new sessions in milliseconds.
ResourceEventDispatcher	getDispatcher() Gets the data service resource event dispatcher for events relating to sessions.
long	getMaxTimeout() Gets the maximum timeout value for new sessions.
Properties	getResourceProperties() Gets the resource properties that should be added to each new session created by the session manager.
java.util.Set	getStaticSessionAttributes() Returns the set of static session attributes that should be added to every new session created by the session manager configured with this object.

Method Detail

getDefaultTimeout

public long getDefaultTimeout()

Gets the default timeout value for new sessions in milliseconds.

This is the number of milliseconds that a session will take to timeout after its last participant has left. This must be less than or equal to the value of getMaxTimeout().

Returns:

long value greater than zero

getMaxTimeout

public long getMaxTimeout()

Gets the maximum timeout value for new sessions.

Returns:

milliseconds value as a long or -1 if no value is set.

getStaticSessionAttributes

public java.util.Set getStaticSessionAttributes()

Returns the set of static session attributes that should be added to every new session created by the session manager configured with this object.

If there are no static session attributes then an empty set is returned.

Returns:

an immutable set of SessionAttribute objects where each instance has a unique name.

getResourceProperties

public Properties getResourceProperties()

Gets the resource properties that should be added to each new session created by the session manager.

Returns:

a reference to the data service resource Properties object.

getDispatcher

public ResourceEventDispatcher getDispatcher()

Gets the data service resource event dispatcher for events relating to sessions.

Returns:

a ResourceEventDispatcher object