toolbox.oracle.siebel.session
Interface SessionTokenManager

All Known Implementing Classes:

SessionTokenManagerDefaultImpl

public interface SessionTokenManager

Interface that defines a session token manager for Oracle Siebel stateless session pool authentication tokens.

Implemenations of this interface must provide a mechanism to manage a set of token pools.

Author:

Hannes Holtzhausen

Method Summary

void	destroy() Destroy this manager instance.
java.lang.String	getPoolStatus(java.lang.String poolName) Return the status of the named token pool.
Token	getSessionToken(java.lang.String poolName) Return a Token instance from the named token pool.
void	init(java.lang.String name, toolbox.allegato.XMLProperties xmlProps) Initialise this manager with the given name and XML configuration properties.
void	releaseSessionToken(java.lang.String poolName, Token leasedToken, Token reissuedToken) Return the leased token to the named pool.

Method Detail

init

void init(java.lang.String name,
          toolbox.allegato.XMLProperties xmlProps)
          throws SessionTokenManagerException

Initialise this manager with the given name and XML configuration properties.

Parameters:

name - String containing the name of this manager instance.

xmlProps - XMLProperties instance containing the configuration properties.

Throws:

SessionTokenManagerException - if the manager cannot be initialised.

getSessionToken

Token getSessionToken(java.lang.String poolName)
                      throws SessionTokenManagerException

Return a Token instance from the named token pool.

Parameters:

poolName - String containing the name of the resource pool that must

Throws:

SessionTokenManagerException - if the manager cannot return a token.

releaseSessionToken

void releaseSessionToken(java.lang.String poolName,
                         Token leasedToken,
                         Token reissuedToken)
                         throws SessionTokenManagerException

Return the leased token to the named pool. Optionally replace the value of the token with the provided reissued token.

Parameters:

poolName - String containing the name of the pool to return the token to.

leasedToken - The token that must be returned to the named pool.

reissuedToken - Token containing a reissued value.

Throws:

SessionTokenManagerException - if the manager cannot find the a named pool.

getPoolStatus

java.lang.String getPoolStatus(java.lang.String poolName)

Return the status of the named token pool.

Parameters:

poolName - String containing the name of the pool.

Returns:

String containing the status of the named pool.

destroy

void destroy()

Destroy this manager instance.