VirtualSessionManager (NetPhantom® 7.7 Java API Specification)

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

All Implemented Interfaces:

DirectInterface, NetPhantomConstants, ObjectMessages
```
public class VirtualSessionManager
extends Object
implements NetPhantomConstants, ObjectMessages, DirectInterface
```
The virtual session manager that handles a clients.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClientSessionInterface`	`clientSession` The reference to the client session.
`FontSubstitution`	`fontSubstitution` The font substitution used on the client side, or null if none is used.
`protected int`	`isApplet` The isApplet variable (-1=unknown [RAPP/HTML/SessionPooling/NotInitialized], 0=application, 1=applet, 2=editor, 3=JavaWS, 4=JavaWebStart).
`boolean`	`ratioScaleFonts` Flag indicating fonts are scaled with the ratio X and Y settings for panels.
`int`	`ratioX` The ratio X for the panel.
`int`	`ratioY` The ratio Y for the panel.

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants
ACTION_CLOSEWINDOW, ACTION_CONTROL, ACTION_HOSTKEY, ACTION_MENU, ACTION_NONE, ACTION_NOTEBOOKPAGE, ACTION_POPUPMENU, CC_BACKGROUND, CC_BOTH, CC_FOREGROUND, CC_NONE, CLIPBOARD_GET, CLIPBOARD_SET, DATEF_DMY, DATEF_MDY, DATEF_SYSTEM, DATEF_YMD, DDE_ADVISE, DDE_EXECUTE, DDE_INITIATE, DDE_POKE, DDE_REQUEST, DDE_TERMINATE, DDE_UNADVISE, DDE_UPDATE, DDEVAR_DISABLE, DDEVAR_ENABLE, DDEVAR_REQUEST, DDEVAR_SET, DDEVAR_VALIDATE, EFT_AMOUNT, EFT_DATE, EFT_DATEAMOUNT, EFT_NORMAL, EFT_PASSWORD, EVENT_CHAR, EVENT_CHECK, EVENT_CLICK, EVENT_COMMAND, EVENT_DBLCLICK, EVENT_DDECONNECTION, EVENT_DDEDATA, EVENT_DDEERROR, EVENT_DDEEXECUTE, EVENT_DDEINVALIDATE, EVENT_DDEPOKE, EVENT_DDEREQUEST, EVENT_DEFOCUS, EVENT_FOCUS, EVENT_PAGEDOWN, EVENT_PAGEUP, EVENT_SELECT, EVENT_UNKNOWN, EVENT_USERCHANGE, EXTENDEDINFO_IDS_TO_CLIENT, FOCUSTYPE_CLIENTTARGET, FOCUSTYPE_CONTROL, FOCUSTYPE_NONE, ICON_CRITICAL, ICON_INFORMATION, ICON_NOICON, ICON_QUERY, ICON_WARNING, J_AUTO, J_BOTTOM, J_BOTTOMLEFT, J_BOTTOMRIGHT, J_CENTER, J_LEFT, J_RIGHT, J_TOP, J_TOPLEFT, J_TOPRIGHT, MAX_PANELS_PER_SESSION, MAX_SESSIONS, MB_ABORTRETRYIGNORE, MB_CANCEL, MB_ENTER, MB_ENTERCANCEL, MB_OK, MB_OKCANCEL, MB_RETRYCANCEL, MB_YESNO, MB_YESNOCANCEL, MBID_CANCEL, MBID_DEFAULT, MBID_ENTER, MBID_IGNORE, MBID_NO, MBID_OK, MBID_RETRY, MBID_YES, MS_MOVE, MS_NONE, MS_SIZE, NETPHANTOM_COPYRIGHT, NETPHANTOM_COPYRIGHT2, NETPHANTOM_VERSION, OBJEVENT_CHECK, OBJEVENT_CLICK, OBJEVENT_DBLCLICK, OBJEVENT_DEFOCUS, OBJEVENT_FOCUS, OBJEVENT_SELECT, OBJEVENT_USERCHANGE, PANELCREATE_APPPANEL, PANELCREATE_DANGLINGPANEL, PANELCREATE_DLGFRAME, PANELCREATE_EXTENDEDINFO, PANELCREATE_ICON, PANELCREATE_INDIVIDUALSIZE, PANELCREATE_POPUP, REPLYTYPE_CLIENTEXECUTE, REPLYTYPE_CLIPBOARD, REPLYTYPE_DDE, REPLYTYPE_FFONTLIST, REPLYTYPE_MESSAGEBOX, REPLYTYPE_REPORT, REPLYTYPE_SAVEPROPS, REPLYTYPE_TERMMARK, RPRT_CANCELPRINTJOB, RPRT_CLOSEPRINTJOB, RPRT_CONTPRINTJOB, RPRT_OPENPRINTJOB, RPRT_PRINTJOBCANCLD, RPRT_PRINTJOBCLOSED, RPRT_PRINTJOBCONT, RPRT_PRINTJOBOPENED, RPRT_PRINTJOBSTARTED, RPRT_STARTPRINTJOB, SELMODE_NORMAL, SELMODE_NOTALLOWED, SELMODE_REQUIRED, SELTYPE_MULTIPLE, SELTYPE_SINGLE, SEPARATOR, SEPARATORCHAR, TRANS_APPLICATIONCHANGE, TRANS_CALLOBJECT, TRANS_CANCELEXIT, TRANS_CLEARLOCK, TRANS_CLIENTEXECUTE, TRANS_CLIENTJARS, TRANS_CLIENTTEXTTABLE, TRANS_CLIENTUPDATED, TRANS_CLIENTUPDATEDNOLOCK, TRANS_CLIPBOARD, TRANS_CLIPBOARDCOMPONENT, TRANS_CLOSETERMINALWINDOW, TRANS_CONNECTIONREFUSED, TRANS_COUNTRYINFO, TRANS_CREATEPANEL, TRANS_CREATESESSION, TRANS_DDE, TRANS_DDEEVENT, TRANS_DDEEVENTREPLY, TRANS_DDEVAREVENT, TRANS_DISPLAYHELP, TRANS_DISPLAYTERMINAL, TRANS_DISPLAYTOOLTIPS, TRANS_ENDCONVERSATION, TRANS_EXIT, TRANS_FONTSUBSTITUTION, TRANS_HOSTCOLORTABLE, TRANS_HOSTPRINT, TRANS_HWND, TRANS_INACTIVESESSION, TRANS_INITIATE, TRANS_KEEPALIVE, TRANS_LOCALE, TRANS_LOGEVENT, TRANS_MESSAGEBOX, TRANS_MESSAGEBOXWITHREPLY, TRANS_MODALREPLY, TRANS_MULTTERM, TRANS_PING, TRANS_PRINTCOMPONENT, TRANS_PRINTPANEL, TRANS_PRINTREPORT, TRANS_PRTWINKEY, TRANS_RECONNECT, TRANS_REDIRECTION, TRANS_REMOVEPANELATLEVEL, TRANS_REMOVETERMINAL, TRANS_RENEGOTIATESSL, TRANS_REQUESTHELP, TRANS_RESOURCEURL, TRANS_SELECTSESSION, TRANS_SESSIONACTIVE, TRANS_SESSIONSELECTED, TRANS_SETCOLORS, TRANS_SETFOCUS, TRANS_SETLOCK, TRANS_SETPANELNESTLEVEL, TRANS_SETUPPARAMS, TRANS_SHOWDOCUMENT, TRANS_SOCKET, TRANS_SOUNDALARM, TRANS_STARTUPINFO, TRANS_STOPSESSION, TRANS_TERMINALDATA, TRANS_TERMINALUPDATE, TRANS_TERMINALWINDOW, TRANS_TERMWINTEXT, TRANS_UPDATEAPPLICATION, TRANS_UPDATEPANEL, TRANS_USEREXITPRTKEY, TRANSACTION_VERSION, TS_CLOSE, TS_DATA, TS_ERROR, TS_OPEN, VSIGN_MINUS, VSIGN_NONE, VSIGN_PLUSMINUS, YEARF_6DIG, YEARF_8DIG, YEARF_EXP8

Constructor Summary

Constructors
Modifier Constructor and Description

protected VirtualSessionManager(ClientSessionInterface csi)
Creates a new instance of a virtual session.

Constructors
Modifier	Constructor and Description
`protected`	`VirtualSessionManager(ClientSessionInterface csi)` Creates a new instance of a virtual session.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addProcess(Process p)` Adds a Java Process to be terminated when the session is terminated.
`void`	`addVirtualPanelCreationListener(VirtualPanelCreationListener listener)` Adds a panel creation listener for the application.
`void`	`analyzeMatchingScreens()` Analyzes the matching screens.
`void`	`appendTransaction(Transaction trans)` Appends a transaction to the current send transaction.
`boolean`	`areHostChangesProcessedDuringLock()` Checks if host changes are processed during host lock.
`boolean`	`cancelNotebookPaging()` Cancels notebook paging when a user has selected a notebook page that is not the Next or the Previous one.
`boolean`	`changeHostSession(String sessionID)` Change host session.
`boolean`	`changeTextFile(String fileName)` Changes the text file and notifies panels and controls.
`int`	`clientExecute(boolean async, String command, String data, String[] returnArray)` Performs a task on the client side.
`void`	`commitChanges(boolean doClientOnly)` Commits all current pending changes to the client.
`int`	`createModalPanel(String panelID)` Creates a modal non-host-connected panel, displays it and waits for a return code that is passed into VirtualPanel.dismissPanel.
`int`	`createModalPanel(String panelID, VirtualPanelListener listener)` Creates a modal non-host-connected panel, displays it and waits for a return code that is passed into VirtualPanel.dismissPanel.
`VirtualPanel`	`createPanel(String panelID)` Creates a non-host-connected panel and displays it.
`VirtualPanel`	`createPanel(String panelID, VirtualPanelListener listener)` Creates a non-host-connected panel and displays it.
`VirtualPanel`	`createPanel(String panelID, VirtualPanelListener listener, Transaction extraPanelTransaction)` Creates a "dangling" panel within the current panel session.
`boolean`	`createSession(String id)` Creates a new panel session.
`String`	`createTempFile()` Gets a temporary file in the directory of the current runtime file and adds it for removal when the client session is disposed of.
`boolean`	`directCommunication()` Is this instance used for direct communication (server/client in the same JVM)
`void`	`dispose()` Disposes of a virtual session (frees up memory).
`void`	`dontUpdateLastTime()` Causes the last client transaction time not to be set after processing of a queued client event in the onQueuedClientTransaction method.
`void`	`doPanelAsyncHostUpdate()` Causes an asynchronous host update request to the client.
`void`	`doPanelAsyncUpdate(boolean alwaysPost)` Causes an asynchronous update request to the client.
`boolean`	`doSendIDsToClient()` Checks if the flag causing ID's to be transferred to the Client is set.
`void`	`doSendTransaction()` If there is a non-empty send transaction created, this one will be sent using this method.
`boolean`	`enableClientProcessing(boolean on)` Enabled or disables all client processing.
`void`	`fireUpdatesToClient()` Causes pending updates of the application panel or the current session to be sent to the client.
`VirtualPanel`	`getApplicationPanel()` Gets the application panel.
`AdminConfigResource`	`getAuthenticationResource()` Gets the internal user authentication resource.
`String`	`getClientClipboard()` Get client clipboard data.
`ClientConnectionData`	`getClientConnectionData()` Gets the client connection data.
`String[]`	`getClientFontNames()` Gets the available font names that the client has when running as a Java Client (Applet or Application).
`ClientSessionInterface`	`getClientSession()` Access function to get the ClientSession instance.
`Object`	`getComponentLockObject()` Gets the lock object for synchronization for Control Components.
`PhantomApplicationData`	`getCurrentApplication()` Gets the current runtime application.
`PhantomHostData`	`getCurrentHostData()` Gets the current runtime host data.
`PhantomHostFieldLocation`	`getCurrentHostFieldLocation()` Get the PhantomHostField from host cursor position in the current host screen and the location of the cursor relative to the host field.
`PhantomHostScreen`	`getCurrentHostScreen()` Gets the current matching host screen.
`HostSession`	`getCurrentHostSession()` Gets the current host session.
`VirtualRuntime`	`getCurrentRuntime()` Gets the current runtime application.
`VirtualPanelSession`	`getCurrentSession()` Gets the current session.
`VirtualPanel`	`getCurrentTerminalPanel()` Gets the terminal panel from the current panel session.
`VirtualRuntime`	`getCurrentTerminalRuntime()` Gets the current terminal runtime application.
`VirtualPanelSession`	`getCurrentTerminalSession()` Gets the current panel session for the terminal.
`FieldPaintInterface`	`getFieldPainter()` Get the field painter.
`GlobalVariable`	`getGlobalVariables()` Gets the global variables for this session.
`HostSessionManager`	`getHostSessionManager()` Gets the HostSessionManager for this session.
`String`	`getMacroParameter(int oneIndex)` Gets a macro parameter (1-10).
`MouseInterface`	`getMouseHandler()` Get the mouse movement handler.
`Object`	`getObject(String name)` Saves an object in the session table.
`VirtualPanel`	`getPanelSessionTopmostPanel()` Gets the topmost panel in the panel session when running in an application panel.
`ClientSession`	`getPureClientSession()` Access function to get the "pure" ClientSession instance, i.e.
`VirtualRuntime[]`	`getRuntimeApplications()` Gets the runtime applications.
`VirtualPanelSession`	`getSession(int index)` Gets a session by the session index.
`VirtualPanelSession`	`getSession(String id)` Gets a session by the session ID.
`int`	`getSessionCount()` Gets the current count of started sessions.
`String`	`getSessionIDs()` Gets all started session IDs.
`TerminalApplication`	`getTerminalApplication()` Gets the TerminalApplication panel listener, support for multiple terminal windows.
`TerminalFunctions`	`getTerminalFunctions()` Gets the access to the "advanced" terminal functions.
`int`	`getTimeout()` Get current timeout used with wait functions Default timeout is 60 seconds
`long`	`getTimeoutMs()` Get current timeout in milliseconds used with wait functions Default timeout is 600000 milliseconds
`VirtualPanel`	`getTopmostPanel()` Gets the topmost panel in the panel session, or the application panel if applied.
`VirtualInterface`	`getVirtualComponentFromID(String panelID, String ctrlMenuID)` Get control, menu item or special information.
`PhantomWorker`	`getWorker()` Gets the PhantomWorker instance that is global for this client session.
`boolean`	`globVarDelete(String name)` Deletes a global variable.
`String`	`globVarGet(String name)` Gets the contents of a global variable.
`boolean`	`globVarSet(String name, String data)` Sets a global variable.
`boolean`	`hasApplicationPanel()` Checks if the application has an application panel.
`void`	`inhibitHostProcessing(boolean inhibit)` Inhibits or releases the host processing of panels.
`boolean`	`initialize()` Initiates the communication with the client and sets up the requested applications.
`String`	`initiateClientData(String[] appNames, int host, ClientSessionManager csm)` Check user validation, set current runtime and connect to host.
`String`	`initiateClientData(String[] appNames, int host, ClientSessionManager csm, boolean doCheckSecureLogin)` Check user validation, set current runtime and connect to host.
`String`	`initiateClientData(String[] appNames, int host, ClientSessionManager csm, boolean doCheckSecureLogin, boolean doValidateAccess)` Check user validation, set current runtime and connect to host.
`Object`	`invokeAndWait(ServerAction serverAction)` Invokes the server action in the client worker thread and waits for a reply.
`void`	`invokeLater(ServerAction serverAction)` Invokes the server action in the client worker thread later and doesn't wait for a reply.
`boolean`	`isApplet()` Checks if this client is an applet.
`boolean`	`isClient64Bit()` Check if check is running a 64 bit VM.
`boolean`	`isClientProcessingEnabled()` Checks if client processing is enabled.
`boolean`	`isDisposed()` Checks if the client session is disposed.
`boolean`	`isEditor()` Checks if this session is an editor session.
`boolean`	`isJavaWebStart()` Checks if this client is running Java Web Start.
`boolean`	`isLocked()` Checks the lock state.
`String`	`macroPlay(String macroName, String[] arguments)` Play a Phantom macro.
`int`	`message(int type, int icon, String message)` Requests and displays a message to the user.
`int`	`message(int type, int icon, String message, String title)` Requests and displays a message to the user.
`int`	`message(int type, int icon, String message, String title, boolean doWait)` Requests and displays a message to the user.
`boolean`	`preloadPanel(String panel, VirtualPanel vp)` Preloads a panel in the current session.
`void`	`processClientChange()` Processes any changes that has happened in the client session.
`void`	`processHostChange(boolean doClientOnly)` Processes any changes that has happened in the host session.
`void`	`processHostSystemErrorMessage(String msg)` For 5250: there has been a system error message.
`protected boolean`	`processInboundTransaction(ClientSession cs, int transCode, Transaction trans)` Processes a transaction.
`protected boolean`	`processInboundTransactionQueued(ClientSession cs, int transCode, Transaction trans)` The processing of a transaction that has been queued into the Worker thread.
`boolean`	`removeObject(String name)` Removed an object in the session table.
`boolean`	`removeProcess(Process p)` Removes a Java Process to be terminated when the session is terminated.
`boolean`	`removeTempFileName(String fileName)` Removes a temporary file name from the client session.
`void`	`removeToolboxRuntime()` Removes the current toolbox runtime application.
`void`	`removeVirtualPanelCreationListener(VirtualPanelCreationListener listener)` Removes a panel creation listener for the application.
`void`	`requestFocus(VirtualPanelSession vs)` A control wants focus.
`void`	`requestPing()` Request a ping transaction round-trip (posted on the client queue).
`Object`	`saveObject(String name, Object object)` Saves an object in the session table.
`boolean`	`selectNextSession()` Selects the next (bottom-most) panel session.
`boolean`	`selectSession(int index)` Sets a session at the specified index as the current session.
`boolean`	`selectSession(int index, boolean doTellClient)` Sets a session at the specified index as the current session.
`void`	`sendDirectTransactionToClient(Transaction trans)` Called when the server wishes to send a transaction to the client directly into the VirtualSessionManager.
`void`	`sendDirectTransactionToServer(Transaction trans)` Called when the client wishes to send a transaction to the server/editor directly into the VirtualSessionManager.
`boolean`	`sendHostKey(int sendKey, boolean isNewMessage)` Send Phantom host key to the host at current position,
`boolean`	`sendHostString(String string, boolean isNewMessage)` Send string to the host at current position,
`void`	`setChanged()` Sets the client update required flag and posts an asynchronous client update request.
`int`	`setClientClipboard(String data)` Set clipboard data for the client.
`void`	`setCurrentHostScreen(PhantomHostScreen phantomHostScreen)` Sets the current matching host screen.
`boolean`	`setCursorFromHost(int flags)` Places the cursor in the panel in the same position it has in the terminal session.
`void`	`setDirectCommunication(boolean dc)` Set whether this instance used for direct communication (server/client in the same JVM)
`void`	`setDisplayTooltipTexts(boolean on)` Sets display of tooltip texts on the client on or off.
`void`	`setLockState(boolean lock)` Changes the lock state for the client session.
`void`	`setLockStateFromClient(boolean lock)` Changes the lock state for the client session, on a transaction from the client session.
`void`	`setMessageBox(String text)` Creates a message box of a single text that will be displayed on the client.
`void`	`setMessageBox(VirtualMessageBox mb)` Sets the client session message box.
`boolean`	`setPanelFromHostField(String[] panels)` Places the cursor in the panel in the same position it has in the terminal session.
`boolean`	`setRatioAndFontScaling(int ratioX, int ratioY, boolean doScaleFonts)` Sets the ratioX and ratioY parameters and if the fonts should be scaled with these ratio parameters also.
`String[]`	`setRuntimeApplications(String appNames, ClientSessionManager csm)` Sets the runtime application for a non-Java Client Application.
`void`	`setSendIDsToClient(boolean on)` Sets or clears a flag causing ID's to be transferred to the Client for panels and controls.
`void`	`setSessionManager(ClientSessionManagerInterface sm)` Set the session manager reference.
`void`	`setStartMatchingScreenFromFirstApp()` For merge-on-the-fly when using multiple applications, always start search of the matching screen from the first application (default from the application that is currently matching, and then from the first).
`void`	`setStartMatchingScreenFromFirstApp(boolean b)` For merge-on-the-fly when using multiple applications, always start search of the matching screen from the first application (default from the application that is currently matching, and then from the first).
`void`	`setTerminalRuntime(VirtualRuntime runtime)` Sets the runtime application for the terminal session.
`void`	`setTimeout(int numSeconds)` Set current timeout used with different wait functions such as HostWaitScreen and ScrMultiWait.
`void`	`setToolboxRuntime(String runtime, String panelID, VirtualPanelListener listener)` Sets a toolbox runtime for the Server Administration program and displays the panel "panelID".
`void`	`setUpdateTextPromptRequired()` Sets update of text prompts required for the panel sessions.
`void`	`setupServerGlobVar(ClientCommunicationInterface cci)` Sets up SERVER global variables.
`boolean`	`showDocument(String url, String target)` Show URL document.
`static void`	`skipTransaction(Transaction t)` Skips the rest of a transaction.
`boolean`	`stopSession(int index)` Stops a session at the specified index.
`long`	`timerGet(int timerNo)` Returns the current reading on a timer (1-9).
`boolean`	`timerPause(int timerNo)` Pauses a timer (1-9).
`boolean`	`timerStart(int timerNo)` Starts a timer (1-9).
`boolean`	`timerStop(int timerNo)` Stops a timer (1-9).
`void`	`updateLastTime()` Causes the last client transaction time to be set after processing of a queued client event in the onQueuedClientTransaction method.
`void`	`userAuthenticated()` This method is called when user authentication has accepted a user and wants to go on starting the application.
`boolean`	`waitForScreen(String[] screenNames)` Wait until the screen matches one of the specified screen identities.
`boolean`	`wasHostLocked()` Checks if the host was locked since last "refresh".

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

