se.entra.phantom.server.http

Class HtmlApplication

java.lang.Object

se.entra.phantom.server.ClientCommunicationAdapter

se.entra.phantom.server.http.HtmlApplication

All Implemented Interfaces:

NetPhantomConstants, ClientCommunicationListener, ClientWorker.ClientWorkerInterface, WebApplicationInterface, WorkerCallbackInterface

public class HtmlApplication
extends ClientCommunicationAdapter
implements ClientWorker.ClientWorkerInterface, WebApplicationInterface, NetPhantomConstants, WorkerCallbackInterface

The class that runs a NetPhantom application.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROCESS_FORMSUBMIT Call submit button.
static int	PROCESS_FORMUPDATE Update form data (controls).
static int	PROCESS_NONE No state or state not activated.
static int	PROCESS_WAITSTABLE Wait for stable host/panel situation before return of a html resource.

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

Constructor and Description
HtmlApplication()

Method Summary

Modifier and Type	Method and Description
String	convertHtmlFileName(String htmlFile) Convert HTML file name for frames.
void	createNewSession(HttpSession httpSession) Returns an error document with the URI to request.
void	createNewSession(HttpSession httpSession, String pgmParams, GlobalVariable globVars) Returns an error document with the URI to request.
String	getHtmlName(String hashCode) Get HTML file name.
HtmlResource	getHtmlResource(HttpSession httpSession, String htmlFile) Get HTML Resource.
VirtualMessageBox	getMessageBox() Access method for current messagebox.
String	getPanelHtmlName() Access method for HTML current panel name.
String	getResourceName() Access method for resource name.
boolean	isClientTerminalDisplayed(ClientSession clientSession) Checks if the client is displaying the terminal window.
void	mainThreadCreateNewSession(HttpSession httpSession, ClientSession cs) Returns an error document with the URI to request.
HtmlResource	mainThreadProcessAction(HttpSession httpSession, String uriParams, String linkData) This method should return an HtmlResourceData instance with the document that should be sent to the client.
void	onClientChange(ClientSession clientSession) Notifies of a host change.
void	onClientDispose(ClientSession clientSession) Notifies of a client session disposal.
void	onClientInactivity(ClientSession clientSession) Client inactive.
void	onDisplayTerminal(ClientSession clientSession) Display terminal.
boolean	onExitApplication(ClientSession clientSession) Application exit.
void	onHostChange(ClientSession clientSession) Notifies of a host change.
void	onHostSessionFailure(ClientSession clientSession, String description) Host failure.
void	onMessageBox(VirtualMessageBox vmb) Message box event, set messagebox as current panel and notify waiting object.
void	onRemoveTerminal(ClientSession clientSession) Terminal screen removed, Should not happen because we do dispose when onDisplayTerminal is called.
void	onSoundAlarm(ClientSession clientSession) Sound alarm on the client.
HtmlResource	processAction(HttpSession httpSession, String uriParams, String linkData) This method should return an HtmlResourceData instance with the document that should be sent to the client.
Object	processCallback(Object parameter) Callback method from worker.
void	processWorkerEvent(ClientSessionInterface clientSession) Main callback method to handle Http client formdata update.
void	setFrameData(String framePanelConnection, String startupFile) Set frame and main file names.
void	setFrameData(String framePanelConnection, String startupFile, String emptyFile) Set frame and main file names.

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_NONE

public static final int PROCESS_NONE

No state or state not activated.

See Also:

Constant Field Values

PROCESS_FORMUPDATE

public static final int PROCESS_FORMUPDATE

Update form data (controls).

See Also:

Constant Field Values

PROCESS_FORMSUBMIT

public static final int PROCESS_FORMSUBMIT

Call submit button.

See Also:

Constant Field Values

PROCESS_WAITSTABLE

public static final int PROCESS_WAITSTABLE

Wait for stable host/panel situation before return of a html resource.

See Also:

Constant Field Values

Constructor Detail

HtmlApplication

public HtmlApplication()

Method Detail

processAction

public HtmlResource processAction(HttpSession httpSession,
                                  String uriParams,
                                  String linkData)
                           throws IOException

This method should return an HtmlResourceData instance with the document that should be sent to the client.

The current directory of the CGI for the client agent is defined in the HttpSession class instance.

Throws:

IOException - for IO errors.

createNewSession

public void createNewSession(HttpSession httpSession)
                      throws IOException

Returns an error document with the URI to request. Prior to returning, the session is saved for further processing.

This method posts a HTMLAPPLICATION event to the main thread that will callback the mainThreadCreateNewSession method. The return value is processed as a modal return code and could be of type Throwable.

Throws:

IOException - If the new client session cannot be created.

createNewSession

public void createNewSession(HttpSession httpSession,
                             String pgmParams,
                             GlobalVariable globVars)
                      throws IOException

Returns an error document with the URI to request. Prior to returning, the session is saved for further processing.

This method posts a HTMLAPPLICATION event to the main thread that will callback the mainThreadCreateNewSession method. The return value is processed as a modal return code and could be of type Throwable.

Throws:

IOException - If the new client session cannot be created.

processCallback

public Object processCallback(Object parameter)

Callback method from worker.

