com.goldencode.p2j.main

Class WebDriverHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerCollection

com.goldencode.p2j.main.WebDriverHandler

All Implemented Interfaces:

org.eclipse.jetty.server.Handler, org.eclipse.jetty.server.HandlerContainer, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

EmbeddedWebHandler, VirtualDesktopWebHandler

public abstract class WebDriverHandler
extends org.eclipse.jetty.server.handler.HandlerCollection

Base class for Virtual Desktop and Embedded web handlers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	WebDriverHandler.SpawnerResult Simple container for the spawn result.
protected static class	WebDriverHandler.SsoUsers Simple container for accounts associated with the sso login.
static class	WebDriverHandler.SupportedHttpCode Enum for result codes available to the end-user.
private static class	WebDriverHandler.UiTextKey Keys for translation resources.
private static class	WebDriverHandler.WebSessionListener Listener for client sessions.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.HandlerCollection

org.eclipse.jetty.server.handler.HandlerCollection.Handlers

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	AUTO_LOGIN_DATA Template placeholder for the newly spawned client url.
private java.util.List<java.lang.String>	baseDirWebOverrides The bootstrap config overrides coming from directory.
(package private) static java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	CLIENT_UUID_AUTHBLOB_PAIRS Map of client uuid : authentication blob for sso.
(package private) static java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	CLIENT_UUID_DEVICEID_PAIRS Map of client uuid : device ID.
static java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	CLIENT_UUID_FWD_USERS Map of client uuid : fwd user for sso.
(package private) static java.util.concurrent.ConcurrentMap<java.lang.String,java.util.Map<java.lang.String,java.lang.String[]>>	CLIENT_UUID_LOGIN_PARAMS Map of client uuid : ALL login url param name : values (to be validated and filtered out before accessed by 4GL).
(package private) static java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	CLIENT_UUID_RELATED_SESSION_ID_PAIRS Map of client uuid : related session ID.
(package private) static java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String>	CLIENT_UUID_SESS_DESCR_PAIRS Map of client uuid : session description.
private static java.lang.String	CONTEXT_PATH_LOGOUT The logout page context path.
private static java.lang.String	DEFAULT_OS_USER The default OS user with SSO login.
private static java.lang.String	DEVICE_ID_COOKIE_DIVIDER The divider between the device ID and the signature in the FWD device ID cookie.
private static java.lang.String	DEVICE_ID_COOKIE_NAME The name of the FWD device ID cookie.
private static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	deviceIdSessionIdPairs Collections of all live sessions sorted by the corresponding device ID.
private static DigitalSignature	digitalSignature The signature instance to sign and verify device id cookies.
(package private) static java.util.Map<WebDriverType,WebClientBuilderOptions>	driverOptionsMap Replaces the former WebClientBuilderParameters.cbo
private static java.util.Map<java.lang.String,java.util.regex.Pattern>	expectedLoginParamNameRegex Map of name and validation regex for login request params configured in directory's webClient.
private static java.util.Map<java.lang.String,java.lang.String>	FILE_EXT_MIME_TYPE_PAIRS Map of the supported file ext and their corresponding mime types.
private java.util.List<java.lang.String>	firstWebOverrides The bootstrap config overrides to be applied first.
private static java.lang.String	FORWARDED_HOST_CONFIG Directory config for the host:port when reverse proxy enabled.
private static java.lang.String	FORWARDED_PROTO_CONFIG Directory config for the protocol when reverse proxy enabled.
private java.util.List<java.lang.String>	lastWebOverrides The bootstrap config overrides to be applied last.
private static CentralLogger	LOG Logger.
static boolean	ONE_BROWSER_POLICY Flag to indicate if the One Browser Policy is enabled.
private static boolean	OS_USER_OVERRIDE Indicates the OS user for the SSO login should be overwritten by DEFAULT_OS_USER.
protected static java.lang.String	PAGE_TITLE_LOGIN The login page title.
protected static java.lang.String	PAGE_TITLE_LOGOUT The logout page title.
(package private) static java.lang.String	PKG_RES_DIR The dir name in the custom package where the relevant res reside.
protected static java.lang.String	PKG_ROOT The application's package root, in folder form.
protected static java.lang.String	PLACEHOLDER_HTML_TEMPLATE Template placeholder for the html template.
protected static java.lang.String	PLACEHOLDER_PROXY_PATH Template placeholder for a reverse proxy custom context path.
protected static java.lang.String	PLACEHOLDER_TITLE Template placeholder for page title.
protected static java.util.Map<java.lang.String,java.lang.String>	PLACEHOLDER_VALUE_PAIRS Template placeholder : current value pairs.
private static java.lang.String	PROXY_PATH The reverse proxy custom context path.
protected static boolean	REMOVE_PROXY_PATH_IN_WEB_PAGES Flag to remove the proxy path from login/logout page urls to allow reverse proxy mapping of TARGET_GUI_ROOT and TARGET_CHUI_ROOT directly to the proxy path.
private static int	SECURE_PORT The server's secure port or -1 if this is a remote launch.
private static java.lang.String	SERVER_ALIAS The alias of the server certificate in the certificate key store which will be used to authenticate that this server indeed is on the other side of the secure connection.
private static InitTermListener	SESSION_LISTENER Session initialization / termination listener.
private static java.util.Map<java.lang.String,java.lang.ref.WeakReference<ClientExports>>	sessionIdClientPairs Pairs of session id : ClientExports network interface.
private static java.util.Map<java.lang.String,java.lang.Object>	sessionIdNetIdPairs Pairs of session id (accessible from session handle) : session net id (from security manager).
private static java.lang.String	TARGET_BASE_RES The context for the base web resources (css, favicon, logo)
(package private) static java.lang.String	TARGET_CHUI_LOGOUT The portion of the CHUI client request name (part of the URL).
(package private) static java.lang.String	TARGET_CHUI_ROOT The root portion of the ChUI client request name (part of the URL).
(package private) static java.lang.String	TARGET_EMBEDDED The base path for this handler.
(package private) static java.lang.String	TARGET_GUI_LOGOUT The portion of the GUI client request name (part of the URL).
(package private) static java.lang.String	TARGET_GUI_ROOT The root portion of the GUI client request name (part of the URL).
protected static SessionlessTranslationManager	TRANSLATION_MANAGER Translations manager.

