com.goldencode.p2j.ui.client.chui.driver.web

Class ChuiWebDriver

java.lang.Object

com.goldencode.p2j.ui.client.driver.AbstractDriver<BasePrimitives,ChuiOutputManager>

com.goldencode.p2j.ui.client.chui.driver.AbstractChuiDriver

com.goldencode.p2j.ui.client.chui.driver.web.ChuiWebDriver

All Implemented Interfaces:

ScreenDriver<ChuiOutputManager>, ScreenWebDriver, EmbeddedWebServer

public class ChuiWebDriver
extends AbstractChuiDriver
implements EmbeddedWebServer, ScreenWebDriver

ChUI driver using WebSockets to communicate with a very thin javascript client hosted in a browser. This class creates and uses an embedded web server to accomplish this.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ChuiWebDriver.VT100WebEmulator Web-specific implementation of the VT100 emulator child process.
private class	ChuiWebDriver.VT100WebRenderer Swing-specific implementation of the VT100 emulator renderer.

Nested classes/interfaces inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver

ScreenDriver.UriPathAnchor

Field Summary

Fields

Modifier and Type	Field and Description
private BootstrapConfig	config Configuration.
private java.util.Set<java.lang.String>	langCache Language Ids cache
private LocalStorageAccessor	localStorageAccessor Accessor for localStorage
private static CentralLogger	LOG Logger.
private static java.lang.String	MAIN_TARGET Main page root target.
static java.lang.String	NAME Driver name.
private ChuiWebSimulator	simulator ChUI simulator.
private StorageMessagingWebSocket	websock Web-Socket which provides protocol for communication with the browser.
private EmbeddedWebServerImpl	websrv Delgated implementation for the embedded web server.
private static java.lang.String	WELCOME_PAGE Welcome page.

Fields inherited from class com.goldencode.p2j.ui.client.driver.AbstractDriver

BEEP_FILE_PATH, direct, factory

Constructor Summary

Constructors