Specified by:

processCallback in interface WorkerCallbackInterface

Returns:

Object The resulting object (eventually an Exception) that will be set as modal return value.

mainThreadProcessAction

public HtmlResource mainThreadProcessAction(HttpSession httpSession,
                                            String uriParams,
                                            String linkData)
                                     throws IOException

This method should return an HtmlResourceData instance with the document that should be sent to the client.

The current directory of the CGI for the client agent is defined in the HttpSession class instance.

Throws:

IOException - for IO errors.

mainThreadCreateNewSession

public void mainThreadCreateNewSession(HttpSession httpSession,
                                       ClientSession cs)
                                throws IOException

Returns an error document with the URI to request. Prior to returning, the session is saved for further processing.

Throws:

IOException

getHtmlName

public String getHtmlName(String hashCode)

Get HTML file name.

convertHtmlFileName

public String convertHtmlFileName(String htmlFile)

Convert HTML file name for frames.

getHtmlResource

public HtmlResource getHtmlResource(HttpSession httpSession,
                                    String htmlFile)
                             throws IOException

Get HTML Resource.

Throws:

IOException

processWorkerEvent

public void processWorkerEvent(ClientSessionInterface clientSession)

Main callback method to handle Http client formdata update. Because we only get one shot to send reply data to the client browser, we need to make sure that all updates are finished. Therefore, the formdata update is made in three steps. 1. Update the form data except the submit button. 2. Call the submit pushbutton/menuitem. 3. Wait until panel and host is stable. Between each step we wait for all client and host events to finish. This is done by sending a Http event to ClientWorker that is sent back to this method after the client event and host event are processed. The steps (states) is handled with an object variable processState.

Specified by:

processWorkerEvent in interface ClientWorker.ClientWorkerInterface

onHostChange

public void onHostChange(ClientSession clientSession)

Notifies of a host change.

Specified by:

onHostChange in interface ClientCommunicationListener

Overrides:

onHostChange in class ClientCommunicationAdapter

onClientChange

public void onClientChange(ClientSession clientSession)

Notifies of a host change.

Specified by:

onClientChange in interface ClientCommunicationListener

Overrides:

onClientChange in class ClientCommunicationAdapter

onHostSessionFailure

public void onHostSessionFailure(ClientSession clientSession,
                                 String description)

Host failure.

Specified by:

onHostSessionFailure in interface ClientCommunicationListener

Overrides:

onHostSessionFailure in class ClientCommunicationAdapter

onDisplayTerminal

public void onDisplayTerminal(ClientSession clientSession)

Display terminal.

Specified by:

onDisplayTerminal in interface ClientCommunicationListener

Overrides:

onDisplayTerminal in class ClientCommunicationAdapter

onExitApplication

public boolean onExitApplication(ClientSession clientSession)

Application exit.

Specified by:

onExitApplication in interface ClientCommunicationListener

Overrides:

onExitApplication in class ClientCommunicationAdapter

Returns:

true to allow exit of application.

onClientDispose

public void onClientDispose(ClientSession clientSession)

Notifies of a client session disposal. This dispose may be induced by the system, an administrator or the implementor of this interface.

Specified by:

onClientDispose in interface ClientCommunicationListener

Overrides:

onClientDispose in class ClientCommunicationAdapter

onClientInactivity

public void onClientInactivity(ClientSession clientSession)

Client inactive.

Specified by:

onClientInactivity in interface ClientCommunicationListener

Overrides:

onClientInactivity in class ClientCommunicationAdapter

onRemoveTerminal

public void onRemoveTerminal(ClientSession clientSession)

Terminal screen removed, Should not happen because we do dispose when onDisplayTerminal is called.

Specified by:

onRemoveTerminal in interface ClientCommunicationListener

Overrides:

onRemoveTerminal in class ClientCommunicationAdapter

isClientTerminalDisplayed

public boolean isClientTerminalDisplayed(ClientSession clientSession)

Checks if the client is displaying the terminal window.

Specified by:

isClientTerminalDisplayed in interface ClientCommunicationListener

Overrides:

isClientTerminalDisplayed in class ClientCommunicationAdapter

Returns:

the visibility state.

onSoundAlarm

public void onSoundAlarm(ClientSession clientSession)

Sound alarm on the client.

Specified by:

onSoundAlarm in interface ClientCommunicationListener

Overrides:

onSoundAlarm in class ClientCommunicationAdapter

onMessageBox

public void onMessageBox(VirtualMessageBox vmb)

Message box event, set messagebox as current panel and notify waiting object.

getMessageBox

public VirtualMessageBox getMessageBox()

Access method for current messagebox.

Specified by:

getMessageBox in interface WebApplicationInterface

getPanelHtmlName

public String getPanelHtmlName()

Access method for HTML current panel name.

setFrameData

public void setFrameData(String framePanelConnection,
                         String startupFile)

Set frame and main file names.

Specified by:

setFrameData in interface WebApplicationInterface

setFrameData

public void setFrameData(String framePanelConnection,
                         String startupFile,
                         String emptyFile)

Set frame and main file names.

Specified by:

setFrameData in interface WebApplicationInterface

getResourceName

public String getResourceName()

Access method for resource name.