- Field Detail
  - clientSession
```
protected final ClientSessionInterface clientSession
```
    The reference to the client session.
  - isApplet
```
protected int isApplet
```
    The isApplet variable (-1=unknown [RAPP/HTML/SessionPooling/NotInitialized], 0=application, 1=applet, 2=editor, 3=JavaWS, 4=JavaWebStart). When 0x04 is set, we're running the client with JNLP.
  - ratioX
```
public int ratioX
```
    The ratio X for the panel.
  - ratioY
```
public int ratioY
```
    The ratio Y for the panel.
  - ratioScaleFonts
```
public boolean ratioScaleFonts
```
    Flag indicating fonts are scaled with the ratio X and Y settings for panels.
  - fontSubstitution
```
public FontSubstitution fontSubstitution
```
    The font substitution used on the client side, or null if none is used.
- Constructor Detail
  - VirtualSessionManager
```
protected VirtualSessionManager(ClientSessionInterface csi)
```
    Creates a new instance of a virtual session.
- Method Detail
  - getComponentLockObject
```
public Object getComponentLockObject()
```
    Gets the lock object for synchronization for Control Components.
  - dispose
```
public void dispose()
```
    Disposes of a virtual session (frees up memory). Notifies all waiting threads on this object.
  - isDisposed
```
public boolean isDisposed()
```
    Checks if the client session is disposed.
  - getTerminalFunctions
