com.goldencode.p2j.main

Class WebDriverSpawnParameters

java.lang.Object

com.goldencode.p2j.main.WebDriverSpawnParameters

class WebDriverSpawnParameters
extends java.lang.Object

The container for web spawn parameters.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	deviceId Device ID
private WebDriverType	driverType The web driver type: gui, chui, embedded.
private boolean	isSessionFork Flag to indicate if this is session fork attempt.
private java.util.List<java.lang.String>	runtimeWebOptions List of caller-specified options to be passed on the client command line or null if no values are specified.
private SessionForkManager.ForkedSessionConfigs	sessionForkParams Params for a new forked session
private boolean	sso Flag to indicate if the spawning process uses SSO authentication.
private SsoAuthenticator.Result	ssoAuthResult The result of SSO authentication.

Constructor Summary

Constructors

Constructor and Description
WebDriverSpawnParameters(WebDriverType driverType, boolean sso, java.util.List<java.lang.String> runtimeWebOptions, java.lang.String deviceId) Package-private constructor for setting the base / immutable values expected to be always present.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeviceId() Getter for deviceId.
WebDriverType	getDriverType() Getter for driverType.
java.util.List<java.lang.String>	getRuntimeWebOptions() Getter for runtimeWebOptions.
SessionForkManager.ForkedSessionConfigs	getSessionForkParams() Getter for sessionForkParams.
SsoAuthenticator.Result	getSsoAuthResult() Getter for ssoAuthResult.
boolean	isGui() Returns if the driverType is gui.
boolean	isSessionFork() Getter for isSessionFork.
boolean	isSso() Getter for sso.
void	setSessionFork(SessionForkManager.ForkedSessionConfigs sessionForkParams) Sets the unique spawn parameters for forking a session.
void	setSsoAuthResult(SsoAuthenticator.Result ssoAuthResult) Setter for ssoAuthResult.

Methods inherited from class java.lang.Object

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

Field Detail

runtimeWebOptions

private java.util.List<java.lang.String> runtimeWebOptions

List of caller-specified options to be passed on the client command line or null if no values are specified.

sso

private boolean sso

Flag to indicate if the spawning process uses SSO authentication.

driverType

private WebDriverType driverType

The web driver type: gui, chui, embedded.

isSessionFork

private boolean isSessionFork

Flag to indicate if this is session fork attempt.

deviceId

private java.lang.String deviceId

Device ID

sessionForkParams

private SessionForkManager.ForkedSessionConfigs sessionForkParams

Params for a new forked session

ssoAuthResult

private SsoAuthenticator.Result ssoAuthResult

The result of SSO authentication.

Constructor Detail

WebDriverSpawnParameters

WebDriverSpawnParameters(WebDriverType driverType,
                         boolean sso,
                         java.util.List<java.lang.String> runtimeWebOptions,
                         java.lang.String deviceId)

Package-private constructor for setting the base / immutable values expected to be always present.

Parameters:

driverType - The web driver type: gui, chui, embedded.

sso - Boolean to indicate if SSO authentication is enabled or not.

runtimeWebOptions - An array of spawn options sent to the client process.

deviceId - The device ID.

Method Detail

setSsoAuthResult

public void setSsoAuthResult(SsoAuthenticator.Result ssoAuthResult)

Setter for ssoAuthResult.

Parameters:

ssoAuthResult - The SSO authenticator result from auto-login.

setSessionFork

public void setSessionFork(SessionForkManager.ForkedSessionConfigs sessionForkParams)

Sets the unique spawn parameters for forking a session.

Parameters:

sessionForkParams - All

isGui

public boolean isGui()

Returns if the driverType is gui.

Returns:

See above.

getDriverType

public WebDriverType getDriverType()

Getter for driverType.

Returns:

See above.

getRuntimeWebOptions

public java.util.List<java.lang.String> getRuntimeWebOptions()

Getter for runtimeWebOptions.

Returns:

See above.

isSso

public boolean isSso()

Getter for sso.

Returns:

See above.

getSsoAuthResult

public SsoAuthenticator.Result getSsoAuthResult()

Getter for ssoAuthResult.

Returns:

See above.

isSessionFork

public boolean isSessionFork()

Getter for isSessionFork.

Returns:

See above.

getDeviceId

public java.lang.String getDeviceId()

Getter for deviceId.

Returns:

See above.

getSessionForkParams

public SessionForkManager.ForkedSessionConfigs getSessionForkParams()

Getter for sessionForkParams.

Returns:

See above.