WebDriverSpawnParameters.java
/*
** Module : WebDriverSpawnParameters.java
** Abstract : Container for parameters needed for spawning a new web client.
**
** Copyright (c) 2023-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------Description---------------------------------
** 001 GBB 20230817 Created initial version
** 002 GBB 20231113 Adding SessionForkManager.ForkedSessionConfigs params.
** 003 GBB 20240214 Adding deviceId.
** 004 GBB 20240709 Replacing field gui with driverType. Renaming options to runtimeWebOptions.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.main;
import com.goldencode.p2j.security.*;
import com.goldencode.p2j.util.*;
import java.util.*;
/** The container for web spawn parameters. */
class WebDriverSpawnParameters
{
/**
* List of caller-specified options to be passed on the client command line or null
* if no values are specified.
*/
private List<String> runtimeWebOptions;
/** Flag to indicate if the spawning process uses SSO authentication.*/
private boolean sso;
/** The web driver type: gui, chui, embedded. */
private WebDriverType driverType;
/** Flag to indicate if this is session fork attempt. */
private boolean isSessionFork;
/** Device ID */
private String deviceId;
/** Params for a new forked session */
private SessionForkManager.ForkedSessionConfigs sessionForkParams;
/** The result of SSO authentication. */
private SsoAuthenticator.Result ssoAuthResult;
/**
* Package-private constructor for setting the base / immutable values expected to be always present.
*
* @param driverType
* The web driver type: gui, chui, embedded.
* @param sso
* Boolean to indicate if SSO authentication is enabled or not.
* @param runtimeWebOptions
* An array of spawn options sent to the client process.
* @param deviceId
* The device ID.
*/
WebDriverSpawnParameters(WebDriverType driverType,
boolean sso,
List<String> runtimeWebOptions,
String deviceId)
{
this.driverType = driverType;
this.sso = sso;
this.runtimeWebOptions = runtimeWebOptions;
this.deviceId = deviceId;
}
/**
* Setter for {@link #ssoAuthResult}.
*
* @param ssoAuthResult
* The SSO authenticator result from auto-login.
*/
public void setSsoAuthResult(SsoAuthenticator.Result ssoAuthResult)
{
this.ssoAuthResult = ssoAuthResult;
}
/**
* Sets the unique spawn parameters for forking a session.
*
* @param sessionForkParams
* All
*/
public void setSessionFork(SessionForkManager.ForkedSessionConfigs sessionForkParams)
{
this.isSessionFork = true;
this.sessionForkParams = sessionForkParams;
}
/**
* Returns if the {@link #driverType} is gui.
*
* @return See above.
*/
public boolean isGui()
{
return driverType.isGui();
}
/**
* Getter for {@link #driverType}.
*
* @return See above.
*/
public WebDriverType getDriverType()
{
return driverType;
}
/**
* Getter for {@link #runtimeWebOptions}.
*
* @return See above.
*/
public List<String> getRuntimeWebOptions()
{
return runtimeWebOptions;
}
/**
* Getter for {@link #sso}.
*
* @return See above.
*/
public boolean isSso()
{
return sso;
}
/**
* Getter for {@link #ssoAuthResult}.
*
* @return See above.
*/
public SsoAuthenticator.Result getSsoAuthResult()
{
return ssoAuthResult;
}
/**
* Getter for {@link #isSessionFork}.
*
* @return See above.
*/
public boolean isSessionFork()
{
return isSessionFork;
}
/**
* Getter for {@link #deviceId}.
*
* @return See above.
*/
public String getDeviceId()
{
return deviceId;
}
/**
* Getter for {@link #sessionForkParams}.
*
* @return See above.
*/
public SessionForkManager.ForkedSessionConfigs getSessionForkParams()
{
return sessionForkParams;
}
}