```
public TerminalFunctions getTerminalFunctions()
```
    Gets the access to the "advanced" terminal functions.
  - getTerminalApplication
```
public TerminalApplication getTerminalApplication()
```
    Gets the TerminalApplication panel listener, support for multiple terminal windows.
    
    Returns:
    
    The instance for the terminal window panel, null for none available.
  - isEditor
```
public boolean isEditor()
```
    Checks if this session is an editor session.
  - getCurrentTerminalPanel
```
public VirtualPanel getCurrentTerminalPanel()
```
    Gets the terminal panel from the current panel session. The panel returned has a TerminalApplication listener.
    
    Returns:
    
    null if not found or terminal is not displayed.
  - getCurrentTerminalSession
```
public VirtualPanelSession getCurrentTerminalSession()
```
    Gets the current panel session for the terminal.
    
    Returns:
    
    null if none is present.
  - getCurrentTerminalRuntime
```
public VirtualRuntime getCurrentTerminalRuntime()
```
    Gets the current terminal runtime application.
    
    Returns:
    
    null if none is present.
  - setTerminalRuntime
```
public void setTerminalRuntime(VirtualRuntime runtime)
```
    Sets the runtime application for the terminal session. This method destroys any previous terminal panel session and if the "runtime" is not null, then the panel "TERMINAL" is loaded (should be a main panel).
  - getWorker
