SessionPoolingData (NetPhantom® 8.0 Java API Specification)

java.lang.Object
- se.entra.phantom.server.SessionPoolingData

All Implemented Interfaces:
Runnable
```
public class SessionPoolingData
extends Object
implements Runnable
```
This class holds the data used by all session instances of a pool. It can be extended to provide more pool data or functionality. The class is then instanciated by the implementor class extending from DefaultSessionPoolingHandler in the static method createSessionPoolingData.

Field Summary

Fields
Modifier and Type	Field and Description
`JDesktopPane`	`desktopPane` The JDesktopPane used for the Server GUI (null if no GUI is displayed).
`Node`	`firstChild` The child nodes in the XML file data.
`static String[]`	`functions` The names of the internal functions.
`int`	`hostID` The host ID used (zero is 'A', i.e.
`Class<?>`	`implClass` The pool implementing class.
`int`	`maxSessions` The maximum amount of sessions in the pool.
`int`	`minSessions` The minimum amount of sessions in the pool.
`int`	`pingTime` The ping time in seconds (zero or negative value for none).
`String`	`poolName` The pool name.
`PhantomRuntime`	`runtime` The runtime application data (null if none is used).
`String`	`runtimeID` The runtime ID used for this pool.
`static int`	`SCRIPT_CHECK` The script method indexes: .
`static int`	`SCRIPT_DISPOSE` The script method indexes: dispose.
`static int`	`SCRIPT_PING` The script method indexes: ping.
`static int`	`SCRIPT_RECLAIM` The script method indexes: reclaim.
`static int`	`SCRIPT_START` The script method indexes: start.
`String`	`scriptFile` The name of the XML script file.
`String[]`	`scriptNames` The array contains the script names in the index order of the table of `Element` for the scripts.

Constructor Summary

Constructors
Constructor and Description
`SessionPoolingData(String runtimeID, int hostID, int minSessions, int maxSessions, int pingTime, String scriptFile, PhantomRuntime runtime, Class<?> implClass, Node firstChild, JDesktopPane desktopPane)` Creates the session pooling data instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeAllSessions(ClientSessionManager csm, boolean nicely)` Closes "nicely" or not all the started sessions in the pool.
`void`	`dispose(ClientSessionManager csm, boolean nicely)` Disposes "nicely" or not all the started sessions in the pool.
`boolean`	`executeScript(DefaultSessionPoolingHandler handler, int scriptIndex)` Executes the specified script index (SCRIPT_nnn value).
`Method`	`getScriptTagMethod(String name)` Gets a method from a script tag in the global pool data.
`protected boolean`	`getScriptTags()` Gets the action scripts in a script file.
`Enumeration<DefaultSessionPoolingHandler>`	`getSessions()` Gets all the started sessions.
`DefaultSessionPoolingHandler`	`grabSessionFromPool()` Checks if there is a session pooling handler that can be used for this client session.
`boolean`	`isEnabled()` Checks if a session pool is enabled or not.
`boolean`	`isReclaimRequired()` Checks if a session should be reclaimed to the pool.
`protected void`	`logError(String txt)` Logs an session pooling error event in the event log.
`protected void`	`logInfo(String txt)` Logs an session pooling informational event in the event log.
`protected void`	`logWarning(String txt)` Logs an session pooling warning event in the event log.
`protected void`	`registerInternalMethods()` Registers all internal methods in the implementing script class.
`boolean`	`registerScriptMethod(Class<?> clazz, String methodName, String scriptName)` This function registers a script method in the table.
`protected boolean`	`registerXMLScriptMethods()` This function registers all script methods defined in the XML file.
`void`	`run()` The session pooling ping thread.
`void`	`sessionDisposed(DefaultSessionPoolingHandler handler)` Notifies that a session has been disposed of.
`void`	`sessionStarted()` Notifies that a session has started correctly.
`void`	`setEnabled(boolean enable)` Changes the enabled state of this pool.
`boolean`	`terminateSession(long connectionID)` Terminates a single session.
`protected void`	`trace(String txt)` Adds a trace output for session pooling if client verbose trace is turned on.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - scriptNames
```
public final String[] scriptNames
```
    The array contains the script names in the index order of the table of Element for the scripts. The names are case sensitive, as well as the parameters.
  - functions
```
public static final String[] functions
```
    The names of the internal functions. The method names are preceeded with "script".
  - SCRIPT_START
```
public static final int SCRIPT_START
```
    The script method indexes: start.
    See Also:
    Constant Field Values
  - SCRIPT_PING
```
public static final int SCRIPT_PING
```
    The script method indexes: ping.
    See Also:
    Constant Field Values
  - SCRIPT_CHECK
```
public static final int SCRIPT_CHECK
```
    The script method indexes: .
    See Also:
    Constant Field Values
  - SCRIPT_RECLAIM
```
public static final int SCRIPT_RECLAIM
```
    The script method indexes: reclaim.
    See Also:
    Constant Field Values
  - SCRIPT_DISPOSE
```
public static final int SCRIPT_DISPOSE
```
    The script method indexes: dispose.
    See Also:
    Constant Field Values
  - runtimeID
```
public final String runtimeID
```
    The runtime ID used for this pool.
  - hostID
```
public final int hostID
```
    The host ID used (zero is 'A', i.e. (int)(char-'A')).
  - minSessions
```
public final int minSessions
```
    The minimum amount of sessions in the pool.
  - maxSessions
```
public final int maxSessions
```
    The maximum amount of sessions in the pool.
  - pingTime
```
public final int pingTime
```
    The ping time in seconds (zero or negative value for none).
  - scriptFile
```
public final String scriptFile
```
    The name of the XML script file.
  - runtime
```
public final PhantomRuntime runtime
```
    The runtime application data (null if none is used).
  - implClass
```
public final Class<?> implClass
```
    The pool implementing class.
  - firstChild
```
public final Node firstChild
```
    The child nodes in the XML file data.
  - desktopPane
```
public final JDesktopPane desktopPane
```
    The JDesktopPane used for the Server GUI (null if no GUI is displayed).
  - poolName
```
public final String poolName
```
    The pool name.
- Constructor Detail
  - SessionPoolingData
```
public SessionPoolingData(String runtimeID,
                          int hostID,
                          int minSessions,
                          int maxSessions,
                          int pingTime,
                          String scriptFile,
                          PhantomRuntime runtime,
                          Class<?> implClass,
                          Node firstChild,
                          JDesktopPane desktopPane)
```
    Creates the session pooling data instance.
    This method cannot be overridden. For an extending class containing extra data members, the final variables runtimeID, hostID, minSessions, maxSessions, pingTime, runtime, implClass, firstChild, desktopPane and poolName must be initialized in the new constructor.
- Method Detail
  - trace
```
protected void trace(String txt)
```
    Adds a trace output for session pooling if client verbose trace is turned on.
  - logError
```
protected void logError(String txt)
```
    Logs an session pooling error event in the event log.
  - logWarning
```
protected void logWarning(String txt)
```
    Logs an session pooling warning event in the event log.
  - logInfo
```
protected void logInfo(String txt)
```
    Logs an session pooling informational event in the event log.
  - closeAllSessions
```
public final void closeAllSessions(ClientSessionManager csm,
                                   boolean nicely)
```
    Closes "nicely" or not all the started sessions in the pool. The "nicely" flag indicates if the Dispose script should run or not.
    There is an inactivity timer that will kill the server if the method aliveNotification in the ClientSessionManager csm parameter that should be called at intervals e.g. when a session is about to be disposed.
    This call blocks the caller thread until all sessions are stopped.
  - dispose
```
public final void dispose(ClientSessionManager csm,
                          boolean nicely)
```
    Disposes "nicely" or not all the started sessions in the pool. The "nicely" flag indicates if the Dispose script should run or not.
    There is an inactivety timer that will kill the server if the method aliveNotification in the ClientSessionManager csm parameter that should be called at intervals e.g. when a session is about to be disposed.
    This call blocks the caller thread until all sessions are stopped.
  - isEnabled
```
public boolean isEnabled()
```
    Checks if a session pool is enabled or not.
  - setEnabled
```
public final void setEnabled(boolean enable)
```
    Changes the enabled state of this pool.
    When enabled, this includes starting the minimum amount of sessions.
  - sessionStarted
```
public void sessionStarted()
```
    Notifies that a session has started correctly. This call will enable the application once all sessions have started correctly.
  - sessionDisposed
```
public final void sessionDisposed(DefaultSessionPoolingHandler handler)
```
    Notifies that a session has been disposed of. A waiting dispose-session call will be notified when an element has been removed.
  - run
```
public void run()
```
    The session pooling ping thread.
    Specified by:
    run in interface Runnable
  - getSessions
```
public Enumeration<DefaultSessionPoolingHandler> getSessions()
```
    Gets all the started sessions. The enumeration contains DefaultSessionPoolingHandler elements.
    Returns:
    null if the pool is disposed, otherwise and enumeration of DefaultSessionPoolingHandler elements.
  - isReclaimRequired
```
public boolean isReclaimRequired()
```
    Checks if a session should be reclaimed to the pool.
  - grabSessionFromPool
```
public DefaultSessionPoolingHandler grabSessionFromPool()
```
    Checks if there is a session pooling handler that can be used for this client session.
    Returns:
    null if none is found.
  - terminateSession
```
public boolean terminateSession(long connectionID)
```
    Terminates a single session.
    Returns:
    false if the session is not found or already disposed, true if terminated.
  - registerInternalMethods
```
protected void registerInternalMethods()
```
    Registers all internal methods in the implementing script class.
  - registerXMLScriptMethods
```
protected boolean registerXMLScriptMethods()
```
    This function registers all script methods defined in the XML file. Each method has the argument SessionPoolingScriptData. The name of the method is case insensitive in the script, but not when it is registered (the name must match a method in the declaring class).
    If the class registering the method is not an extended class from DefaultSessionPoolingHandler, then it must implement the interface SessionPoolingScriptMethodInterface that defines methods that will be called when the object is instantiated for each individual session in the pool.
    Returns:
    true for successful registration, false otherwise (and an event in the server log is created).
  - getScriptTags
```
protected boolean getScriptTags()
```
    Gets the action scripts in a script file. These are the "action name=nnn" tags under the "actions" main tag.
    Returns:
    true if all scripts are successfully registered.
  - getScriptTagMethod
```
public Method getScriptTagMethod(String name)
```
    Gets a method from a script tag in the global pool data. The name of the method is case insensitive.
    Returns:
    null if no method is found, otherwise the Method instance.
  - executeScript
```
public boolean executeScript(DefaultSessionPoolingHandler handler,
                             int scriptIndex)
                      throws SessionPoolingDisposed
```
    Executes the specified script index (SCRIPT_nnn value).
    If the script is not defined in the XML file, true is returned.
    Returns:
    true or false depending on the script.
    Throws:
    SessionPoolingDisposed - if the session is disposed.
  - registerScriptMethod
```
public boolean registerScriptMethod(Class<?> clazz,
                                    String methodName,
                                    String scriptName)
```
    This function registers a script method in the table. Each method has the argument SessionPoolingScriptData. The name of the method is case insensitive in the script, but not when it is registered (the name must match a method in the declaring class).
    If the class registering the method is not an extended class from DefaultSessionPoolingHandler, then it must implement the interface SessionPoolingScriptMethodInterface that defines methods that will be called when the object is instantiated for each individual session in the pool.
    Returns:
    true for successful registration, false otherwise (and an event in the server log is created).

Class SessionPoolingData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

scriptNames

functions

SCRIPT_START

SCRIPT_PING

SCRIPT_CHECK

SCRIPT_RECLAIM

SCRIPT_DISPOSE

runtimeID

hostID

minSessions

maxSessions

pingTime

scriptFile

runtime

implClass

firstChild

desktopPane

poolName

Constructor Detail

SessionPoolingData

Method Detail

trace

logError

logWarning

logInfo

closeAllSessions

dispose

isEnabled

setEnabled

sessionStarted

sessionDisposed

run

getSessions

isReclaimRequired

grabSessionFromPool

terminateSession

registerInternalMethods

registerXMLScriptMethods

getScriptTags

getScriptTagMethod

executeScript

registerScriptMethod