SessionPoolingScriptData (NetPhantom® 7.7 Java API Specification)

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

```
public class SessionPoolingScriptData
extends Object
```
This class holds information for each script currently being executed, e.g. the return code, the current instruction pointer. An instance of this class is allocated for each script instance being executed for a pooled session.
All members of this class are made public and non-final for performance and access reasons, but should be modified with care!

Field Summary

Fields
Modifier and Type	Field and Description
`Element`	`currentElement` The current `Element` tag being executed.
`DefaultSessionPoolingHandler`	`handler` The default script handler.
`long`	`maxTime` The time in milliseconds (from GMT 1970) that the script must have completed before.
`boolean`	`returnCode` The current return code of the script.
`String`	`scriptName` The name of the script executing.
`Node`	`scriptStart` The start node of the script.

Constructor Summary

Constructors
Constructor and Description
`SessionPoolingScriptData(DefaultSessionPoolingHandler handler, String scriptName, Node scriptStart, long maxTime)` Creates an instance of script execution for one of the scripts.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkScriptDisposed()` Check for script disposal (the maximum time and session disposal is checked).
`void`	`executeRemainingElements()` Executes all sibling tags including the current element.
`void`	`executeRemainingElements(Element lastElement)` Executes all sibling tags including the current element up to the `lastElement`.
`Element`	`getFirstElement(Node parent)` Gets the first executable child element of a tag.
`Element`	`getNextElement(Node currentNode)` Gets the next tag to execute if no "nesting" is present, i.e.
`int`	`getParamInt(String name)` Helper function to get a parameter for the current element.
`int`	`getParamInt(String name, boolean logError)` Helper function to get a parameter for the current element.
`int`	`getParamInt(String name, int defaultValue, boolean logError)` Helper function to get a parameter for the current element.
`String`	`getParamString(String name)` Helper function to get a `String` parameter for the current element.
`String`	`getParamString(String name, boolean logError)` Helper function to get a `String` parameter for the current element.
`String`	`getParamString(String name, String defaultValue, boolean logError)` Helper function to get a parameter `String` for an `Element`.
`boolean`	`hasElementAttribute(String name)` Checks if the current element has a attribute defined.
`void`	`invokeScriptMethod()` Invokes a script method that is previously registered at the `currentElement` position.
`void`	`logError(String txt)` Logs an session pooling error event in the event log.
`void`	`logInfo(String txt)` Logs an session pooling informational event in the event log.
`void`	`logWarning(String txt)` Logs an session pooling warning event in the event log.
`boolean`	`setNextCurrentElement()` Sets the `currentElement` to the next sibling element, or null if no other is found.
`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
  - scriptStart
```
public final Node scriptStart
```
    The start node of the script.
  - handler
```
public final DefaultSessionPoolingHandler handler
```
    The default script handler.
  - returnCode
```
public boolean returnCode
```
    The current return code of the script.
  - currentElement
```
public Element currentElement
```
    The current Element tag being executed. This variable should be changed after execution of a tag to point to the next element to execute in the script. If this variable is null, it means the end of the script.
  - maxTime
```
public final long maxTime
```
    The time in milliseconds (from GMT 1970) that the script must have completed before. If this value is zero, no maxTime is used. If the maxTime is reached, the session will be disposed of (in a not-nice-way).
  - scriptName
```
public final String scriptName
```
    The name of the script executing.
- Constructor Detail
  - SessionPoolingScriptData
```
public SessionPoolingScriptData(DefaultSessionPoolingHandler handler,
                                String scriptName,
                                Node scriptStart,
                                long maxTime)
```
    Creates an instance of script execution for one of the scripts.
- Method Detail
  - checkScriptDisposed
```
public void checkScriptDisposed()
                         throws SessionPoolingDisposed
```
    Check for script disposal (the maximum time and session disposal is checked).
    
    Throws:
    
    SessionPoolingDisposed - if time is exceeded or session is disposed of.
  - getParamInt
```
public int getParamInt(String name)
```
    Helper function to get a parameter for the current element.
    The name parameter is case sensitive.
    
    Returns:
    
    -1 if the parameter is not found or not an integer.
  - getParamInt
```
public int getParamInt(String name,
                       boolean logError)
```
    Helper function to get a parameter for the current element.
    If the parameter is not found, logError parameter will log a warning in the server event log.
    The name parameter is case sensitive.
    
    Returns:
    
    -1 if the parameter is not found or not an integer.
  - getParamInt
```
public int getParamInt(String name,
                       int defaultValue,
                       boolean logError)
```
    Helper function to get a parameter for the current element.
    If the parameter is not found or not a valid integer, logError parameter will log a warning in the server event log.
    The name parameter is case sensitive.
    
    Returns:
    
    the default value if the parameter is not found.
  - getParamString
