Skip navigation links

com.convergin.common.sal.ext.api
Interface SalApplicationSession

public interface SalApplicationSession

Represents application instances. The SalApplicationSession interface acts as a store for application data and provides access to contained protocol sessions, e.g. SalSession representing point-to-point signaling relationships.

Method Summary

java.lang.Object	getAttribute(java.lang.String name) Returns the object bound with the specified name in this session, or null if no object is bound under the name.
java.lang.String	getId() Returns the id of this SAL application session.
java.util.Iterator<SalSession>	getSessions() Returns an Iterator over all valid SAL session objects.
ApplicationTimer	getTimer(java.lang.String id) Returns the active timer identified by a specific id that is associated with this application session.
java.util.Collection<ApplicationTimer>	getTimers() Returns all active timers associated with this application session.
void	invalidate() Invalidates this application session and unbinds any objects bound to it.
boolean	isValid() Returns if this SalApplicationSession is valid, false otherwise.
void	removeAttribute(java.lang.String name) Removes the object bound with the specified name from this session.
void	setAttribute(java.lang.String name, java.lang.Object attribute) Binds an object to this session, using the name specified.

Method Detail

invalidate

void invalidate()

Invalidates this application session and unbinds any objects bound to it.

isValid

boolean isValid()

Returns if this SalApplicationSession is valid, false otherwise. The SalSession can be invalidated by calling the method SalSession.invalidate() on it.

Returns:

true if the session is valid, false otherwise.

getSessions

java.util.Iterator<SalSession> getSessions()

Returns an Iterator over all valid SAL session objects.

Returns:

Iterator over all SAL sessions.

getId

java.lang.String getId()

Returns the id of this SAL application session.

Returns:

the id of this SAL application session.

getAttribute

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

Returns the object bound with the specified name in this session, or null if no object is bound under the name.

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

setAttribute

void setAttribute(java.lang.String name,
                  java.lang.Object attribute)

Binds an object to this session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.

Parameters:

name - the name to which the object is bound, cannot be null

attribute - the object to be bound, cannot be null

removeAttribute

void removeAttribute(java.lang.String name)

Removes the object bound with the specified name from this session. If the session does not have an object bound with the specified name, this method does nothing.

Parameters:

name - the name of the object to remove from this session

getTimers

java.util.Collection<ApplicationTimer> getTimers()

Returns all active timers associated with this application session.

Returns:

a Collection of ServletTimer objects belonging to this application session

Throws:

java.lang.IllegalStateException - - if this application session is not valid

getTimer

ApplicationTimer getTimer(java.lang.String id)

Returns the active timer identified by a specific id that is associated with this application session.

Returns:

the ServletTimer object identified by the id belonging to this application session

Throws:

java.lang.IllegalStateException - - if this application session is not valid

Skip navigation links