se.entra.phantom.client

Class SessionManager

java.lang.Object

se.entra.phantom.client.SessionManager

All Implemented Interfaces:

Runnable, ClientSessionManagerInterface, NetPhantomConstants

public class SessionManager
extends Object
implements NetPhantomConstants, Runnable, ClientSessionManagerInterface

The session manager of the client. This is the single instance of the session manager in the client. It handles all transactions between the client and the server, along with the windows, lock state, etc...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SessionManager.Session This class handles all panels in a panel session.

Field Summary

Fields

Modifier and Type	Field and Description
Container	rootFrame The root frame window.
Terminal	terminal The single terminal window instance.

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	SessionManager(Phantom p, Container c, boolean pib) Creates the session manager of the client.

Method Summary

Modifier and Type	Method and Description
boolean	areTooltipsDisplayed() Gets the flag indicating tool-tips should or not be displayed on the client (informational tooltips, not e.g.
String	callObject(String objectID, String argID, int action, String argString, boolean doModal) Calls an object in the server.
void	clearLock() Clears the lock state.
void	clearNextMessageBoxOwner() Clears the next dialog owner for message boxes.
void	closeTunnel(int port) Closes a socket tunnel from the client to the server on the specified port.
TunnelPort	createTunnel(int port, String dest) Creates a socket tunnel from the client to the server on the specified port.
void	ddeEvent(Transaction ddeTrans) Callback method from DdeInterface object, to send an event to a server object.
boolean	doPlacePanelsInBrowser() Checks if all panels should be placed inside the browser, i.e.
Container	getApplicationContainer() Gets the application panel or the JApplet container.
PPanel	getApplicationPanel() Gets the application panel.
static int	getComboAutoComplete() The configuration of combobox auto-completion.
se.entra.phantom.client.PRuntime	getCurrentRuntime() Gets the current runtime application.
SessionManager.Session	getCurrentSession() Gets the current topmost panel session.
JDesktopPane	getDesktopPane() Gets the desktop pane where all the panels are placed, including the application panel.
URL	getDocumentURL(String doc) Gets an URL relative or fixed used to display help documents and documents used with showDocument.
PFocusManager	getFocusManager()
int	getListBodyBackground() The list body background color in RGB or -1 if not defined.
int	getListHeaderBackground() The list header background color in RGB or -1 if not defined.
Container	getMessageBoxParent() Gets the message box parent frame.
Container	getNextDialogOwner() Gets the next Frame or Dialog parent for a dialog box, this is nulled once it is used and only used by the editor.
Phantom	getPhantomApplet() Gets the reference to the Phantom instance (applet).
String	getProperty(String name) Gets a property for the runtime application.
int	getProperty(String name, int defaultValue) Gets an integer property for the runtime application.
Container	getRootFrame() Gets the root frame.
SessionManager.Session	getSession(int ii) Gets a session with a specific index.
Component	getTopMostPanel() Gets the top-most panel.
TunnelPort[]	getTunnels() Gets the current tunnels.
String	getUserExitPrintFont() Get the override user exit print font.
String	getUserExitPrintListFont() Get the override user exit print font for list box.
boolean	isPrintWindow(KeyEvent e) Checks if a key event is a print window keystroke.
boolean	isSessionLocked() Checks if the session is currently locked.
boolean	isUserExitPrint(KeyEvent e) Checks if a key event is a user exit print keystroke.
void	messageBox(boolean doReply, int icon, int buttons, String head, String msg) Displays a message box.
int	messageBox(boolean doReply, int icon, int buttons, String head, String msg, boolean doSendToServer) Displays a message box.
RemoteSocket	newRemoteSocket(String host, int port) Opens a new remote socket on the server.
protected boolean	processInboundTransaction(int transCode, Transaction trans) Processes a transaction.
protected boolean	processInboundTransactionAWT(int transCode, Transaction trans) The processing of a transaction in the AWT thread.
protected boolean	processInboundTransactionWithDragLock(int transCode, Transaction trans) Processes a transaction.
void	run() Runs transactions in the AWT event thread rather than the "socket reader" thread.
Container	selectTopmostPanel() Selects the top-most panel in the top-most session.
void	sendDdeReply(int replyValue) Send DDE reply to server.
void	sendDirectTransaction(Transaction trans) Send a transaction directly to be processed.
void	setDesktopPane(JDesktopPane pane) Sets the desktop pane directly.
void	setLock() Sets the lock state on.
void	setLockState(boolean lock) Sets the lock state on or off.
void	setNextDialogOwner(Container frameOrDialog) The next Frame or Dialog parent for a dialog box, this is nulled once it is used and only used by the editor.
void	setProperty(String name, String value) Sets a property for the runtime.

Methods inherited from class java.lang.Object

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

Field Detail

terminal

public Terminal terminal

The single terminal window instance.

rootFrame

public Container rootFrame

The root frame window.

Constructor Detail

SessionManager

protected SessionManager(Phantom p,
                         Container c,
                         boolean pib)

Creates the session manager of the client. This is the single instance of the session manager in the client. It handles all transactions between the client and the server, along with the windows, lock state, etc...

Method Detail

getRootFrame

public Container getRootFrame()

Gets the root frame.

getMessageBoxParent

public Container getMessageBoxParent()

Gets the message box parent frame.

isSessionLocked

public boolean isSessionLocked()

Checks if the session is currently locked.

getApplicationContainer

public Container getApplicationContainer()

Gets the application panel or the JApplet container.

Returns:

null if no such container exist.

getPhantomApplet

public Phantom getPhantomApplet()

Gets the reference to the Phantom instance (applet).

getProperty

public String getProperty(String name)

Gets a property for the runtime application. Example of properties "desktop.image" and "desktop.color".

Returns:

null if the property is not found.

getProperty

public int getProperty(String name,
                       int defaultValue)

Gets an integer property for the runtime application.

Returns:

defaultValue if not found.

setProperty

public void setProperty(String name,
                        String value)

Sets a property for the runtime. If the "value" is null, the property is removed. Example of properties "desktop.image" and "desktop.color".

getCurrentRuntime

public se.entra.phantom.client.PRuntime getCurrentRuntime()

Gets the current runtime application.

getCurrentSession

public SessionManager.Session getCurrentSession()

Gets the current topmost panel session.

Returns:

null for none or if it's not inside an application panel.

getSession

public SessionManager.Session getSession(int ii)

Gets a session with a specific index.

Returns:

null for not found, otherwise a SessionManager.Session.

getApplicationPanel

public PPanel getApplicationPanel()

Gets the application panel.

doPlacePanelsInBrowser

public boolean doPlacePanelsInBrowser()

Checks if all panels should be placed inside the browser, i.e. inside the JApplet.

getDesktopPane

public JDesktopPane getDesktopPane()

Gets the desktop pane where all the panels are placed, including the application panel.

setDesktopPane

public void setDesktopPane(JDesktopPane pane)

Sets the desktop pane directly.

getListHeaderBackground

public int getListHeaderBackground()

The list header background color in RGB or -1 if not defined.

getListBodyBackground

public int getListBodyBackground()

The list body background color in RGB or -1 if not defined.

getComboAutoComplete

public static int getComboAutoComplete()

The configuration of combobox auto-completion.

setLockState

public void setLockState(boolean lock)

Sets the lock state on or off. When on, the cursor will change into an hour glass.

getUserExitPrintFont

public String getUserExitPrintFont()

Get the override user exit print font.

getUserExitPrintListFont

public String getUserExitPrintListFont()

Get the override user exit print font for list box.

isPrintWindow

public boolean isPrintWindow(KeyEvent e)

Checks if a key event is a print window keystroke.

isUserExitPrint

public boolean isUserExitPrint(KeyEvent e)

Checks if a key event is a user exit print keystroke.

sendDirectTransaction

public void sendDirectTransaction(Transaction trans)

Send a transaction directly to be processed.

Specified by:

sendDirectTransaction in interface ClientSessionManagerInterface

Parameters:

trans - The transaction to process immediately.

processInboundTransaction

protected boolean processInboundTransaction(int transCode,
                                            Transaction trans)

Processes a transaction.

Parameters:

transCode - The transaction code.

trans - The transaction.

Returns:

true if the transaction is processed somehow, even if "sent directly" to the AWT thread.

processInboundTransactionWithDragLock

protected boolean processInboundTransactionWithDragLock(int transCode,
                                                        Transaction trans)

Processes a transaction.

Parameters:

transCode - The transaction code.

trans - The transaction.

Returns:

true if the transaction is processed somehow, even if "sent directly" to the AWT thread.

callObject

public String callObject(String objectID,
                         String argID,
                         int action,
                         String argString,
                         boolean doModal)
                  throws InterruptedException

Calls an object in the server. For values of the "action" parameter, see the documentation of se.entra.phantom.server.ObjectMessages and the constants OBJACT_*.

The parameter "doModal" can be set to "true" in which case the caller thread is blocked until the object has completed execution in the server (regardless if it is a REXX Macro or REXX Application).

Note that it can be "dangerous" to run modally in e.g. the AWT event thread (painting in windows and components will be blocked), and that if a message box displayed on the client side (due to the REXX function message), it must be removed by the user prior to the blocking to be released.

The "doModal" flag can NOT be set to "true" when processing updates to panels or components from the server, nor when responding to server-induced transactions, because these functions blocks the Client Socket reader thread that is used to receive the modal reply. If "doModal" is "true" and the Socket reader thread is blocked, an "InternalError" exception is thrown.

This method is thread-safe when running modally, so if possible, start a new thread to handle modal replies.

Returns:

null if the object is not found in the server or the action parameter is invalid, otherwise the return string from the object. When "doModal" is "false", null is always returned.

Throws:

InterruptedException - Only when "doModal" is "true" and the blocked thread was interrupted.

InternalError - If the calling thread requests a modal callObject and is currently executing transactions from the Socket reader thread or the AWT event dispatch thread.

See Also:

ObjectMessages

getDocumentURL

public URL getDocumentURL(String doc)

Gets an URL relative or fixed used to display help documents and documents used with showDocument.

Returns:

Document URL or null for error (an error is logged in the server).

getFocusManager

public PFocusManager getFocusManager()

setLock

public void setLock()

Sets the lock state on.

clearLock

public void clearLock()

Clears the lock state.

messageBox

public void messageBox(boolean doReply,
                       int icon,
                       int buttons,
                       String head,
                       String msg)

Displays a message box.

messageBox

public int messageBox(boolean doReply,
                      int icon,
                      int buttons,
                      String head,
                      String msg,
                      boolean doSendToServer)

Displays a message box.

getTopMostPanel

public Component getTopMostPanel()

Gets the top-most panel.

selectTopmostPanel

public Container selectTopmostPanel()

Selects the top-most panel in the top-most session.

Returns:

null when there are not top-most panel, otherwise it's frame.

run

public void run()

Runs transactions in the AWT event thread rather than the "socket reader" thread.

Specified by:

run in interface Runnable

processInboundTransactionAWT

protected boolean processInboundTransactionAWT(int transCode,
                                               Transaction trans)

The processing of a transaction in the AWT thread.

Parameters:

transCode - The transaction code.

trans - The transaction.

Returns:

true if the transaction is processed somehow, even if "sent directly" to the AWT thread.

sendDdeReply

public void sendDdeReply(int replyValue)

Send DDE reply to server.

ddeEvent

public void ddeEvent(Transaction ddeTrans)

Callback method from DdeInterface object, to send an event to a server object.

setNextDialogOwner

public void setNextDialogOwner(Container frameOrDialog)

The next Frame or Dialog parent for a dialog box, this is nulled once it is used and only used by the editor.

getNextDialogOwner

public Container getNextDialogOwner()

Gets the next Frame or Dialog parent for a dialog box, this is nulled once it is used and only used by the editor.

clearNextMessageBoxOwner

public void clearNextMessageBoxOwner()

Clears the next dialog owner for message boxes.

areTooltipsDisplayed

public boolean areTooltipsDisplayed()

Gets the flag indicating tool-tips should or not be displayed on the client (informational tooltips, not e.g. when a listbox cannot display the entire contents).

newRemoteSocket

public RemoteSocket newRemoteSocket(String host,
                                    int port)

Opens a new remote socket on the server.

Parameters:

host - The destination host.

port - The destination port.

getTunnels

public TunnelPort[] getTunnels()

Gets the current tunnels.

Returns:

An array of TunnelPort instances.

createTunnel

public TunnelPort createTunnel(int port,
                               String dest)
                        throws IOException

Creates a socket tunnel from the client to the server on the specified port.

Parameters:

port - The port number on the client and on the server.

dest - The destination host on the server side.

Throws:

IOException - For I/O errors.

closeTunnel

public void closeTunnel(int port)
                 throws IOException

Closes a socket tunnel from the client to the server on the specified port.

Parameters:

port - The port number on the client and on the server.

Throws:

IOException - For I/O errors.