Constructor and Description
ChuiWebDriver(BootstrapConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
void	beep() Emit a sound beep on the terminal.
void	clear() Clear screen.
void	clientReady() Notify the driver that the client is ready.
boolean	findAnyIdInChannel(java.lang.String channelName, java.util.List<java.lang.String> channelIds) Searches for the specified channel instances and returns true if any found, false otherwise.
BrowserDetails	getBrowserDetails() Returns the browser details for web drivers.
ChildProcessFactory	getChildProcessFactory() Get driver-specific child process factory.
KeyValueStorage	getLocalStorageAccessor(java.lang.String storageId, java.lang.String fwdUser) Returns accessor for localStorage for web drivers.
java.lang.String	getName() Get the driver name.
java.lang.String	getServerURI() Get the embedded web server's URI.
private java.lang.String	getWelcomePageUrl(java.lang.String pageContext, java.lang.String pageFile) Build the name of the main page as a resource locator string.
void	init() Initialize driver.
boolean	isWeb() All web-based drivers return true.
boolean	pingBroadcastChannel(java.lang.String channelName, java.lang.String targetChannelId) Returns if the target broadcast channel responds with pong.
boolean	pingOnWebSocket() Check if the WebSocket connection is alive.
KeyCode	readKey() Read single keystroke from keyboard.
void	registerBroadcastChannel(java.lang.String channelName, java.lang.String channelId) Opens a broadcast channel in the client's front-end.
void	resetMode() Reset current screen mode.
void	resume() Resume normal driver operation.
OsPassChangeInput	retryPassChangeOnError(java.lang.String osUserName, java.lang.String errMsg) Shows an error message in the OS pass change process.
void	setCurrentLanguage(java.lang.String language) Set new current session language for the client.
boolean	setCursorStatus(boolean on) Set cursor status (ON/OFF).
OsPassChangeInput	showChangePasswordDialog(java.lang.String osUserName, boolean isModal) Shows a dialog to allow the change of the OS account password.
void	showSuccessfulPassChange() Shows that the OS pass has been changed successfully on the front-end and hide the dialog.
void	shutdown() Perform driver shutdown.
void	shutdownServer() Shutdown the embedded web server.
java.lang.String	startupServer(ServerKeyStore keyStore, BootstrapConfig config, java.lang.String host, int port) Startup the embedded server using the server's key store to build the web server SSL context.
void	suspend() Suspend all screen I/O operations.
void	waitInitialization() Wait for the page to notify that it has fully initialized its JS code.

Methods inherited from class com.goldencode.p2j.ui.client.chui.driver.AbstractChuiDriver

captureMouseEvents, convertToOptions, createOutputManager, handleMouseEvent, updateClientMetrics

Methods inherited from class com.goldencode.p2j.ui.client.driver.AbstractDriver

getFactory, getHostByName, getHostName, getPrimitives, getWindowSystem, inBackgroundMode, inBatchMode, isChui, playBeep, setBackgroundMode, setBatchMode, setTerminalType, terminalType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.driver.web.EmbeddedWebServer

addHandler, removeHandler

Methods inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver

chooseFiles, deregisterWidget, isEmbeddedClient, lockMousePointer, openMimeResource, openMimeResource, propagate, resume, setControl, suspend, widgetStateChanged

Field Detail

NAME

public static final java.lang.String NAME

Driver name.

See Also:

Constant Field Values

LOG

private static final CentralLogger LOG

Logger.

MAIN_TARGET

private static final java.lang.String MAIN_TARGET

Main page root target.

See Also:

Constant Field Values

WELCOME_PAGE

private static final java.lang.String WELCOME_PAGE

Welcome page.

See Also:

Constant Field Values

config

private BootstrapConfig config

Configuration.

simulator

private ChuiWebSimulator simulator

ChUI simulator.

websrv

private EmbeddedWebServerImpl websrv

Delgated implementation for the embedded web server.

langCache

private java.util.Set<java.lang.String> langCache

Language Ids cache

localStorageAccessor

private LocalStorageAccessor localStorageAccessor

Accessor for localStorage

websock

private StorageMessagingWebSocket websock

Web-Socket which provides protocol for communication with the browser.

Constructor Detail

ChuiWebDriver

public ChuiWebDriver(BootstrapConfig config)

Constructor.

Parameters:

config - The BootstrapConfig configuration.

Method Detail

getName

public java.lang.String getName()

Get the driver name.

Specified by:

getName in interface ScreenDriver<ChuiOutputManager>

Returns:

See above.

init

public void init()

Initialize driver.

Specified by:

init in interface ScreenDriver<ChuiOutputManager>

Overrides:

init in class AbstractDriver<BasePrimitives,ChuiOutputManager>

getLocalStorageAccessor

public KeyValueStorage getLocalStorageAccessor(java.lang.String storageId,
                                               java.lang.String fwdUser)

Returns accessor for localStorage for web drivers.

Specified by:

getLocalStorageAccessor in interface ScreenWebDriver

Parameters:

storageId - Unique id for the storage.

fwdUser - The FWD user name.

Returns:

KeyValueStorage instance.

getBrowserDetails

public BrowserDetails getBrowserDetails()

Returns the browser details for web drivers.

Specified by:

getBrowserDetails in interface ScreenWebDriver

Returns:

See above.

showChangePasswordDialog

public OsPassChangeInput showChangePasswordDialog(java.lang.String osUserName,
                                                  boolean isModal)

Shows a dialog to allow the change of the OS account password. If the password is expired, the dialog is modal and can't be dismissed.

Specified by:

showChangePasswordDialog in interface ScreenWebDriver

Parameters:

osUserName - The OS account name.

isModal - Flag to indicate if the dialog should be modal (non-dismissible).

Returns:

The OS account pass change input.

showSuccessfulPassChange

public void showSuccessfulPassChange()

Shows that the OS pass has been changed successfully on the front-end and hide the dialog.

Specified by:

showSuccessfulPassChange in interface ScreenWebDriver

retryPassChangeOnError

public OsPassChangeInput retryPassChangeOnError(java.lang.String osUserName,
                                                java.lang.String errMsg)

Shows an error message in the OS pass change process.

Specified by:

retryPassChangeOnError in interface ScreenWebDriver

Parameters:

osUserName - The OS account name.

errMsg - The error message.

Returns:

The OS account pass change input.

registerBroadcastChannel

public void registerBroadcastChannel(java.lang.String channelName,
                                     java.lang.String channelId)

Opens a broadcast channel in the client's front-end.

Specified by:

registerBroadcastChannel in interface ScreenWebDriver

Parameters:

channelName - The name of the channel. The same for all instances of the app. Usually package root.

channelId - The ID of the channel. Unique for this instance of the app. Usually session ID.

pingBroadcastChannel

public boolean pingBroadcastChannel(java.lang.String channelName,
                                    java.lang.String targetChannelId)

Returns if the target broadcast channel responds with pong.

Specified by:

pingBroadcastChannel in interface ScreenWebDriver

Parameters:

channelName - The name of the channel. The same for all instances of the app. Usually package root.

targetChannelId - The id of the target channel. Unique for this instance of the app. Usually session ID.

Returns:

true if the target broadcast channel responds with pong, false otherwise.

findAnyIdInChannel

public boolean findAnyIdInChannel(java.lang.String channelName,
                                  java.util.List<java.lang.String> channelIds)

Searches for the specified channel instances and returns true if any found, false otherwise.

Specified by:

findAnyIdInChannel in interface ScreenWebDriver

Parameters:

channelName - The broadcast channel name.

channelIds - A list of channel ids to check for.

Returns:

true if any of the channel instances found, false otherwise.

pingOnWebSocket

public boolean pingOnWebSocket()

Check if the WebSocket connection is alive.

Specified by:

pingOnWebSocket in interface ScreenWebDriver

Returns:

true if the websocket connection is alive, false otherwise.

beep

public void beep()

Emit a sound beep on the terminal.

Specified by:

beep in interface ScreenDriver<ChuiOutputManager>

clear

public void clear()

Clear screen.

This method should clear the screen and perform necessary flushing of the system-specific buffers if necessary. Users of this method assume that actual screen appearance as it is visible to the user is properly changed upon exit from this method.

Specified by:

clear in interface ScreenDriver<ChuiOutputManager>

getChildProcessFactory

public ChildProcessFactory getChildProcessFactory()

Get driver-specific child process factory.

Specified by:

getChildProcessFactory in interface ScreenDriver<ChuiOutputManager>

Returns:

The reference to the factory.

readKey

public KeyCode readKey()

Read single keystroke from keyboard. Returned code should be either proper Progress 4GL/P2J key code or -1 if environment-specific input cannot be properly translated.

Specified by:

readKey in interface ScreenDriver<ChuiOutputManager>

Returns:

key code or null if no keys were pressed since last call.

resetMode

public void resetMode()

Reset current screen mode.

Upon exit from this method P2J assumes that screen is in correct state and can be used for interaction with the user.

Specified by:

resetMode in interface ScreenDriver<ChuiOutputManager>

resume

public void resume()

Resume normal driver operation. If implementation is terminal-based, they terminal should be acquired again and driver should be ready to perform regular screen I/O operations.

Specified by:

resume in interface ScreenDriver<ChuiOutputManager>

suspend

public void suspend()

Suspend all screen I/O operations. If implementation is terminal-based, then terminal should be released to allow other application executed from P2J access terminal.

Specified by:

suspend in interface ScreenDriver<ChuiOutputManager>

setCursorStatus

public boolean setCursorStatus(boolean on)
                        throws java.lang.IllegalStateException

Set cursor status (ON/OFF).

The implementation of this method should show/hide actual screen cursor visible to user. Remaining code assumes that actual cursor status visible to user is properly changed upon exit from this method.

Specified by:

setCursorStatus in interface ScreenDriver<ChuiOutputManager>

Overrides:

setCursorStatus in class AbstractChuiDriver

Parameters:

on - true - show cursor, false - hide cursor.

Returns:

true if operation was successful.

Throws:

java.lang.IllegalStateException

shutdown

public void shutdown()

Perform driver shutdown.

Specified by:

shutdown in interface ScreenDriver<ChuiOutputManager>

Overrides:

shutdown in class AbstractDriver<BasePrimitives,ChuiOutputManager>

startupServer

public java.lang.String startupServer(ServerKeyStore keyStore,
                                      BootstrapConfig config,
                                      java.lang.String host,
                                      int port)

Startup the embedded server using the server's key store to build the web server SSL context.

There are two page handlers. One is for the root ("/") target and the other is for the index ("/index.html") target. Both load the same page index.html.

When the user is first redirected the URL is https://server:port/ and the target is "/". The index.html page is loaded for this target.

After redirection and the main page is loaded, the URL in the browser address bar will become https://server:port/index.html and the corresponding target is now "/index.html".

When the user reloads the main page within the browser environment the "/index.html" target is sent to the web server and the same main page index.html is loaded.

Specified by:

startupServer in interface EmbeddedWebServer

Parameters:

keyStore - The exported server KeyStore.

config - Client configuration.

port - An explicit port to start the web server or 0 to let the OS assign one.

host - An explicit host to start the web server or null to use the server's host.

Returns:

The embedded web server's URI.

shutdownServer

public void shutdownServer()

Shutdown the embedded web server.

Specified by:

shutdownServer in interface EmbeddedWebServer

getServerURI

public java.lang.String getServerURI()

Get the embedded web server's URI.

Specified by:

getServerURI in interface EmbeddedWebServer

Returns:

A string representing the server's URI.

waitInitialization

public void waitInitialization()

Wait for the page to notify that it has fully initialized its JS code.

Specified by:

waitInitialization in interface EmbeddedWebServer

clientReady

public void clientReady()

Notify the driver that the client is ready.

Specified by:

clientReady in interface ScreenDriver<ChuiOutputManager>

isWeb

public boolean isWeb()

All web-based drivers return true.

Specified by:

isWeb in interface ScreenDriver<ChuiOutputManager>

Returns:

see above.

setCurrentLanguage

public void setCurrentLanguage(java.lang.String language)

Set new current session language for the client.

Specified by:

setCurrentLanguage in interface ScreenDriver<ChuiOutputManager>

Specified by:

setCurrentLanguage in interface ScreenWebDriver

Parameters:

language - The language identifier

getWelcomePageUrl

private java.lang.String getWelcomePageUrl(java.lang.String pageContext,
                                           java.lang.String pageFile)

Build the name of the main page as a resource locator string.

Parameters:

pageContext - Page context root.

pageFile - Main page HTML file.

Returns:

Resource name for the main page.