com.goldencode.p2j.main

Class WebClientBuilderParameters

java.lang.Object

com.goldencode.p2j.main.ClientBuilderParameters

com.goldencode.p2j.main.WebClientBuilderParameters

public class WebClientBuilderParameters
extends ClientBuilderParameters

This structure holds default parameters as well specific parameters used to create and spawn a process for a web client (either GUI or ChUI).

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.Map<ConfigItem,java.lang.String>	DEBUG_PROFILE Unmodifiable map of client config : default value pairs for the debug profile.
private static java.lang.String	DEBUGGER_TRANSPORT The template for the transport part of the java debugger agent connection string
private WebClientBuilderOptions	dirOptions Default options from directory
private java.util.List<java.lang.String>	dirWebOverrides The bootstrap config overrides coming from directory, i.e.
private java.util.List<java.lang.String>	firstWebOverrides The bootstrap config overrides to be applied first.
private java.util.List<java.lang.String>	lastWebOverrides The bootstrap config overrides to be applied last.
private static CentralLogger	LOG Logger.
private java.util.List<java.lang.String>	runtimeWebOverrides The bootstrap config overrides compiled runtime: theme, webRoot, login/logout page url, forked session overrides.
private java.lang.String	ssoFwdUser Fwd user for SSO authentication.
private java.lang.String	storageId The unique id for the client storage.
private boolean	trusted Enables trusted launch mode (no password is used and the OS account is forced).

Constructor Summary

Constructors

Constructor and Description

WebClientBuilderParameters(java.lang.String osUser, java.lang.String osPass, WebClientBuilderOptions dirOptions, int securePort, java.lang.String serverAlias, boolean trusted, java.lang.String ssoFwdUser, java.lang.String storageId, java.util.List<java.lang.String> firstWebOverrides, java.util.List<java.lang.String> dirWebOverrides, java.util.List<java.lang.String> runtimeWebOverrides, java.util.List<java.lang.String> lastWebOverrides) Constructor.

Method Summary

Modifier and Type	Method and Description
WebClientBuilderOptions	getDirOptions() Returns the directory values for the client as WebClientBuilderOptions.
java.util.List<java.lang.String>	getDirWebOverrides() Getter for dirWebOverrides.
java.util.List<java.lang.String>	getFirstWebOverrides() Getter for firstWebOverrides.
java.util.List<java.lang.String>	getLastWebOverrides() Getter for lastWebOverrides.
java.util.List<java.lang.String>	getRuntimeWebOverrides() Getter for runtimeWebOverrides.
java.lang.String	getSsoFwdUser() Get the FWD user for SSO authentication.
java.lang.String	getStorageId() Get the unique id for the client storage.
boolean	isGui() Get the flag that reports which web client type is in use.
boolean	isPasswordAuthentication() Get the authentication mode for this spawner.
boolean	isTrusted() Get the flag that reports is spawning should use trusted mode.
(package private) void	updateOptions(WebAllocatedResources allocatedResources) Update the command line parameters for the spawning process with the web client configuration.

Methods inherited from class com.goldencode.p2j.main.ClientBuilderParameters

getOsPass, getOsUser, getSecurePort, getServerAlias, getUuid

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger.

DEBUGGER_TRANSPORT

private static final java.lang.String DEBUGGER_TRANSPORT

The template for the transport part of the java debugger agent connection string

See Also:

Constant Field Values

DEBUG_PROFILE

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

Unmodifiable map of client config : default value pairs for the debug profile.

trusted

private final boolean trusted

Enables trusted launch mode (no password is used and the OS account is forced).

firstWebOverrides

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

The bootstrap config overrides to be applied first. Lowest priority. Embedded startup procedure.

dirWebOverrides

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

The bootstrap config overrides coming from directory, i.e. webClient/cfgOverrides.

runtimeWebOverrides

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

The bootstrap config overrides compiled runtime: theme, webRoot, login/logout page url, forked session overrides.

lastWebOverrides

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

The bootstrap config overrides to be applied last. Highest priority. Web driver type: embedded or not.

dirOptions

private final WebClientBuilderOptions dirOptions

Default options from directory

ssoFwdUser

private final java.lang.String ssoFwdUser

Fwd user for SSO authentication.

storageId

private final java.lang.String storageId

The unique id for the client storage. null if SSO not enabled.

Constructor Detail

WebClientBuilderParameters

public WebClientBuilderParameters(java.lang.String osUser,
                                  java.lang.String osPass,
                                  WebClientBuilderOptions dirOptions,
                                  int securePort,
                                  java.lang.String serverAlias,
                                  boolean trusted,
                                  java.lang.String ssoFwdUser,
                                  java.lang.String storageId,
                                  java.util.List<java.lang.String> firstWebOverrides,
                                  java.util.List<java.lang.String> dirWebOverrides,
                                  java.util.List<java.lang.String> runtimeWebOverrides,
                                  java.util.List<java.lang.String> lastWebOverrides)

Constructor. Assign a unique UUID to this process.

Parameters:

osUser - The OS user name.

osPass - The OS user password.

dirOptions - The client builder options.

securePort - The server's secure port.

serverAlias - The alias of the server certificate.

trusted - If this instance will be used to launch clients in trusted mode.

ssoFwdUser - Fwd user for SSO authentication.

storageId - The unique id for the client storage.

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

dirWebOverrides - The bootstrap config overrides coming from directory.

runtimeWebOverrides - The bootstrap config overrides compiled runtime.

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

Method Detail

getDirOptions

public WebClientBuilderOptions getDirOptions()

Returns the directory values for the client as WebClientBuilderOptions.

Specified by:

getDirOptions in class ClientBuilderParameters

Returns:

See above.

isPasswordAuthentication

public boolean isPasswordAuthentication()

Get the authentication mode for this spawner.

Specified by:

isPasswordAuthentication in class ClientBuilderParameters

Returns:

true indicating that the user's password is required for authentication.

isGui

public boolean isGui()

Get the flag that reports which web client type is in use.

Returns:

Client type (true for GUI, false for ChUI).

isTrusted

public boolean isTrusted()

Get the flag that reports is spawning should use trusted mode.

Returns:

Trusted mode flag.

getSsoFwdUser

public java.lang.String getSsoFwdUser()

Get the FWD user for SSO authentication.

Returns:

The FWD user for SSO authentication.

getStorageId

public java.lang.String getStorageId()

Get the unique id for the client storage.

Returns:

The unique id for the client storage.

getFirstWebOverrides

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

Getter for firstWebOverrides.

Returns:

See above.

getDirWebOverrides

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

Getter for dirWebOverrides.

Returns:

See above.

getRuntimeWebOverrides

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

Getter for runtimeWebOverrides.

Returns:

See above.

getLastWebOverrides

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

Getter for lastWebOverrides.

Returns:

See above.

updateOptions

void updateOptions(WebAllocatedResources allocatedResources)

Update the command line parameters for the spawning process with the web client configuration.

Parameters:

allocatedResources - The web client allocated resources