com.goldencode.p2j.ui.client.driver

Interface ScreenWebDriver

All Known Implementing Classes:

ChuiWebDriver, GuiWebDriver

public interface ScreenWebDriver

Common interface for all web screen drivers.

Method Summary

Modifier and Type	Method and Description
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.
KeyValueStorage	getLocalStorageAccessor(java.lang.String storageId, java.lang.String fwdUser) Returns accessor for localStorage for web drivers, null for other drivers.
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.
void	registerBroadcastChannel(java.lang.String channelName, java.lang.String channelId) Opens a broadcast channel in the client's front-end.
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.
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.

Method Detail

setCurrentLanguage

void setCurrentLanguage(java.lang.String language)

Set new current session language for the client.

Parameters:

language - The language identifier

getLocalStorageAccessor

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

Returns accessor for localStorage for web drivers, null for other drivers.

Parameters:

storageId - Unique id for the storage.

fwdUser - The FWD user name.

Returns:

KeyValueStorage instance.

registerBroadcastChannel

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

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

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

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

Returns if the target broadcast channel responds with pong.

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

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.

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

boolean pingOnWebSocket()

Check if the WebSocket connection is alive.

Returns:

true if the websocket connection is alive, false otherwise.

getBrowserDetails

BrowserDetails getBrowserDetails()

Returns the browser details.

Returns:

See above.

showChangePasswordDialog

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.

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

void showSuccessfulPassChange()

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

retryPassChangeOnError

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

Shows an error message in the OS pass change process.

Parameters:

osUserName - The OS account name.

errMsg - The error message.

Returns:

The OS account pass change input.