oracle.ifs.fdk

Class GuestSessionPool

java.lang.Object

oracle.ifs.fdk.GuestSessionPool

Direct Known Subclasses:

GuestSessionPoolImpl

public abstract class GuestSessionPool
extends Object

This is a pool of guest FdkSessions. These sessions are very limited in their abilities and can generally only perform read-only actions, and those only on objects that give the appropriate permissions to World. There should be at most one instance of this class per-JVM.

(Unpublished)

Constructor Summary

Constructors

Constructor and Description
GuestSessionPool()

Method Summary

Modifier and Type	Method and Description
abstract FdkSession	getGuestSession() Gets a guest session.
static GuestSessionPool	getInstance() Singleton method.
abstract void	releaseGuestSession(FdkSession sess) Indicate that you're done with a guest session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GuestSessionPool

public GuestSessionPool()

Method Detail

getInstance

public static GuestSessionPool getInstance()
                                    throws FdkException

Singleton method.

Returns:

the singleton GuestSessionPool

Throws:

FdkException

getGuestSession

public abstract FdkSession getGuestSession()
                                    throws FdkException

Gets a guest session. General algorithm:

• if there are sessions in the pool, pop one off and return it
• otherwise, if we haven't reached our allocation limit, allocate a new one and return it
• otherwise, we've failed; return null

Sessions acquired with getGuestSession must be released with releaseGuestSession, probably in a finally block.

Returns:

a new guest session, or null if no more are available

Throws:

FdkException - if unable to allocate a new session

releaseGuestSession

public abstract void releaseGuestSession(FdkSession sess)

Indicate that you're done with a guest session. If the pool has less than its target, add session back to pool; otherwise disconnect it.

Parameters:

sess - the session one is done with; must be a session originally acquired with getGuestSession. Do not call disconnection on this session before you call this method. Or after, for that matter.