com.sssw.rts.adminapi
Interface AgiAdmSession

All Known Subinterfaces:

AgiSession

public interface AgiAdmSession

Implemented by objects that represent sessions established with a SilverStream Server.

See Also:

AgiAdmServer

Method Summary

String	getHost() Get the host name.
String	getID() Get the ID of the session.
int	getIdleTime() Get the idle time of the session.
String	getProtocolVersionNumber() Tells what version of the client/server protocol is being used by this client.
String	getState() Get the state the session is in (Busy or Idle).
String	getUserName() Get the name of the user who started the session.
boolean	isUserLoggedIn() Return true if the user has logged in this session, false otherwise.

Method Detail

getID

public String getID()

Get the ID of the session.

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // Get the ID of the session.
 String id = sess.getID();
 

getUserName

public String getUserName()

Get the name of the user who started the session.

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // Get the name of the user.
 String userName = sess.getUserName();
 

getState

public String getState()

Get the state the session is in (Busy or Idle).

A session is busy if it's "alive". As soon as the connection is lost, the session's state turns into "Idle", that is, it can be re-established using the session cookie and go back into the "Busy" state.

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // Get the state.
 String state = sess.getState();
 

getHost

public String getHost()

Get the host name.

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // Get the name of the host.
 String host = sess.getHost();
 

getIdleTime

public int getIdleTime()

Get the idle time of the session.

See AgiAdmSession.getState() for the definition of "Idle".

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // Get the idle time.
 int idleTime = sess.getIdleTime();
 

isUserLoggedIn

public boolean isUserLoggedIn()

Return true if the user has logged in this session, false otherwise.

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // See if the user is logged in.
 boolean isLoggedIn = sess.isUserLoggedIn();
 

getProtocolVersionNumber

public String getProtocolVersionNumber()

Tells what version of the client/server protocol is being used by this client.

Example:

// Get the session information.
 AgiAdmSession sess = ...
 // Get the protocol version number.
 String protocol = sess.getProtocolVersionNumber();