```
public String getParamString(String name)
```
    Helper function to get a String parameter for the current element.
    The name parameter is case sensitive.
    
    Returns:
    
    null if the parameter is not found.
  - getParamString
```
public String getParamString(String name,
                             boolean logError)
```
    Helper function to get a String parameter for the current element.
    If the parameter is not found, logError parameter will log a warning in the server event log.
    The name parameter is case sensitive.
    
    Returns:
    
    null if the parameter is not found.
  - getParamString
```
public String getParamString(String name,
                             String defaultValue,
                             boolean logError)
```
    Helper function to get a parameter String for an Element.
    If the parameter is not found, logError parameter will log a warning in the server event log.
    The name parameter is case sensitive.
    
    Returns:
    
    the default value if the parameter is not found.
  - hasElementAttribute
```
public boolean hasElementAttribute(String name)
```
    Checks if the current element has a attribute defined.
    The name parameter is case sensitive.
    
    Returns:
    
    true if defined, false otherwise.
  - getFirstElement
```
public Element getFirstElement(Node parent)
                        throws SessionPoolingDisposed
```
    Gets the first executable child element of a tag.
    
    Returns:
    
    null if the script has reached its end, otherwise the next tag to be executed.
    
    Throws:
    
    SessionPoolingDisposed - when a script is disposed.
    
    NullPointerException - when the script is already at the end when this function is called.
  - getNextElement
```
public Element getNextElement(Node currentNode)
                       throws SessionPoolingDisposed
```
    Gets the next tag to execute if no "nesting" is present, i.e. just the next tag encountered. If the present tag doesn't have siblings, the next parent sibling is returned.
    
    Returns:
    
    null if there are no more tags to execute in the tree.
    
    Throws:
    
    SessionPoolingDisposed - when a script is disposed.
  - executeRemainingElements
```
public void executeRemainingElements()
                              throws SessionPoolingDisposed
```
    Executes all sibling tags including the current element. The function then returns (the currentElement variable is then null). If currentElement is null, no further processing is done.
    If a host error occurs, this function locates a sibling ONERROR tag. If found, all its siblings are executed. If not found, the SessionPoolingScriptHostError exception is thrown and should be handled by tags allowing children elements, such as IF/ELSEIF/ELSE, WHILE, CONDITIONS, SCREEN.
    
    Throws:
    
    SessionPoolingDisposed - when a script has been disposed.
    
    SessionPoolingScriptHostError - when a host error is encountered.
  - executeRemainingElements
```
public void executeRemainingElements(Element lastElement)
                              throws SessionPoolingDisposed
```
    Executes all sibling tags including the current element up to the lastElement. The last element is not executed. The function then returns (the currentElement variable is then null or lastElement). If currentElement is null or set to lastElement, no further processing is done.
    If a host error occurs, this function locates a sibling ONERROR tag. If found, all its siblings are executed. If not found, the SessionPoolingScriptHostError exception is thrown and should be handled by tags allowing children elements, such as IF/ELSEIF/ELSE, WHILE, CONDITIONS, SCREEN.
    
    Throws:
    
    SessionPoolingDisposed - when a script has been disposed.
    
    SessionPoolingScriptHostError - when a host error is encountered.
  - setNextCurrentElement
```
public boolean setNextCurrentElement()
                              throws SessionPoolingDisposed
```
    Sets the currentElement to the next sibling element, or null if no other is found.
    
    Returns:
    
    false if no sibling is found, true otherwise.
    
    Throws:
    
    SessionPoolingDisposed - if the session is disposed.
  - invokeScriptMethod
```
public void invokeScriptMethod()
                        throws SessionPoolingDisposed
```
    Invokes a script method that is previously registered at the currentElement position.
    If the name is a valid Element and the name is not valid, an error is logged in the server event log.
    
    Throws:
    
    SessionPoolingDisposed - if the session is disposed.
    
    NullPointerException - if the script currentElement variable is null.
  - trace
```
public void trace(String txt)
```
    Adds a trace output for session pooling if client verbose trace is turned on.
  - logError
```
public void logError(String txt)
```
    Logs an session pooling error event in the event log.
  - logWarning
```
public void logWarning(String txt)
```
    Logs an session pooling warning event in the event log.
  - logInfo
```
public void logInfo(String txt)
```
    Logs an session pooling informational event in the event log.

Class SessionPoolingScriptData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

scriptStart

handler

returnCode

currentElement

maxTime

scriptName

Constructor Detail

SessionPoolingScriptData

Method Detail

checkScriptDisposed

getParamInt

getParamInt

getParamInt

getParamString

getParamString

getParamString

hasElementAttribute

getFirstElement

getNextElement

executeRemainingElements

executeRemainingElements

setNextCurrentElement

invokeScriptMethod

trace

logError

logWarning

logInfo