```
public PhantomWorker getWorker()
```
    Gets the PhantomWorker instance that is global for this client session.
  - getClientSession
```
public ClientSessionInterface getClientSession()
```
    Access function to get the ClientSession instance.
  - getPureClientSession
```
public ClientSession getPureClientSession()
```
    Access function to get the "pure" ClientSession instance, i.e. not the instance of ClientSessionInterface.
    
    Returns:
    
    null if no "pure" client session is present.
  - getCurrentHostSession
```
public HostSession getCurrentHostSession()
```
    Gets the current host session.
    
    Returns:
    
    null if no current host session exists.
  - getCurrentRuntime
```
public VirtualRuntime getCurrentRuntime()
```
    Gets the current runtime application.
  - getClientConnectionData
```
public ClientConnectionData getClientConnectionData()
```
    Gets the client connection data.
  - getCurrentApplication
```
public PhantomApplicationData getCurrentApplication()
```
    Gets the current runtime application.
  - directCommunication
```
public boolean directCommunication()
```
    Is this instance used for direct communication (server/client in the same JVM)
    
    Specified by:
    
    directCommunication in interface DirectInterface
    
    Returns:
    
    boolean
  - getCurrentHostData
```
public PhantomHostData getCurrentHostData()
```
    Gets the current runtime host data.
  - getAuthenticationResource
```
public AdminConfigResource getAuthenticationResource()
```
    Gets the internal user authentication resource.
  - globVarSet
```
public boolean globVarSet(String name,
                          String data)
```
    Sets a global variable.
    
    Returns:
    
    true=success, false=failure.
  - globVarGet
```
public String globVarGet(String name)
```
    Gets the contents of a global variable. If the variable is not found, null is returned.
  - globVarDelete
```
public boolean globVarDelete(String name)
```
    Deletes a global variable.
    
    Returns:
    
    true=success, false=failure.
  - getGlobalVariables
```
public GlobalVariable getGlobalVariables()
```
    Gets the global variables for this session.
  - setSessionManager
```
public void setSessionManager(ClientSessionManagerInterface sm)
```
    Set the session manager reference.
    
    Specified by:
    
    setSessionManager in interface DirectInterface
    
    Parameters:
    
    sm -
  - setRuntimeApplications
```
public String[] setRuntimeApplications(String appNames,
                                       ClientSessionManager csm)
```
    Sets the runtime application for a non-Java Client Application.
    
    Returns:
    
    false if an application is already set.
  - initialize
```
public boolean initialize()
```
    Initiates the communication with the client and sets up the requested applications.
    
    Returns:
    
    false if there is no current runtime selected.
  - setToolboxRuntime
```
public void setToolboxRuntime(String runtime,
                              String panelID,
                              VirtualPanelListener listener)
                       throws IOException
```
    Sets a toolbox runtime for the Server Administration program and displays the panel "panelID".
    
    Throws:
    
    IOException - for IO errors loading the runtime file.
  - removeToolboxRuntime
```
public void removeToolboxRuntime()
```
    Removes the current toolbox runtime application.
  - userAuthenticated
```
public void userAuthenticated()
```
    This method is called when user authentication has accepted a user and wants to go on starting the application.
  - setStartMatchingScreenFromFirstApp
```
public void setStartMatchingScreenFromFirstApp()
```
    For merge-on-the-fly when using multiple applications, always start search of the matching screen from the first application (default from the application that is currently matching, and then from the first).
  - setStartMatchingScreenFromFirstApp
```
public void setStartMatchingScreenFromFirstApp(boolean b)
```
    For merge-on-the-fly when using multiple applications, always start search of the matching screen from the first application (default from the application that is currently matching, and then from the first).
  - analyzeMatchingScreens
```
public void analyzeMatchingScreens()
```
    Analyzes the matching screens.
  - getSession
```
public VirtualPanelSession getSession(int index)
```
    Gets a session by the session index.
    
    Returns:
    
    null if the session is not created.
  - getCurrentSession
```
public VirtualPanelSession getCurrentSession()
```
    Gets the current session.
    
    Returns:
    
    null if there is no current session set-up.
  - hasApplicationPanel