Fields inherited from class org.eclipse.jetty.server.handler.HandlerCollection

_handlers

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
WebDriverHandler(java.lang.String firstOption, java.lang.String lastOption) Package-private constructor.

Method Summary

Modifier and Type	Method and Description
private static java.util.List<java.lang.String>	addThemeToOptions(java.lang.String selectedTheme) Adds the chosen theme from the HTTP request parameters to the spawn options.
private static java.util.List<java.lang.String>	addUrlsToOptions(java.util.List<java.lang.String> options, WebDriverRequestParameters requestParameters, WebDriverType driverType) Adds the urls for login and logout page to list of spawn options.
static java.util.Map<java.lang.String,java.lang.String[]>	filterOutValidLoginParams(java.util.Map<java.lang.String,java.lang.String[]> loginParams) Returns a map of all valid login params according to directory configurations.
private Tuple<java.lang.String,javax.servlet.http.Cookie>	generateDeviceId() Generates a new UUID for a new device ID, signs it with the server certificate and sets it in a cookie.
(package private) static WebDriverRequestParameters	getRequestParameters(org.eclipse.jetty.server.Request base, javax.servlet.http.HttpServletRequest request) Retrieves these parameters: a forwarded host, a forwarded proto and a client IP address if they are provided by http request.
protected java.lang.String	getResPathCurrentDir(java.lang.String fileName) Returns the web context path to the target resource file, transforming the class package into segments of the path.
static java.lang.String	getServerProxyPath(javax.servlet.http.HttpServletRequest request) Returns the proxy path as absolute path if configured in directory, otherwise an empty string.
static java.lang.String	getServerProxyPath(java.lang.String forwardedHost) Returns the proxy path as absolute path if configured in directory, otherwise an empty string.
static ClientExports	getSessionClientInterface(java.lang.String sessionId) Returns the network interface of the client.
static java.lang.Object	getSessionNetId(java.lang.String sessionId) Returns the session net id for the specified session id.
static java.util.List<java.lang.String>	getSessionsByDeviceId(java.lang.String deviceId) Returns a list of session ids for the specified device id.
private Tuple<java.lang.String,javax.servlet.http.Cookie>	getValidDeviceId(javax.servlet.http.Cookie[] requestCookies, java.lang.String user) Searches through all cookies in the request and returns boolean to indicate if a valid device ID cookie is found.
void	handle(java.lang.String target, org.eclipse.jetty.server.Request base, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handle HTTP requests for common resources (css style, favicon and logo image).
protected boolean	handleSessionFork(WebDriverRequestParameters requestParameters, SecurityManager sm, WebDriverType driver, boolean isSso, java.lang.String deviceId, java.util.Map<java.lang.String,java.lang.String> placeholderValuePairs) Handles HTTP requests that allow forking session and direct spawn of a new client.
protected WebDriverHandler.SpawnerResult	handleSsoAutoLogin(WebDriverRequestParameters requestParameters, java.lang.String deviceId, WebDriverType driverType) Handles HTTP requests that allow SSO auto-login and direct spawn of a new client.
protected void	handleStartClientRequest(org.eclipse.jetty.server.Request base, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean isSso, WebDriverType driverType) Handles HTTP requests for spawning a new client.
private java.lang.String	inflateTemplate(java.lang.String line, java.util.Map<java.lang.String,java.lang.String> placeholderValues) Replaces placeholders in the text with the provided values.
protected static boolean	isSsoEnabled() Returns a flag indicating if SSO is enabled.
protected java.lang.String	loadPartial(java.lang.String partialFilename, java.lang.String customPackageDir, java.util.Map<java.lang.String,java.lang.String> placeholderValuePairs) Returns the HTML partial resource as string.
private static WebDriverHandler.SsoUsers	processSsoResult(SsoAuthenticator.Result ssoAuthResult, SecurityManager sm, WebDriverHandler.SpawnerResult result) Processes the successful SSO login result.
(package private) static java.lang.String	resolveForwardedHost(javax.servlet.http.HttpServletRequest request) Returns the resolved forward host.
(package private) void	sendError(javax.servlet.http.HttpServletResponse response, WebDriverHandler.SupportedHttpCode httpCode, java.lang.String spawnError) Sends the error message to the client.
protected void	serveHtml(javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,java.lang.String> requestSpecificTemplateValues, java.lang.String... altPaths) Loads static resources, inflates templates and serves the content.
protected void	serveStatic(javax.servlet.http.HttpServletResponse response, java.lang.String mimeType, java.util.Map<java.lang.String,java.lang.String> placeholderValues, java.lang.String... altPaths) Loads static resource, inflates templates and serves the content.
protected java.lang.String	setDeviceId(WebDriverRequestParameters requestParameters, javax.servlet.http.HttpServletResponse response) Retrieves the FWD device ID cookie and resets the expiration date.
private void	setDeviceIdCookieAttributes(javax.servlet.http.Cookie deviceIdCookie) Sets attributes for the device ID cookie
private void	setResponseSuccess(javax.servlet.http.HttpServletResponse response) Sets status, content type and headers for a successful response.
protected WebDriverHandler.SpawnerResult	spawnWorker(WebDriverRequestParameters requestParameters, WebDriverSpawnParameters spawnParameters) Spawn a client with the given account credentials and UI mode.
private void	writeBinaryResponse(javax.servlet.http.HttpServletResponse response, java.io.InputStream inputStream, java.lang.String path) Reads the input stream a few bytes at a time and serves the content.
private void	writeTextResponse(javax.servlet.http.HttpServletResponse response, java.io.InputStream inputStream, java.lang.String path, java.util.Map<java.lang.String,java.lang.String> placeholderValues) Reads the input stream line by line, replaces placeholders and serves the content.
private void	writeUrlInResponse(java.lang.String remoteUri, java.lang.String storageId, javax.servlet.http.HttpServletResponse response, java.lang.String webClientUuid, javax.servlet.http.Cookie cookie) Returns the url to the main application site (the new web session) as response.

Methods inherited from class org.eclipse.jetty.server.handler.HandlerCollection

addHandler, destroy, expandChildren, getHandlers, newHandlers, prependHandler, removeHandler, setHandlers, updateHandlers

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

doShutdown, expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, doStart, doStop, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpObjects, dumpStdErr, dumpThis, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Field Detail

CLIENT_UUID_FWD_USERS

public static final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> CLIENT_UUID_FWD_USERS

Map of client uuid : fwd user for sso.

ONE_BROWSER_POLICY

public static final boolean ONE_BROWSER_POLICY

Flag to indicate if the One Browser Policy is enabled.

CONTEXT_PATH_LOGOUT

private static final java.lang.String CONTEXT_PATH_LOGOUT

The logout page context path.

See Also:

Constant Field Values

TARGET_GUI_ROOT

static final java.lang.String TARGET_GUI_ROOT

The root portion of the GUI client request name (part of the URL).

TARGET_CHUI_ROOT

static final java.lang.String TARGET_CHUI_ROOT

The root portion of the ChUI client request name (part of the URL).

TARGET_GUI_LOGOUT

static final java.lang.String TARGET_GUI_LOGOUT

The portion of the GUI client request name (part of the URL).

TARGET_CHUI_LOGOUT

static final java.lang.String TARGET_CHUI_LOGOUT

The portion of the CHUI client request name (part of the URL).

TARGET_EMBEDDED

static final java.lang.String TARGET_EMBEDDED

The base path for this handler.

CLIENT_UUID_AUTHBLOB_PAIRS

static final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> CLIENT_UUID_AUTHBLOB_PAIRS

Map of client uuid : authentication blob for sso.

CLIENT_UUID_SESS_DESCR_PAIRS

static final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> CLIENT_UUID_SESS_DESCR_PAIRS

Map of client uuid : session description.

CLIENT_UUID_RELATED_SESSION_ID_PAIRS

static final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> CLIENT_UUID_RELATED_SESSION_ID_PAIRS

Map of client uuid : related session ID.

CLIENT_UUID_DEVICEID_PAIRS

static final java.util.concurrent.ConcurrentMap<java.lang.String,java.lang.String> CLIENT_UUID_DEVICEID_PAIRS

Map of client uuid : device ID.

CLIENT_UUID_LOGIN_PARAMS

static final java.util.concurrent.ConcurrentMap<java.lang.String,java.util.Map<java.lang.String,java.lang.String[]>> CLIENT_UUID_LOGIN_PARAMS

Map of client uuid : ALL login url param name : values (to be validated and filtered out before accessed by 4GL).

driverOptionsMap

static final java.util.Map<WebDriverType,WebClientBuilderOptions> driverOptionsMap

Replaces the former WebClientBuilderParameters.cbo

PLACEHOLDER_VALUE_PAIRS

protected static final java.util.Map<java.lang.String,java.lang.String> PLACEHOLDER_VALUE_PAIRS

Template placeholder : current value pairs. Should not be updated with request specific values.

PLACEHOLDER_TITLE

protected static final java.lang.String PLACEHOLDER_TITLE

Template placeholder for page title.

See Also:

Constant Field Values

AUTO_LOGIN_DATA

protected static final java.lang.String AUTO_LOGIN_DATA

Template placeholder for the newly spawned client url.

See Also:

Constant Field Values

PLACEHOLDER_HTML_TEMPLATE

protected static final java.lang.String PLACEHOLDER_HTML_TEMPLATE

Template placeholder for the html template.

See Also:

Constant Field Values

PLACEHOLDER_PROXY_PATH

protected static final java.lang.String PLACEHOLDER_PROXY_PATH

Template placeholder for a reverse proxy custom context path.

See Also:

Constant Field Values

PKG_ROOT

protected static final java.lang.String PKG_ROOT

The application's package root, in folder form.

PAGE_TITLE_LOGIN

protected static final java.lang.String PAGE_TITLE_LOGIN

The login page title.

PAGE_TITLE_LOGOUT

protected static final java.lang.String PAGE_TITLE_LOGOUT

The logout page title.

REMOVE_PROXY_PATH_IN_WEB_PAGES

protected static final boolean REMOVE_PROXY_PATH_IN_WEB_PAGES

Flag to remove the proxy path from login/logout page urls to allow reverse proxy mapping of TARGET_GUI_ROOT and TARGET_CHUI_ROOT directly to the proxy path. In this case directory webClient configs 'serverProxyPath' and 'guiIdentifier' / 'chuiIdentifier' should be the same.

TRANSLATION_MANAGER

protected static final SessionlessTranslationManager TRANSLATION_MANAGER

Translations manager.

PKG_RES_DIR

static final java.lang.String PKG_RES_DIR

The dir name in the custom package where the relevant res reside.

See Also:

Constant Field Values

PROXY_PATH

private static final java.lang.String PROXY_PATH

The reverse proxy custom context path.

TARGET_BASE_RES

private static final java.lang.String TARGET_BASE_RES

The context for the base web resources (css, favicon, logo)

See Also:

Constant Field Values

FILE_EXT_MIME_TYPE_PAIRS

private static final java.util.Map<java.lang.String,java.lang.String> FILE_EXT_MIME_TYPE_PAIRS

Map of the supported file ext and their corresponding mime types.

FORWARDED_HOST_CONFIG

private static final java.lang.String FORWARDED_HOST_CONFIG

Directory config for the host:port when reverse proxy enabled.

FORWARDED_PROTO_CONFIG

private static final java.lang.String FORWARDED_PROTO_CONFIG

Directory config for the protocol when reverse proxy enabled.

DEVICE_ID_COOKIE_NAME

private static final java.lang.String DEVICE_ID_COOKIE_NAME

The name of the FWD device ID cookie.

See Also:

Constant Field Values

DEVICE_ID_COOKIE_DIVIDER

private static final java.lang.String DEVICE_ID_COOKIE_DIVIDER

The divider between the device ID and the signature in the FWD device ID cookie.

See Also:

Constant Field Values

SESSION_LISTENER

private static final InitTermListener SESSION_LISTENER

Session initialization / termination listener. Kept as static field to prevent GC.

deviceIdSessionIdPairs

private static final java.util.Map<java.lang.String,java.util.List<java.lang.String>> deviceIdSessionIdPairs

Collections of all live sessions sorted by the corresponding device ID.

sessionIdNetIdPairs

private static final java.util.Map<java.lang.String,java.lang.Object> sessionIdNetIdPairs

Pairs of session id (accessible from session handle) : session net id (from security manager).

sessionIdClientPairs

private static final java.util.Map<java.lang.String,java.lang.ref.WeakReference<ClientExports>> sessionIdClientPairs

Pairs of session id : ClientExports network interface.

expectedLoginParamNameRegex

private static final java.util.Map<java.lang.String,java.util.regex.Pattern> expectedLoginParamNameRegex

Map of name and validation regex for login request params configured in directory's webClient.

LOG

private static final CentralLogger LOG

Logger.

SECURE_PORT

private static final int SECURE_PORT

The server's secure port or -1 if this is a remote launch.

SERVER_ALIAS

private static final java.lang.String SERVER_ALIAS

The alias of the server certificate in the certificate key store which will be used to authenticate that this server indeed is on the other side of the secure connection.

OS_USER_OVERRIDE

private static final boolean OS_USER_OVERRIDE

Indicates the OS user for the SSO login should be overwritten by DEFAULT_OS_USER.

DEFAULT_OS_USER

private static final java.lang.String DEFAULT_OS_USER

The default OS user with SSO login.

digitalSignature

private static DigitalSignature digitalSignature

The signature instance to sign and verify device id cookies.

firstWebOverrides

private final java.util.List<java.lang.String> firstWebOverrides

The bootstrap config overrides to be applied first. Lowest priority.

baseDirWebOverrides

private final java.util.List<java.lang.String> baseDirWebOverrides

The bootstrap config overrides coming from directory.

lastWebOverrides

private final java.util.List<java.lang.String> lastWebOverrides

The bootstrap config overrides to be applied last. Highest priority.

Constructor Detail

WebDriverHandler

WebDriverHandler(java.lang.String firstOption,
                 java.lang.String lastOption)

Package-private constructor. Reads web client config overrides and creates an options list.

Parameters:

firstOption - An additional option to be added at the start of the options. Can be overwritten.

lastOption - An additional option to be added at the end of the options. Should not be overwritten.

Method Detail

getSessionsByDeviceId

public static java.util.List<java.lang.String> getSessionsByDeviceId(java.lang.String deviceId)

Returns a list of session ids for the specified device id.

Parameters:

deviceId - The device id.

Returns:

List of session ids for the specified device id.

getSessionNetId

public static java.lang.Object getSessionNetId(java.lang.String sessionId)

Returns the session net id for the specified session id.

Parameters:

sessionId - The session id (as in the session handle).

Returns:

The session net id.

getSessionClientInterface

public static ClientExports getSessionClientInterface(java.lang.String sessionId)

Returns the network interface of the client.

Parameters:

sessionId - The session id (as in the session handle).

Returns:

The network interface of the client.

getServerProxyPath

public static java.lang.String getServerProxyPath(javax.servlet.http.HttpServletRequest request)

Returns the proxy path as absolute path if configured in directory, otherwise an empty string.

Parameters:

request - The HTTP request.

Returns:

See above.

getServerProxyPath

public static java.lang.String getServerProxyPath(java.lang.String forwardedHost)

Returns the proxy path as absolute path if configured in directory, otherwise an empty string.

Parameters:

forwardedHost - The proxy address.

Returns:

See above.

filterOutValidLoginParams

public static java.util.Map<java.lang.String,java.lang.String[]> filterOutValidLoginParams(java.util.Map<java.lang.String,java.lang.String[]> loginParams)

Returns a map of all valid login params according to directory configurations.

Parameters:

loginParams - The map of name : values for the params sent by the login request.

Returns:

See above.

handle

public void handle(java.lang.String target,
                   org.eclipse.jetty.server.Request base,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

Handle HTTP requests for common resources (css style, favicon and logo image).

Specified by:

handle in interface org.eclipse.jetty.server.Handler

Overrides:

handle in class org.eclipse.jetty.server.handler.HandlerCollection

Parameters:

target - The target of the request - either a URI or a name.

base - The HTTP request, Jetty style.

request - The HTTP request.

response - The HTTP response.

handleStartClientRequest

protected void handleStartClientRequest(org.eclipse.jetty.server.Request base,
                                        javax.servlet.http.HttpServletRequest request,
                                        javax.servlet.http.HttpServletResponse response,
                                        boolean isSso,
                                        WebDriverType driverType)

Handles HTTP requests for spawning a new client.

Parameters:

base - The HTTP request, Jetty style.

request - The HTTP request.

response - The HTTP response.

isSso - Flag indicating if SSO is enabled.

driverType - The type of web client - GUI / CHUI / embedded.

setDeviceId

protected java.lang.String setDeviceId(WebDriverRequestParameters requestParameters,
                                       javax.servlet.http.HttpServletResponse response)

Retrieves the FWD device ID cookie and resets the expiration date. If not present, generates a new device ID and adds the cookie to the response. Returns the device ID.

Parameters:

requestParameters - Holds HTTP derived parameters - headers, cookies, form params.

response - The HTTP response.

Returns:

The device ID.

spawnWorker

protected WebDriverHandler.SpawnerResult spawnWorker(WebDriverRequestParameters requestParameters,
                                                     WebDriverSpawnParameters spawnParameters)

Spawn a client with the given account credentials and UI mode.

Parameters:

requestParameters - Holds HTTP derived parameters - headers, cookies, form params.

spawnParameters - Holds additional parameters required for the spawn process.

Returns:

The redirect URI will be populated if successful, otherwise the URI will be null and the return code will describe the error.

handleSsoAutoLogin

protected WebDriverHandler.SpawnerResult handleSsoAutoLogin(WebDriverRequestParameters requestParameters,
                                                            java.lang.String deviceId,
                                                            WebDriverType driverType)

Handles HTTP requests that allow SSO auto-login and direct spawn of a new client.

Parameters:

requestParameters - Holds HTTP derived parameters - headers, cookies, form params.

deviceId - The device ID.

driverType - The type of web client - GUI / CHUI / embedded.

Returns:

The result of the spawn attempt.

handleSessionFork

protected boolean handleSessionFork(WebDriverRequestParameters requestParameters,
                                    SecurityManager sm,
                                    WebDriverType driver,
                                    boolean isSso,
                                    java.lang.String deviceId,
                                    java.util.Map<java.lang.String,java.lang.String> placeholderValuePairs)

Handles HTTP requests that allow forking session and direct spawn of a new client.

Parameters:

requestParameters - Holds HTTP derived parameters - headers, cookies, form params.

sm - SecurityManager

driver - The UI driver type

isSso - Flag indicating if SSO is enabled

deviceId - The device ID

placeholderValuePairs - Map with template placeholder : value pairs

Returns:

The result of the spawn attempt.

serveHtml

protected void serveHtml(javax.servlet.http.HttpServletResponse response,
                         java.util.Map<java.lang.String,java.lang.String> requestSpecificTemplateValues,
                         java.lang.String... altPaths)

Loads static resources, inflates templates and serves the content. If the resource is not found in any of the alternative paths provided, or if IOException occurs, the status is set to 404, otherwise 200.

Parameters:

response - The HTTP response.

requestSpecificTemplateValues - The template placeholder values.

altPaths - The target resource paths within the classpath.

serveStatic

protected void serveStatic(javax.servlet.http.HttpServletResponse response,
                           java.lang.String mimeType,
                           java.util.Map<java.lang.String,java.lang.String> placeholderValues,
                           java.lang.String... altPaths)

Loads static resource, inflates templates and serves the content. If the resource is not found in any of the alternative paths provided, or if IOException occurs, the status is set to 404, otherwise 200.

Parameters:

response - The HTTP response.

mimeType - The mime type.

placeholderValues - The template placeholder values.

altPaths - The target resource paths within the classpath.

writeTextResponse

private void writeTextResponse(javax.servlet.http.HttpServletResponse response,
                               java.io.InputStream inputStream,
                               java.lang.String path,
                               java.util.Map<java.lang.String,java.lang.String> placeholderValues)

Reads the input stream line by line, replaces placeholders and serves the content. If IOException occurs, the status is set to 404, otherwise 200.

Parameters:

response - The HTTP response.

inputStream - The text file input stream.

path - The text resource file path.

placeholderValues - The template placeholder values.

writeBinaryResponse

private void writeBinaryResponse(javax.servlet.http.HttpServletResponse response,
                                 java.io.InputStream inputStream,
                                 java.lang.String path)

Reads the input stream a few bytes at a time and serves the content. If IOException occurs, the status is set to 404, otherwise 200.

Parameters:

response - The HTTP response.

inputStream - The text file input stream.

path - The text resource file path.

loadPartial

protected java.lang.String loadPartial(java.lang.String partialFilename,
                                       java.lang.String customPackageDir,
                                       java.util.Map<java.lang.String,java.lang.String> placeholderValuePairs)

Returns the HTML partial resource as string. First tries to find the resource under the custom package dir, then looks for it under the current package.

Parameters:

partialFilename - The name of the file

customPackageDir - The dir in the custom package

Returns:

String representation of the HTML partial resource

getResPathCurrentDir

protected java.lang.String getResPathCurrentDir(java.lang.String fileName)

Returns the web context path to the target resource file, transforming the class package into segments of the path.

Parameters:

fileName - The name of the file

Returns:

String representation of the client's IP address

inflateTemplate

private java.lang.String inflateTemplate(java.lang.String line,
                                         java.util.Map<java.lang.String,java.lang.String> placeholderValues)

Replaces placeholders in the text with the provided values.

Parameters:

line - The text to be updated.

placeholderValues - The map with placeholder name : value pairs.

Returns:

The text with replaced placeholders.

processSsoResult

private static WebDriverHandler.SsoUsers processSsoResult(SsoAuthenticator.Result ssoAuthResult,
                                                          SecurityManager sm,
                                                          WebDriverHandler.SpawnerResult result)

Processes the successful SSO login result. Finds the OS user associated with the FWD account. Sets the cookies to the spawner result.

Parameters:

ssoAuthResult - The result of the SSO authentication.

sm - The SecurityManager.

result - The result from the new client spawn.

Returns:

The container for accounts associated with the sso login.

getRequestParameters

static WebDriverRequestParameters getRequestParameters(org.eclipse.jetty.server.Request base,
                                                       javax.servlet.http.HttpServletRequest request)

Retrieves these parameters: a forwarded host, a forwarded proto and a client IP address if they are provided by http request.

Parameters:

base - The HTTP request. Jetty style.

request - The HTTP servlet request

Returns:

The parameters array is filled that the first parameters[0] holds the forwarded host of "X-Forwarded-Host" HTTP header, the second parameters[1] holds the used forwarded protocol that is provided by "X-Forwarded-Proto" value and the third parameters[2] holds the client IP address.

resolveForwardedHost

static java.lang.String resolveForwardedHost(javax.servlet.http.HttpServletRequest request)

Returns the resolved forward host.

Parameters:

request - The HTTP servlet request

Returns:

See above.

setResponseSuccess

private void setResponseSuccess(javax.servlet.http.HttpServletResponse response)

Sets status, content type and headers for a successful response.

Parameters:

response - The HTTP response.

sendError

void sendError(javax.servlet.http.HttpServletResponse response,
               WebDriverHandler.SupportedHttpCode httpCode,
               java.lang.String spawnError)

Sends the error message to the client.

Parameters:

httpCode - The http code to return to the client.

response - The http response.

writeUrlInResponse

private void writeUrlInResponse(java.lang.String remoteUri,
                                java.lang.String storageId,
                                javax.servlet.http.HttpServletResponse response,
                                java.lang.String webClientUuid,
                                javax.servlet.http.Cookie cookie)

Returns the url to the main application site (the new web session) as response.

Parameters:

remoteUri - The redirect url provided with the authorization parameter.

storageId - The storage ID.

response - The HTTP response.

webClientUuid - The just spawned web client uuid.

cookie - The cookie to be attached to the response.

addThemeToOptions

private static java.util.List<java.lang.String> addThemeToOptions(java.lang.String selectedTheme)

Adds the chosen theme from the HTTP request parameters to the spawn options. If a required theme is configured in directory, the theme selected in the UI (sent via HTTP request) is discarded.

Parameters:

selectedTheme - The theme from the HTTP request parameters.

Returns:

A modifiable list of all base options + the selected theme.

addUrlsToOptions

private static java.util.List<java.lang.String> addUrlsToOptions(java.util.List<java.lang.String> options,
                                                                 WebDriverRequestParameters requestParameters,
                                                                 WebDriverType driverType)

Adds the urls for login and logout page to list of spawn options.

Parameters:

options - The current client options.

requestParameters - The web request details fetched from the servlet request.

driverType - The type of web client - GUI / CHUI / embedded.

Returns:

A modifiable list of all base options + the login and logout urls.

isSsoEnabled

protected static boolean isSsoEnabled()

Returns a flag indicating if SSO is enabled.

Returns:

true if SSO enabled, false otherwise.

getValidDeviceId

private Tuple<java.lang.String,javax.servlet.http.Cookie> getValidDeviceId(javax.servlet.http.Cookie[] requestCookies,
                                                                           java.lang.String user)

Searches through all cookies in the request and returns boolean to indicate if a valid device ID cookie is found.

Parameters:

requestCookies - Array of all cookies in the request.

user - The name of the user trying to log in.

Returns:

Tuple with the device ID and the FWD device ID cookie.

generateDeviceId

private Tuple<java.lang.String,javax.servlet.http.Cookie> generateDeviceId()

Generates a new UUID for a new device ID, signs it with the server certificate and sets it in a cookie.

Returns:

Tuple with the device ID and the FWD device ID cookie.

setDeviceIdCookieAttributes

private void setDeviceIdCookieAttributes(javax.servlet.http.Cookie deviceIdCookie)

Sets attributes for the device ID cookie

Parameters:

deviceIdCookie - The device id cookie.