```
public boolean hasApplicationPanel()
```
    Checks if the application has an application panel.
  - getApplicationPanel
```
public VirtualPanel getApplicationPanel()
```
    Gets the application panel.
    
    Returns:
    
    null if there is no application panel.
  - appendTransaction
```
public void appendTransaction(Transaction trans)
```
    Appends a transaction to the current send transaction.
  - setMessageBox
```
public void setMessageBox(String text)
```
    Creates a message box of a single text that will be displayed on the client.
  - setMessageBox
```
public void setMessageBox(VirtualMessageBox mb)
```
    Sets the client session message box. Just one can be set at a time.
  - doSendTransaction
```
public void doSendTransaction()
```
    If there is a non-empty send transaction created, this one will be sent using this method.
  - commitChanges
```
public void commitChanges(boolean doClientOnly)
```
    Commits all current pending changes to the client. E.g. typically done before changing a panel session.
  - processClientChange
```
public void processClientChange()
```
    Processes any changes that has happened in the client session.
  - getHostSessionManager
```
public HostSessionManager getHostSessionManager()
```
    Gets the HostSessionManager for this session.
    
    Returns:
    
    HostSessionManager
  - processHostChange
```
public void processHostChange(boolean doClientOnly)
```
    Processes any changes that has happened in the host session. The flag "doClientOnly" causes host events to be ignored.
  - wasHostLocked
```
public boolean wasHostLocked()
```
    Checks if the host was locked since last "refresh".
  - setLockState
```
public void setLockState(boolean lock)
```
    Changes the lock state for the client session.
  - setUpdateTextPromptRequired
```
public void setUpdateTextPromptRequired()
```
    Sets update of text prompts required for the panel sessions.
  - setDirectCommunication
```
public void setDirectCommunication(boolean dc)
```
    Set whether this instance used for direct communication (server/client in the same JVM)
    
    Specified by:
    
    setDirectCommunication in interface DirectInterface
    
    Parameters:
    
    dc - Flag for direct communication in the same JVM. For internal use only.
  - setLockStateFromClient
```
public void setLockStateFromClient(boolean lock)
```
    Changes the lock state for the client session, on a transaction from the client session.
    
    Parameters:
    
    lock - The new lock state. Even if there is no change of state and asynchronous panel update is triggered to run a little later in the client session thread.
  - setChanged
```
public void setChanged()
```
    Sets the client update required flag and posts an asynchronous client update request.
  - doPanelAsyncUpdate
```
public void doPanelAsyncUpdate(boolean alwaysPost)
```
    Causes an asynchronous update request to the client. This update will be processed by the ClientWorker thread.
  - doPanelAsyncHostUpdate
```
public void doPanelAsyncHostUpdate()
```
    Causes an asynchronous host update request to the client. This update will be processed by the ClientWorker thread. If this is called an no current host session exist, a normal doPanelAsyncUpdate(true) will be executed.
  - fireUpdatesToClient
```
public void fireUpdatesToClient()
```
    Causes pending updates of the application panel or the current session to be sent to the client.
  - inhibitHostProcessing
```
public void inhibitHostProcessing(boolean inhibit)
```
    Inhibits or releases the host processing of panels. The current session is notified of this change.
  - createSession
```
public boolean createSession(String id)
```
    Creates a new panel session. If there is no application panel, false will be returned.
  - getSession
```
public VirtualPanelSession getSession(String id)
```
    Gets a session by the session ID.
    
    Returns:
    
    null if the session is not found.
  - stopSession
```
public boolean stopSession(int index)
```
    Stops a session at the specified index.
    
    Returns:
    
    success flag.
  - selectNextSession
```
public boolean selectNextSession()
```
    Selects the next (bottom-most) panel session.
    
    Returns:
    
    success flag.
  - selectSession
```
public boolean selectSession(int index)
```
    Sets a session at the specified index as the current session. The client is informed of the change.
    
    Returns:
    
    success flag.
  - selectSession
```
public boolean selectSession(int index,
                             boolean doTellClient)
```
    Sets a session at the specified index as the current session. The client is informed of the change depending on "doTellClient".
    
    Returns:
    
    success flag.
  - getSessionIDs
```
public String getSessionIDs()
```
    Gets all started session IDs. The IDs are delimited by spaces.
    
    Returns:
    
    empty string if no sessions are started.
  - getSessionCount
```
public int getSessionCount()
```
    Gets the current count of started sessions.
  - requestFocus
```
public void requestFocus(VirtualPanelSession vs)
```
    A control wants focus. This is informed to the session manager by the virtual panel session. A transaction may be sent to the client as a result of this.
  - showDocument
```
public boolean showDocument(String url,
                            String target)
```
    Show URL document.
    
    Returns:
    
    false if error and true if OK.
  - clientExecute
```
public int clientExecute(boolean async,
                         String command,
                         String data,
                         String[] returnArray)
```
    Performs a task on the client side. The first parameter should be true (=sync) or false (=async) execution mode, the second parameter the command to execute (if the data parameter is null), otherwise the command parameter is the file name for the temporary file that is created with the "data".
    The returnArray should be either null or be allocated with at least two strings that will be set upon return of this function. The first element will be the "stdout" and the second the "stderr".
    This method blocks until the client responds.
    
    Returns:
    
    -1 for total failure, otherwise the return code from the process (always zero for async if the process was started.
  - processInboundTransaction
```
protected boolean processInboundTransaction(ClientSession cs,
                                            int transCode,
                                            Transaction trans)
```
    Processes a transaction.
    
    Parameters:
    
    cs - The client session.
    
    transCode - The transaction code.
    
    trans - The transaction.
    
    Returns:
    
    true if the transaction is processed somehow, even if "sent directly".
  - dontUpdateLastTime
```
public void dontUpdateLastTime()
```
    Causes the last client transaction time not to be set after processing of a queued client event in the onQueuedClientTransaction method. If this method is not called, the last client transaction time is set at the end of the onQueuedClientTransaction method.
  - updateLastTime
```
public void updateLastTime()
```
    Causes the last client transaction time to be set after processing of a queued client event in the onQueuedClientTransaction method. If this method is not called, the last client transaction time is set at the end of the onQueuedClientTransaction method, and the warning time too.
  - processInboundTransactionQueued
```
protected boolean processInboundTransactionQueued(ClientSession cs,
                                                  int transCode,
                                                  Transaction trans)
```
    The processing of a transaction that has been queued into the Worker thread.
    
    Parameters:
    
    cs - The client session.
    
    transCode - The transaction code.
    
    trans - The transaction.
    
    Returns:
    
    true if the transaction is processed somehow, even if "sent directly".
  - skipTransaction
```
public static void skipTransaction(Transaction t)
```
    Skips the rest of a transaction.
  - getFieldPainter
```
public FieldPaintInterface getFieldPainter()
```
    Get the field painter.
    
    Specified by:
    
    getFieldPainter in interface DirectInterface
    
    Returns:
    
    FieldPainter
  - getMouseHandler
```
public MouseInterface getMouseHandler()
```
    Get the mouse movement handler.
    
    Specified by:
    
    getMouseHandler in interface DirectInterface
    
    Returns:
    
    mouseHandler
  - initiateClientData
```
public String initiateClientData(String[] appNames,
                                 int host,
                                 ClientSessionManager csm)
```
    Check user validation, set current runtime and connect to host. If user is refused from any application, the name of that application is returned.
  - initiateClientData
```
public String initiateClientData(String[] appNames,
                                 int host,
                                 ClientSessionManager csm,
                                 boolean doCheckSecureLogin)
```
    Check user validation, set current runtime and connect to host. If user is refused from any application, the name of that application is returned.
  - initiateClientData
```
public String initiateClientData(String[] appNames,
                                 int host,
                                 ClientSessionManager csm,
                                 boolean doCheckSecureLogin,
                                 boolean doValidateAccess)
```
    Check user validation, set current runtime and connect to host. If user is refused from any application, the name of that application is returned.
  - processHostSystemErrorMessage
```
public void processHostSystemErrorMessage(String msg)
```
    For 5250: there has been a system error message. This is normally displayed as a message box on the client.
  - requestPing
```
public void requestPing()
```
    Request a ping transaction round-trip (posted on the client queue).
  - preloadPanel
```
public boolean preloadPanel(String panel,
                            VirtualPanel vp)
```
    Preloads a panel in the current session.
    
    Returns:
    
    true = success.
  - isLocked
```
public boolean isLocked()
```
    Checks the lock state.
  - getVirtualComponentFromID
```
public VirtualInterface getVirtualComponentFromID(String panelID,
                                                  String ctrlMenuID)
```
    Get control, menu item or special information. This method handles Application panel title and menus, all other components are handled in VirtualPanelSession. Returns VirtualInterface.
  - getCurrentHostScreen
```
public PhantomHostScreen getCurrentHostScreen()
```
    Gets the current matching host screen.
  - setCurrentHostScreen
```
public void setCurrentHostScreen(PhantomHostScreen phantomHostScreen)
```
    Sets the current matching host screen. This method is used when running GOF.
    
    Parameters:
    
    phantomHostScreen - The PhantomHostScreen to set as the current matching host screen.
  - areHostChangesProcessedDuringLock
```
public boolean areHostChangesProcessedDuringLock()
```
    Checks if host changes are processed during host lock.
  - timerGet
```
public long timerGet(int timerNo)
```
    Returns the current reading on a timer (1-9).
    
    Returns:
    
    0 for error; long containing time in milliseconds if successful.
  - timerPause
```
public boolean timerPause(int timerNo)
```
    Pauses a timer (1-9).
    
    Returns:
    
    true if the timer was successfully paused.
  - timerStart
```
public boolean timerStart(int timerNo)
```
    Starts a timer (1-9). If the timer has been started previously, it will be restarted from 0. If paused it will resume the timer.
    
    Returns:
    
    true if successful.
  - timerStop
```
public boolean timerStop(int timerNo)
```
    Stops a timer (1-9).
    
    Returns:
    
    true if successful.
  - setTimeout
```
public void setTimeout(int numSeconds)
```
    Set current timeout used with different wait functions such as HostWaitScreen and ScrMultiWait. Default timeout is 60 seconds.
  - getTimeout
```
public int getTimeout()
```
    Get current timeout used with wait functions Default timeout is 60 seconds
  - getTimeoutMs
```
public long getTimeoutMs()
```
    Get current timeout in milliseconds used with wait functions Default timeout is 600000 milliseconds
  - macroPlay
```
public String macroPlay(String macroName,
                        String[] arguments)
```
    Play a Phantom macro.
    
    Returns:
    
    a string result from Macro (or "9" if not found).
  - getMacroParameter
```
public String getMacroParameter(int oneIndex)
```
    Gets a macro parameter (1-10).
    
    Returns:
    
    empty string for no parameter (or invalid index).
  - setCursorFromHost
```
public boolean setCursorFromHost(int flags)
```
    Places the cursor in the panel in the same position it has in the terminal session.
    
    Returns:
    
    true for success and false for error
  - getCurrentHostFieldLocation
```
public PhantomHostFieldLocation getCurrentHostFieldLocation()
```
    Get the PhantomHostField from host cursor position in the current host screen and the location of the cursor relative to the host field.
    
    Returns:
    
    null if host field not found
  - setPanelFromHostField
```
public boolean setPanelFromHostField(String[] panels)
```
    Places the cursor in the panel in the same position it has in the terminal session.
    
    Returns:
    
    true for success and false for error
  - waitForScreen
```
public boolean waitForScreen(String[] screenNames)
                      throws InterruptedException
```
    Wait until the screen matches one of the specified screen identities.
    
    Returns:
    
    true for screen found or false for error
    
    Throws:
    
    InterruptedException
  - sendHostString
```
public boolean sendHostString(String string,
                              boolean isNewMessage)
```
    Send string to the host at current position,
    
    Returns:
    
    true if OK, false for error
  - sendHostKey
```
public boolean sendHostKey(int sendKey,
                           boolean isNewMessage)
```
    Send Phantom host key to the host at current position,
    
    Returns:
    
    true if OK, false for error
  - changeHostSession
```
public boolean changeHostSession(String sessionID)
```
    Change host session.
    
    Returns:
    
    true = OK or false = Not OK. Will always return false if sessionID is not (A-Z, a-z, "." or space).
  - cancelNotebookPaging
```
public boolean cancelNotebookPaging()
```
    Cancels notebook paging when a user has selected a notebook page that is not the Next or the Previous one.
    This function is used when the host system has the possibility of jumping to the required page directly or if paging needs to be interrupted due to, for example, an error situation.
    When a user presses a notebook tab, the object connected to the action of the page(s) is started until an error occurs. If the object runs in a separate thread, i.e. is a Java Application, special care must be taken because multiple threads might be started. The preferred Java object type is Java Macro because it is started synchronously within the same thread as the Phantom client session.
    There is no need to lock the panel or to turn off processing when this function is used. When a notebook tab is clicked, just cancel paging when the transaction is sent.
    When a user selects a notebook tab, Phantom normally will start to turn pages one by one until the desired page is reached, using the defined previous/next actions. This function will prevent this from happening, which makes it possible to use a single object to turn pages.
    
    Returns:
    
    true = OK or false = Not OK
    
    See Also:
    
    NetRexxMigration.PanNbCancelPaging()
  - message
```
public int message(int type,
                   int icon,
                   String message)
```
    Requests and displays a message to the user. A message box will be displayed to the user containing the message. This function can also be used to ask the user simple questions. Type and Icon above refer to the desired message type and message icon, respectively (see below). The length of the message should not exceed 200 characters due to space limitations in a message box (Swing: JOptionPane).
    Note: At this time, only a Java application (i.e. running in a separate thread can be used to retrieve the return value. This is due to the fact that the client can respond to the message at a later time. This limitation may be removed in the future.
    Type:
```
   1  Message with Cancel button.
   2  Message with OK button.
   3  Message with OK/Cancel question.
   4  Message with Enter button.
   5  Message with Enter/Cancel question.
   6  Message with Yes/No question.
   7  Message with Yes/No/Cancel question.
   8  Message with Retry/Cancel question.
   9  Message with Retry/Ignore/Cancel question.
 
```
    Icon:
```
   1  No icon
   2  Information code
   3  Question mark
   4  Warning code
   5  Stop code
 
```
    Return value:
```
   0  Incorrect parameters.
   1  Response: Cancel.
   2  Response: OK.
   3  Response: Enter.
   4  Response: Yes.
   5  Response: No.
   6  Response: Retry.
   7  Response: Ignore.
 
```
  - message
```
public int message(int type,
                   int icon,
                   String message,
                   String title)
```
    Requests and displays a message to the user. A message box will be displayed to the user containing the message. This function can also be used to ask the user simple questions. Type and Icon above refer to the desired message type and message icon, respectively (see below). The length of the message should not exceed 200 characters due to space limitations in a message box (Swing: JOptionPane).
    Note: At this time, only a Java application (i.e. running in a separate thread can be used to retrieve the return value. This is due to the fact that the client can respond to the message at a later time. This limitation may be removed in the future.
    Type:
```
   1  Message with Cancel button.
   2  Message with OK button.
   3  Message with OK/Cancel question.
   4  Message with Enter button.
   5  Message with Enter/Cancel question.
   6  Message with Yes/No question.
   7  Message with Yes/No/Cancel question.
   8  Message with Retry/Cancel question.
   9  Message with Retry/Ignore/Cancel question.
 
```
    Icon:
```
   1  No icon
   2  Information code
   3  Question mark
   4  Warning code
   5  Stop code
 
```
    Return value:
```
   0  Incorrect parameters.
   1  Response: Cancel.
   2  Response: OK.
   3  Response: Enter.
   4  Response: Yes.
   5  Response: No.
   6  Response: Retry.
   7  Response: Ignore.
 
```
  - message
```
public int message(int type,
                   int icon,
                   String message,
                   String title,
                   boolean doWait)
```
    Requests and displays a message to the user. A message box will be displayed to the user containing the message. This function can also be used to ask the user simple questions. Type and Icon above refer to the desired message type and message icon, respectively (see below). The length of the message should not exceed 200 characters due to space limitations in a message box (Swing: JOptionPane).
    Note: At this time, only a Java application (i.e. running in a separate thread can be used to retrieve the return value. This is due to the fact that the client can respond to the message at a later time. This limitation may be removed in the future.
    Type:
```
   1  Message with Cancel button.
   2  Message with OK button.
   3  Message with OK/Cancel question.
   4  Message with Enter button.
   5  Message with Enter/Cancel question.
   6  Message with Yes/No question.
   7  Message with Yes/No/Cancel question.
   8  Message with Retry/Cancel question.
   9  Message with Retry/Ignore/Cancel question.
 
```
    Icon:
```
   1  No icon
   2  Information code
   3  Question mark
   4  Warning code
   5  Stop code
 
```
    Return value:
```
   0  Incorrect parameters.
   1  Response: Cancel.
   2  Response: OK.
   3  Response: Enter.
   4  Response: Yes.
   5  Response: No.
   6  Response: Retry.
   7  Response: Ignore.
 
```
  - changeTextFile
```
public boolean changeTextFile(String fileName)
```
    Changes the text file and notifies panels and controls.
    
    Returns:
    
    true = successful, false = failure.
  - saveObject
```
public Object saveObject(String name,
                         Object object)
```
    Saves an object in the session table. If this there is a previous object in the table with this name, that object will be unreferenced.
    
    Returns:
    
    Object the previous object instance if any, null for no previous object.
    
    See Also:
    
    getObject(java.lang.String), removeObject(java.lang.String)
  - getObject
```
public Object getObject(String name)
```
    Saves an object in the session table. If this there is a previous object in the table with this name, that object will be unreferenced.
    
    Returns:
    
    null if no object of this name is found.
    
    See Also:
    
    saveObject(java.lang.String, java.lang.Object), removeObject(java.lang.String)
  - removeObject
```
public boolean removeObject(String name)
```
    Removed an object in the session table.
    
    Returns:
    
    true for successful operation.
    
    See Also:
    
    getObject(java.lang.String), saveObject(java.lang.String, java.lang.Object)
  - setClientClipboard
```
public int setClientClipboard(String data)
```
    Set clipboard data for the client.
  - getClientClipboard
```
public String getClientClipboard()
```
    Get client clipboard data. This is waiting for a modal return code and must therefore be called from a thread.
  - createPanel
```
public VirtualPanel createPanel(String panelID)
```
    Creates a non-host-connected panel and displays it. There must be a current runtime and panel session.
    Using this function, the panel will not have a panel listener.
    This function should be used to create local panels and not using the normal panels that are controlled from e.g. the host or the system.
    
    Returns:
    
    panel for success,
    null for failure (error is output on System.out).
  - createPanel
```
public VirtualPanel createPanel(String panelID,
                                VirtualPanelListener listener)
```
    Creates a non-host-connected panel and displays it. There must be a current runtime and panel session.
    If no panel listener is required, set the listener parameter to null.
    This function should be used to create local panels and not using the normal panels that are controlled from e.g. the host or the system.
    
    Returns:
    
    panel for success,
    null for failure (error is output on System.out).
  - createPanel
```
public VirtualPanel createPanel(String panelID,
                                VirtualPanelListener listener,
                                Transaction extraPanelTransaction)
```
    Creates a "dangling" panel within the current panel session. This panel does not have a specific index or is neither a main or a pop-up panel. It is used by the Editor to create panels that are dockable in panes, frames or internal frames.
    The extraPanelTransaction may not be null (minimum new Transaction()).
  - createModalPanel
```
public int createModalPanel(String panelID)
```
    Creates a modal non-host-connected panel, displays it and waits for a return code that is passed into VirtualPanel.dismissPanel. There must be a current runtime and panel session.
    Using this function, the panel will not have a panel listener.
    This function should be used to create local panels and not using the normal panels that are controlled from e.g. the host or the system.
    
    Returns:
    
    -1 for failure (error is output on System.out).
    other return codes passed into VirtualPanel.dismissPanel.
  - createModalPanel
```
public int createModalPanel(String panelID,
                            VirtualPanelListener listener)
```
    Creates a modal non-host-connected panel, displays it and waits for a return code that is passed into VirtualPanel.dismissPanel. There must be a current runtime and panel session.
    If no panel listener is required, set the listener parameter to null.
    This function should be used to create local panels and not using the normal panels that are controlled from e.g. the host or the system.
    
    Returns:
    
    -1 for failure (error is output on System.out).
    other return codes passed into VirtualPanel.dismissPanel.
  - sendDirectTransactionToServer
```
public void sendDirectTransactionToServer(Transaction trans)
```
    Called when the client wishes to send a transaction to the server/editor directly into the VirtualSessionManager.
    
    Specified by:
    
    sendDirectTransactionToServer in interface DirectInterface
  - sendDirectTransactionToClient
```
public void sendDirectTransactionToClient(Transaction trans)
```
    Called when the server wishes to send a transaction to the client directly into the VirtualSessionManager.
    
    Specified by:
    
    sendDirectTransactionToClient in interface DirectInterface
  - setupServerGlobVar
```
public void setupServerGlobVar(ClientCommunicationInterface cci)
```
    Sets up SERVER global variables.
```
 NETPHANTOM_SERVER_PORT
   The port of the server that the client is accessing.

 NETPHANTOM_SERVER_HOSTADDR
   The host address of the server.

 NETPHANTOM_SERVER_HOSTNAME
   The host name of the server or the IP address as nnn.mmm.ooo.ppp if none is found.

 NETPHANTOM_SERVER_FULLSRVNAME
   The full server name including the protocol, i.e. http[s]://fullsrvname.

 NETPHANTOM_SERVER_CTRLSERVERPORT
   The port of the controller server that the client is accessing. This is used for
   Load Balancing.

 NETPHANTOM_SERVER_CTRLSERVERNAME
   The host name of the server or the IP address as nnn.mmm.ooo.ppp if none is found
   of the controller server. This is used for Load Balancing.

 NETPHANTOM_SERVER_FULLCTRLSRVNAME
   The full server name of the controller server including the protocol. This is used
   for Load Balancing.

 NETPHANTOM_SERVER_PROTOCOL
   The protocol used (evaluates to http or https).

 NETPHANTOM_SERVER_SSLLEVELindex (where index is 1 to 4)
   1: The level of information: "0" or "1" if encrypted or not.
   2: The level of information: "0" or "1" if strong encrypted (>=128 bits) or not.
   3: The level of information: The number of effective bits for encryption.
   4: The level of information: the name of the cipher being used.
 
```
  - addProcess
```
public boolean addProcess(Process p)
```
    Adds a Java Process to be terminated when the session is terminated.
    
    Returns:
    
    false if the process should be terminated immediately because the client session is disposed, true for success.
  - removeProcess
```
public boolean removeProcess(Process p)
```
    Removes a Java Process to be terminated when the session is terminated.
    
    Returns:
    
    true for success, false if the process was not registered using the "addProcess" call.
  - createTempFile
```
public String createTempFile()
```
    Gets a temporary file in the directory of the current runtime file and adds it for removal when the client session is disposed of.
    
    Returns:
    
    null if the client session is disposed of or the file couldn't be created, otherwise a temporary file name.
  - removeTempFileName
```
public boolean removeTempFileName(String fileName)
```
    Removes a temporary file name from the client session. If the file exists, it is deleted.
    
    Returns:
    
    true for success, false if the file name was not registered using the "getTempFileName" call.
  - setSendIDsToClient
```
public void setSendIDsToClient(boolean on)
```
    Sets or clears a flag causing ID's to be transferred to the Client for panels and controls. When this flag is set, the next time a panel is created, the ID's will be sent to the client, and if the flag is cleared, the IDs won't be sent to the client upon next panel creation.
  - doSendIDsToClient
```
public boolean doSendIDsToClient()
```
    Checks if the flag causing ID's to be transferred to the Client is set.
  - addVirtualPanelCreationListener
```
public void addVirtualPanelCreationListener(VirtualPanelCreationListener listener)
```
    Adds a panel creation listener for the application.
  - removeVirtualPanelCreationListener
```
public void removeVirtualPanelCreationListener(VirtualPanelCreationListener listener)
```
    Removes a panel creation listener for the application.
  - invokeLater
```
public void invokeLater(ServerAction serverAction)
```
    Invokes the server action in the client worker thread later and doesn't wait for a reply.
  - invokeAndWait
```
public Object invokeAndWait(ServerAction serverAction)
```
    Invokes the server action in the client worker thread and waits for a reply. This call is working also for the AWT thread for the Editor when the DirectInterface is used. If the client or the system closes the client process, a ClientSessionDisposed is thrown. If this method is invoked from the client worker thread, an InternalError is thrown.
    
    Returns:
    
    the return code from the server action or null if the client process is closed by the user or the system.
  - getTopmostPanel
```
public VirtualPanel getTopmostPanel()
```
    Gets the topmost panel in the panel session, or the application panel if applied.
    
    Returns:
    
    The topmost panel in the application, null if none is found.
  - getPanelSessionTopmostPanel
```
public VirtualPanel getPanelSessionTopmostPanel()
```
    Gets the topmost panel in the panel session when running in an application panel. When no application panel is present, the current session is used.
    
    Returns:
    
    The topmost panel in the application, the application or null if none is found.
  - getRuntimeApplications
```
public VirtualRuntime[] getRuntimeApplications()
```
    Gets the runtime applications.
  - isApplet
```
public boolean isApplet()
```
    Checks if this client is an applet.
  - isJavaWebStart
```
public boolean isJavaWebStart()
```
    Checks if this client is running Java Web Start.
  - getClientFontNames
```
public String[] getClientFontNames()
```
    Gets the available font names that the client has when running as a Java Client (Applet or Application).
  - setRatioAndFontScaling
```
public boolean setRatioAndFontScaling(int ratioX,
                                      int ratioY,
                                      boolean doScaleFonts)
```
    Sets the ratioX and ratioY parameters and if the fonts should be scaled with these ratio parameters also.
    Note: when these settings are changed, it is important to quickly display a MAIN panel that has the option "Change main panel size" in order to recalculate the size and fonts correctly.
    
    Parameters:
    
    ratioX - the ratio in X for scaling in percent (%), 100=normal.
    
    ratioY - the ratio in Y for scaling in percent (%), 100=normal.
    
    doScaleFonts - flag indicating if the fonts should be scaled as well.
    
    Returns:
    
    true for success, false for failure (e.g. not a Java Client or the Editor).
  - setDisplayTooltipTexts
```
public void setDisplayTooltipTexts(boolean on)
```
    Sets display of tooltip texts on the client on or off.
  - enableClientProcessing
```
public boolean enableClientProcessing(boolean on)
```
    Enabled or disables all client processing.
    
    Parameters:
    
    on - true to enable processing, false to disable it.
    
    Returns:
    
    true for a setting change, false if nothing was changed.
  - isClientProcessingEnabled
```
public boolean isClientProcessingEnabled()
```
    Checks if client processing is enabled.
    
    Returns:
    
    true if client processing is enabled, false otherwise.
  - isClient64Bit
```
public boolean isClient64Bit()
```
    Check if check is running a 64 bit VM.

Class VirtualSessionManager

Field Summary

Fields inherited from interface se.entra.phantom.common.NetPhantomConstants

Fields inherited from interface se.entra.phantom.server.ObjectMessages

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clientSession

isApplet

ratioX

ratioY

ratioScaleFonts

fontSubstitution

Constructor Detail

VirtualSessionManager

Method Detail

getComponentLockObject

dispose

isDisposed

getTerminalFunctions

getTerminalApplication

isEditor

getCurrentTerminalPanel

getCurrentTerminalSession

getCurrentTerminalRuntime

setTerminalRuntime

getWorker

getClientSession

getPureClientSession

getCurrentHostSession

getCurrentRuntime

getClientConnectionData

getCurrentApplication

directCommunication

getCurrentHostData

getAuthenticationResource

globVarSet

globVarGet

globVarDelete

getGlobalVariables

setSessionManager

setRuntimeApplications

initialize

setToolboxRuntime

removeToolboxRuntime

userAuthenticated

setStartMatchingScreenFromFirstApp

setStartMatchingScreenFromFirstApp

analyzeMatchingScreens

getSession

getCurrentSession

hasApplicationPanel

getApplicationPanel

appendTransaction

setMessageBox

setMessageBox

doSendTransaction

commitChanges

processClientChange

getHostSessionManager

processHostChange

wasHostLocked

setLockState

setUpdateTextPromptRequired

setDirectCommunication

setLockStateFromClient

setChanged

doPanelAsyncUpdate

doPanelAsyncHostUpdate

fireUpdatesToClient

inhibitHostProcessing

createSession

getSession

stopSession

selectNextSession

selectSession

selectSession

getSessionIDs

getSessionCount