com.goldencode.p2j.util

Class ConfigItem<T>

java.lang.Object

com.goldencode.p2j.util.ConfigItem<T>

Type Parameters:

T - The type for the value of the config.

public final class ConfigItem<T>
extends java.lang.Object

Core class for resolving clientConfig and webClient configs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigItem.Type The type of client config, based on the origin.

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigItem<java.lang.String>	BACKGROUND
static ConfigItem<java.lang.Integer>	BROADCAST_CHANNEL_PING_TIMEOUT
static ConfigItem<java.lang.String>	BROWSER_CONTEXT_PATH
static ConfigItem<java.lang.Integer>	BROWSER_LOAD_TIMEOUT
static ConfigItem<java.lang.String>	BROWSER_RESOURCE_BASE
static ConfigItem<java.lang.String>	BROWSER_WHITELIST_CONTEXT_PATH The placeholder is to be replaced by the name.
static ConfigItem<java.lang.String>	BROWSER_WHITELIST_RESOURCE_BASE The placeholder is to be replaced by the name.
static ConfigItem<java.lang.Boolean>	BYPASS_NO_MSG_WIN_ON_PAUSE Indicates whether or not pause x no message should enable the default-window
static ConfigItem<java.lang.Integer>	CACHE_SIZE
static ConfigItem<java.lang.String>	CFG_OVERRIDES
static ConfigItem<java.lang.String>	CFG_OVERRIDES_WEB
static ConfigItem<java.lang.Boolean>	CHANGE_EXPIRING_OS_PASS
static ConfigItem<java.lang.String>	CHUI_IDENTIFIER
static ConfigItem<java.lang.String>	CLASSPATH
static ConfigItem<java.lang.String>	CLASSPATH_EXTRA_JARS
private static java.lang.String	CLIENT_CONF_CONTAINER The directory container name for generic client configs.
static ConfigItem<java.lang.Integer>	CLIENT_PORT_RANGE_FROM
static ConfigItem<java.lang.Integer>	CLIENT_PORT_RANGE_TO
static ConfigItem<java.lang.Boolean>	CLIPBOARD
static ConfigItem<java.lang.Integer>	COLS
static ConfigItem<java.lang.String>	COMMAND
static ConfigItem<java.lang.String>	CONFIG_FILE
static ConfigItem<java.lang.Integer>	CONNECT_RETRY_DELAY
static ConfigItem<java.lang.String>	CONNECTION_RESTORED_MSG
static ConfigItem<java.lang.Integer>	CONNECTION_TEST_TIMEOUT
static ConfigItem<java.lang.String>	DEFAULT_OS_USER
static ConfigItem<java.lang.Integer>	DESKTOP_HEIGHT
static ConfigItem<java.lang.Integer>	DESKTOP_WIDTH
static ConfigItem<java.lang.Boolean>	DISABLE_PIXEL_MANIPULATION
static ConfigItem<java.lang.String>	DRIVER_TYPE
static ConfigItem<java.lang.Boolean>	EMBEDDED
static ConfigItem<java.lang.String>	EMBEDDED_IDENTIFIER
static ConfigItem<java.util.Map>	ENV_PROPERTIES
static ConfigItem<java.lang.String>	FONT_NAME
static ConfigItem<java.lang.Integer>	FONT_SIZE
static ConfigItem<java.lang.Boolean>	FORCE_CENTERED_DIALOG
static ConfigItem<java.lang.String>	FOREGROUND
static ConfigItem<java.lang.Boolean>	GRAPHICS_CACHED
static ConfigItem<java.lang.String>	GUI_IDENTIFIER
static ConfigItem<java.util.Map>	HELPER_APPS
static ConfigItem<java.lang.String>	HOST The host for the web server on the client process.
static ConfigItem<java.lang.Boolean>	JS_DEBUG_LOGGING Enables web client debug logging in js.
static ConfigItem<java.lang.String>	JVM_ARGS
static ConfigItem<java.lang.String>	KEYBOARD_LAYOUT_ID
static ConfigItem<java.lang.String>	KEYBOARD_LAYOUTS The relative desktop node path
static ConfigItem<java.lang.Boolean>	KEYBOARD_SHORTCUTS_UNDERLINE
static ConfigItem<java.lang.String>	LANG
static ConfigItem<java.lang.String>	LIB_PATH
private static CentralLogger	LOG Logger.
static ConfigItem<java.lang.String>	LOGIN_PAGE
static ConfigItem<java.util.List>	LOGIN_PARAMS
static ConfigItem<java.lang.String>	LOGIN_PARAMS_REGEX The placeholder is to be replaced by the name of the login param.
static ConfigItem<java.lang.String>	LOGIN_TITLE
static ConfigItem<java.lang.String>	LOGOUT_PAGE
static ConfigItem<java.lang.String>	LOGOUT_TITLE
static ConfigItem<java.lang.Integer>	MAX_AGENT_PORT
static ConfigItem<java.lang.Integer>	MAX_BINARY_MSG_SIZE
static ConfigItem<java.lang.String>	MAX_FILE_SIZE_ON_DISK
static ConfigItem<java.lang.Integer>	MAX_HTTP_IDLE_TIME
static ConfigItem<java.lang.Integer>	MAX_IDLE_TIME The idle time after which the connection should be closed
static ConfigItem<java.lang.Integer>	MAX_LOST_PINGS
static ConfigItem<java.lang.Integer>	MAX_OUT_AGGREGATION_SIZE
static ConfigItem<java.lang.Integer>	MAX_OUT_BUFFER_SIZE
static ConfigItem<java.lang.Integer>	MAX_REQUEST_HEADER_SIZE
static ConfigItem<java.lang.Integer>	MAX_RESPONSE_HEADER_SIZE
static ConfigItem<java.lang.Integer>	MAX_TEXT_MSG_SIZE
static ConfigItem<java.lang.Integer>	MIN_AGENT_PORT
private java.lang.String	nodeName The directory node name for the config.
static ConfigItem<java.lang.Boolean>	ONE_BROWSER_POLICY
private java.lang.String	optionCategoryName The bootstrap option category.
private java.lang.String	optionGroupName The bootstrap option group.
private java.lang.String	optionKeyName The bootstrap option key.
private java.lang.String	optionName The bootstrap option full name: category:group:key.
static ConfigItem<java.lang.String>	OUTPUT_TO_FILE
static ConfigItem<java.lang.Boolean>	OVERRIDE_OS_USER
static ConfigItem<java.lang.Integer>	PING_DELAY
static ConfigItem<java.lang.Integer>	PING_PONG_INTERVAL The delay between successful MSG_PING_PONG pairs if the server replies with MSG_PING_PONG
static ConfigItem<java.lang.Integer>	POLL_TIMEOUT
static ConfigItem<java.lang.Integer>	PORT The port for the web server on the client process.
static ConfigItem<java.lang.String>	PROJECT_TOKEN
static ConfigItem<java.lang.String>	PROXY_CLIENT_NAME_PREFIX
static ConfigItem<java.lang.String>	PROXY_CLIENT_PATH_SEGMENT
static ConfigItem<java.lang.String>	PROXY_HOST
static ConfigItem<java.lang.String>	PROXY_PROTOCOL
static ConfigItem<java.lang.Boolean>	PROXY_REMOVE_SERVER_PATH
static ConfigItem<java.lang.String>	PROXY_SERVER_PATH
static ConfigItem<java.lang.String>	RENDERER
static ConfigItem<java.lang.Integer>	ROWS
static ConfigItem<java.lang.Boolean>	SECURE
static ConfigItem<java.lang.String>	SELECTION
static ConfigItem<java.lang.String>	SERVER_BASE_URL
static ConfigItem<java.lang.String>	SERVER_HOST
static ConfigItem<java.lang.Integer>	SERVER_INSECURE_PORT
static ConfigItem<java.lang.Integer>	SERVER_PORT
static ConfigItem<java.lang.Integer>	SERVER_SECURE_PORT The server's secure port.
static ConfigItem<java.lang.Boolean>	SERVER_SOCKET_NIO
static ConfigItem<java.lang.Boolean>	SERVER_SSL_TRACKSEQNO
static ConfigItem<java.lang.String>	SERVER_UNAVAILABLE_MSG
static ConfigItem<java.lang.String>	SPAWNER
static ConfigItem<java.lang.Boolean>	SPAWNER_DEBUG Enables spawned client process logging by the native process.
static ConfigItem<java.lang.String>	SPAWNER_UUID
static ConfigItem<java.lang.Boolean>	SPREADSHEET_ENABLED
static ConfigItem<java.lang.String>	SSO_STORAGE_ID
static ConfigItem<java.lang.String>	SSO_SUBJECT_ID
static ConfigItem<java.lang.String>	SYSTEM_PASS OS pass for processes appserver / scheduled batch.
static ConfigItem<java.lang.String>	SYSTEM_USER OS user for processes appserver / scheduled batch.
static ConfigItem<java.lang.Boolean>	TASKBAR
static ConfigItem<java.lang.String>	TASKBAR_STYLE
static ConfigItem<java.lang.String>	TRY_CONNECT_MSG
private ConfigItem.Type	type The ConfigItem.Type for the config.
static ConfigItem<java.lang.String>	UPLOAD_SINGLE_FILE
static ConfigItem<java.lang.String>	UPLOAD_TOTAL_FILES
static ConfigItem<java.lang.Boolean>	USE_LOCALSTORAGE
static ConfigItem<java.lang.Boolean>	VALIDATE_SEC_CERT
private java.lang.Class<T>	valueClass The class for the config value.
static ConfigItem<java.lang.Boolean>	VIRTUAL_DESKTOP
static ConfigItem<java.lang.Integer>	WATCHDOG_TIMEOUT The "watchdogTimeout" parameter to define the watch dog timeout
private static java.lang.String	WEB_CLIENT_CONTAINER The directory container name for web client configs.
static ConfigItem<java.lang.String>	WEB_ROOT
static ConfigItem<java.lang.Integer>	WEB_SOCKET_TIMEOUT The "webSocketTimeout" parameter to define the maximal idle time of the configured websocket
static ConfigItem<java.lang.String>	WORKING_DIR

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConfigItem(java.lang.Class<T> valueClass, java.lang.String nodeName) Private constructor.
private	ConfigItem(java.lang.Class<T> valueClass, java.lang.String nodeName, java.lang.String optionCategoryName, java.lang.String optionGroupName, java.lang.String optionKeyName, ConfigItem.Type type) Private constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	category() Getter for optionCategoryName.
java.lang.String	fullOption() Getter for optionName.
java.lang.String	group() Getter for optionGroupName.
java.lang.String	key() Getter for optionKeyName.
java.lang.String	name() Getter for name().
T	read(T defaultValue) Reads the client config with the specified default value.
T	read(T defaultValue, DirectoryService ds) Reads the client config with the specified default value.
T	read(T defaultValue, java.lang.String placeholderValue) Reads the client config with the specified default value.
T	read(T defaultValue, java.lang.String placeholderValue, DirectoryService ds) Reads the client config with the specified default value.
T	read(T defaultValue, Utils.DirScope scope) Reads the client config with the specified default value.
T	read(T defaultValue, Utils.DirScope scope, java.lang.String[] accountIds) Reads the client config with the specified default value.
T	read(T defaultValue, WebDriverType webDriverType) Reads the client config with the specified default value.
T	read(T defaultValue, WebDriverType webDriverType, java.lang.String placeholderValue) Reads the client config with the specified default value.
T	read(WebDriverType webDriverType, Utils.DirScope scope, T defaultValue, DirectoryService ds, java.lang.String placeholderValue, java.lang.String[] accountIds) Reads the client config with the specified default value.
private T	readFullNode(java.lang.String fullNode, Utils.DirScope scope, T defaultValue, DirectoryService ds, java.lang.String[] accountIds) Reads the client config with the specified default value.
T	readInClient(Directory directory, int search, T defaultValue) Reads client-side the config with the specified default value.
java.lang.String	toString() Returns the string representation of the client config.

Methods inherited from class java.lang.Object

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

Field Detail

CFG_OVERRIDES

public static final ConfigItem<java.lang.String> CFG_OVERRIDES

SECURE

public static final ConfigItem<java.lang.Boolean> SECURE

COMMAND

public static final ConfigItem<java.lang.String> COMMAND

CLASSPATH

public static final ConfigItem<java.lang.String> CLASSPATH

LIB_PATH

public static final ConfigItem<java.lang.String> LIB_PATH

SPAWNER

public static final ConfigItem<java.lang.String> SPAWNER

SPAWNER_DEBUG

public static final ConfigItem<java.lang.Boolean> SPAWNER_DEBUG

Enables spawned client process logging by the native process. Catches JVM errors. Used only for debugging.

WORKING_DIR

public static final ConfigItem<java.lang.String> WORKING_DIR

OUTPUT_TO_FILE

public static final ConfigItem<java.lang.String> OUTPUT_TO_FILE

CONFIG_FILE

public static final ConfigItem<java.lang.String> CONFIG_FILE

CLASSPATH_EXTRA_JARS

public static final ConfigItem<java.lang.String> CLASSPATH_EXTRA_JARS

JVM_ARGS

public static final ConfigItem<java.lang.String> JVM_ARGS

MIN_AGENT_PORT

public static final ConfigItem<java.lang.Integer> MIN_AGENT_PORT

MAX_AGENT_PORT

public static final ConfigItem<java.lang.Integer> MAX_AGENT_PORT

SYSTEM_USER

public static final ConfigItem<java.lang.String> SYSTEM_USER

OS user for processes appserver / scheduled batch.

SYSTEM_PASS

public static final ConfigItem<java.lang.String> SYSTEM_PASS

OS pass for processes appserver / scheduled batch.

KEYBOARD_LAYOUTS

public static final ConfigItem<java.lang.String> KEYBOARD_LAYOUTS

The relative desktop node path

KEYBOARD_LAYOUT_ID

public static final ConfigItem<java.lang.String> KEYBOARD_LAYOUT_ID

KEYBOARD_SHORTCUTS_UNDERLINE

public static final ConfigItem<java.lang.Boolean> KEYBOARD_SHORTCUTS_UNDERLINE

HELPER_APPS

public static final ConfigItem<java.util.Map> HELPER_APPS

ENV_PROPERTIES

public static final ConfigItem<java.util.Map> ENV_PROPERTIES

VALIDATE_SEC_CERT

public static final ConfigItem<java.lang.Boolean> VALIDATE_SEC_CERT

PROJECT_TOKEN

public static final ConfigItem<java.lang.String> PROJECT_TOKEN

CFG_OVERRIDES_WEB

public static final ConfigItem<java.lang.String> CFG_OVERRIDES_WEB

EMBEDDED

public static final ConfigItem<java.lang.Boolean> EMBEDDED

VIRTUAL_DESKTOP

public static final ConfigItem<java.lang.Boolean> VIRTUAL_DESKTOP

DEFAULT_OS_USER

public static final ConfigItem<java.lang.String> DEFAULT_OS_USER

OVERRIDE_OS_USER

public static final ConfigItem<java.lang.Boolean> OVERRIDE_OS_USER

GUI_IDENTIFIER

public static final ConfigItem<java.lang.String> GUI_IDENTIFIER

CHUI_IDENTIFIER

public static final ConfigItem<java.lang.String> CHUI_IDENTIFIER

EMBEDDED_IDENTIFIER

public static final ConfigItem<java.lang.String> EMBEDDED_IDENTIFIER

LOGIN_TITLE

public static final ConfigItem<java.lang.String> LOGIN_TITLE

LOGOUT_TITLE

public static final ConfigItem<java.lang.String> LOGOUT_TITLE

PORT

public static final ConfigItem<java.lang.Integer> PORT

The port for the web server on the client process.

HOST

public static final ConfigItem<java.lang.String> HOST

The host for the web server on the client process.

POLL_TIMEOUT

public static final ConfigItem<java.lang.Integer> POLL_TIMEOUT

CONNECTION_TEST_TIMEOUT

public static final ConfigItem<java.lang.Integer> CONNECTION_TEST_TIMEOUT

CLIENT_PORT_RANGE_FROM

public static final ConfigItem<java.lang.Integer> CLIENT_PORT_RANGE_FROM

CLIENT_PORT_RANGE_TO

public static final ConfigItem<java.lang.Integer> CLIENT_PORT_RANGE_TO

PROXY_HOST

public static final ConfigItem<java.lang.String> PROXY_HOST

PROXY_PROTOCOL

public static final ConfigItem<java.lang.String> PROXY_PROTOCOL

PROXY_CLIENT_NAME_PREFIX

public static final ConfigItem<java.lang.String> PROXY_CLIENT_NAME_PREFIX

PROXY_CLIENT_PATH_SEGMENT

public static final ConfigItem<java.lang.String> PROXY_CLIENT_PATH_SEGMENT

PROXY_SERVER_PATH

public static final ConfigItem<java.lang.String> PROXY_SERVER_PATH

PROXY_REMOVE_SERVER_PATH

public static final ConfigItem<java.lang.Boolean> PROXY_REMOVE_SERVER_PATH

WATCHDOG_TIMEOUT

public static final ConfigItem<java.lang.Integer> WATCHDOG_TIMEOUT

The "watchdogTimeout" parameter to define the watch dog timeout

PING_PONG_INTERVAL

public static final ConfigItem<java.lang.Integer> PING_PONG_INTERVAL

The delay between successful MSG_PING_PONG pairs if the server replies with MSG_PING_PONG

MAX_LOST_PINGS

public static final ConfigItem<java.lang.Integer> MAX_LOST_PINGS

MAX_IDLE_TIME

public static final ConfigItem<java.lang.Integer> MAX_IDLE_TIME

The idle time after which the connection should be closed

MAX_HTTP_IDLE_TIME

public static final ConfigItem<java.lang.Integer> MAX_HTTP_IDLE_TIME

WEB_SOCKET_TIMEOUT

public static final ConfigItem<java.lang.Integer> WEB_SOCKET_TIMEOUT

The "webSocketTimeout" parameter to define the maximal idle time of the configured websocket

CONNECT_RETRY_DELAY

public static final ConfigItem<java.lang.Integer> CONNECT_RETRY_DELAY

PING_DELAY

public static final ConfigItem<java.lang.Integer> PING_DELAY

MAX_BINARY_MSG_SIZE

public static final ConfigItem<java.lang.Integer> MAX_BINARY_MSG_SIZE

MAX_TEXT_MSG_SIZE

public static final ConfigItem<java.lang.Integer> MAX_TEXT_MSG_SIZE

TRY_CONNECT_MSG

public static final ConfigItem<java.lang.String> TRY_CONNECT_MSG

SERVER_UNAVAILABLE_MSG

public static final ConfigItem<java.lang.String> SERVER_UNAVAILABLE_MSG

CONNECTION_RESTORED_MSG

public static final ConfigItem<java.lang.String> CONNECTION_RESTORED_MSG

MAX_OUT_BUFFER_SIZE

public static final ConfigItem<java.lang.Integer> MAX_OUT_BUFFER_SIZE

MAX_OUT_AGGREGATION_SIZE

public static final ConfigItem<java.lang.Integer> MAX_OUT_AGGREGATION_SIZE

MAX_RESPONSE_HEADER_SIZE

public static final ConfigItem<java.lang.Integer> MAX_RESPONSE_HEADER_SIZE

MAX_REQUEST_HEADER_SIZE

public static final ConfigItem<java.lang.Integer> MAX_REQUEST_HEADER_SIZE

RENDERER

public static final ConfigItem<java.lang.String> RENDERER

GRAPHICS_CACHED

public static final ConfigItem<java.lang.Boolean> GRAPHICS_CACHED

DISABLE_PIXEL_MANIPULATION

public static final ConfigItem<java.lang.Boolean> DISABLE_PIXEL_MANIPULATION

TASKBAR

public static final ConfigItem<java.lang.Boolean> TASKBAR

TASKBAR_STYLE

public static final ConfigItem<java.lang.String> TASKBAR_STYLE

CLIPBOARD

public static final ConfigItem<java.lang.Boolean> CLIPBOARD

ROWS

public static final ConfigItem<java.lang.Integer> ROWS

COLS

public static final ConfigItem<java.lang.Integer> COLS

DESKTOP_HEIGHT

public static final ConfigItem<java.lang.Integer> DESKTOP_HEIGHT

DESKTOP_WIDTH

public static final ConfigItem<java.lang.Integer> DESKTOP_WIDTH

BACKGROUND

public static final ConfigItem<java.lang.String> BACKGROUND

FOREGROUND

public static final ConfigItem<java.lang.String> FOREGROUND

SELECTION

public static final ConfigItem<java.lang.String> SELECTION

FONT_NAME

public static final ConfigItem<java.lang.String> FONT_NAME

FONT_SIZE

public static final ConfigItem<java.lang.Integer> FONT_SIZE

FORCE_CENTERED_DIALOG

public static final ConfigItem<java.lang.Boolean> FORCE_CENTERED_DIALOG

BYPASS_NO_MSG_WIN_ON_PAUSE

public static final ConfigItem<java.lang.Boolean> BYPASS_NO_MSG_WIN_ON_PAUSE

Indicates whether or not pause x no message should enable the default-window

USE_LOCALSTORAGE

public static final ConfigItem<java.lang.Boolean> USE_LOCALSTORAGE

BROADCAST_CHANNEL_PING_TIMEOUT

public static final ConfigItem<java.lang.Integer> BROADCAST_CHANNEL_PING_TIMEOUT

ONE_BROWSER_POLICY

public static final ConfigItem<java.lang.Boolean> ONE_BROWSER_POLICY

UPLOAD_SINGLE_FILE

public static final ConfigItem<java.lang.String> UPLOAD_SINGLE_FILE

UPLOAD_TOTAL_FILES

public static final ConfigItem<java.lang.String> UPLOAD_TOTAL_FILES

MAX_FILE_SIZE_ON_DISK

public static final ConfigItem<java.lang.String> MAX_FILE_SIZE_ON_DISK

SPREADSHEET_ENABLED

public static final ConfigItem<java.lang.Boolean> SPREADSHEET_ENABLED

BROWSER_LOAD_TIMEOUT

public static final ConfigItem<java.lang.Integer> BROWSER_LOAD_TIMEOUT

BROWSER_CONTEXT_PATH

public static final ConfigItem<java.lang.String> BROWSER_CONTEXT_PATH

BROWSER_RESOURCE_BASE

public static final ConfigItem<java.lang.String> BROWSER_RESOURCE_BASE

BROWSER_WHITELIST_CONTEXT_PATH

public static final ConfigItem<java.lang.String> BROWSER_WHITELIST_CONTEXT_PATH

The placeholder is to be replaced by the name.

BROWSER_WHITELIST_RESOURCE_BASE

public static final ConfigItem<java.lang.String> BROWSER_WHITELIST_RESOURCE_BASE

The placeholder is to be replaced by the name.

LOGIN_PARAMS

public static final ConfigItem<java.util.List> LOGIN_PARAMS

LOGIN_PARAMS_REGEX

public static final ConfigItem<java.lang.String> LOGIN_PARAMS_REGEX

The placeholder is to be replaced by the name of the login param.

CHANGE_EXPIRING_OS_PASS

public static final ConfigItem<java.lang.Boolean> CHANGE_EXPIRING_OS_PASS

SERVER_SECURE_PORT

public static final ConfigItem<java.lang.Integer> SERVER_SECURE_PORT

The server's secure port.

SERVER_INSECURE_PORT

public static final ConfigItem<java.lang.Integer> SERVER_INSECURE_PORT

SERVER_PORT

public static final ConfigItem<java.lang.Integer> SERVER_PORT

SERVER_HOST

public static final ConfigItem<java.lang.String> SERVER_HOST

SERVER_SOCKET_NIO

public static final ConfigItem<java.lang.Boolean> SERVER_SOCKET_NIO

SERVER_SSL_TRACKSEQNO

public static final ConfigItem<java.lang.Boolean> SERVER_SSL_TRACKSEQNO

LANG

public static final ConfigItem<java.lang.String> LANG

CACHE_SIZE

public static final ConfigItem<java.lang.Integer> CACHE_SIZE

DRIVER_TYPE

public static final ConfigItem<java.lang.String> DRIVER_TYPE

WEB_ROOT

public static final ConfigItem<java.lang.String> WEB_ROOT

LOGOUT_PAGE

public static final ConfigItem<java.lang.String> LOGOUT_PAGE

LOGIN_PAGE

public static final ConfigItem<java.lang.String> LOGIN_PAGE

SERVER_BASE_URL

public static final ConfigItem<java.lang.String> SERVER_BASE_URL

SSO_SUBJECT_ID

public static final ConfigItem<java.lang.String> SSO_SUBJECT_ID

SSO_STORAGE_ID

public static final ConfigItem<java.lang.String> SSO_STORAGE_ID

SPAWNER_UUID

public static final ConfigItem<java.lang.String> SPAWNER_UUID

JS_DEBUG_LOGGING

public static final ConfigItem<java.lang.Boolean> JS_DEBUG_LOGGING

Enables web client debug logging in js.

LOG

private static final CentralLogger LOG

Logger.

CLIENT_CONF_CONTAINER

private static final java.lang.String CLIENT_CONF_CONTAINER

The directory container name for generic client configs.

See Also:

Constant Field Values

WEB_CLIENT_CONTAINER

private static final java.lang.String WEB_CLIENT_CONTAINER

The directory container name for web client configs.

See Also:

Constant Field Values

valueClass

private final java.lang.Class<T> valueClass

The class for the config value.

nodeName

private final java.lang.String nodeName

The directory node name for the config.

type

private final ConfigItem.Type type

The ConfigItem.Type for the config.

optionName

private final java.lang.String optionName

The bootstrap option full name: category:group:key.

optionCategoryName

private final java.lang.String optionCategoryName

The bootstrap option category.

optionGroupName

private final java.lang.String optionGroupName

The bootstrap option group.

optionKeyName

private final java.lang.String optionKeyName

The bootstrap option key.

Constructor Detail

ConfigItem

private ConfigItem(java.lang.Class<T> valueClass,
                   java.lang.String nodeName)

Private constructor.

Parameters:

valueClass - The class for the config value.

nodeName - The directory node name for the config.

ConfigItem

private ConfigItem(java.lang.Class<T> valueClass,
                   java.lang.String nodeName,
                   java.lang.String optionCategoryName,
                   java.lang.String optionGroupName,
                   java.lang.String optionKeyName,
                   ConfigItem.Type type)

Private constructor.

Parameters:

valueClass - The class for the config value.

nodeName - The directory node name for the config.

optionCategoryName - The bootstrap option category.

optionGroupName - The bootstrap option group.

optionKeyName - The bootstrap option key.

type - The ConfigItem.Type for the config.

Method Detail

toString

public java.lang.String toString()

Returns the string representation of the client config. The same as name().

Overrides:

toString in class java.lang.Object

Returns:

See above.

name

public java.lang.String name()

Getter for name().

Returns:

See above.

category

public java.lang.String category()

Getter for optionCategoryName.

Returns:

See above.

group

public java.lang.String group()

Getter for optionGroupName.

Returns:

See above.

key

public java.lang.String key()

Getter for optionKeyName.

Returns:

See above.

fullOption

public java.lang.String fullOption()

Getter for optionName.

Returns:

See above.

read

public T read(T defaultValue)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              java.lang.String placeholderValue)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

placeholderValue - The value to replace the placeholder in the directory node name for the config.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              java.lang.String placeholderValue,
              DirectoryService ds)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

placeholderValue - The value to replace the placeholder in the directory node name for the config.

ds - The directory service.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              WebDriverType webDriverType)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

webDriverType - The web driver type.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              WebDriverType webDriverType,
              java.lang.String placeholderValue)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

webDriverType - The web driver type.

placeholderValue - The value to replace the placeholder in the directory node name for the config.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              Utils.DirScope scope)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

scope - The directory scope.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              Utils.DirScope scope,
              java.lang.String[] accountIds)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

scope - The directory scope.

accountIds - The account ids for the directory lookup.

Returns:

The client config value as read from directory.

read

public T read(T defaultValue,
              DirectoryService ds)

Reads the client config with the specified default value.

Parameters:

defaultValue - The default value returned if no value found in directory.

ds - The directory service.

Returns:

The client config value as read from directory.

readInClient

public T readInClient(Directory directory,
                      int search,
                      T defaultValue)

Reads client-side the config with the specified default value.

Parameters:

directory - The remote directory API.

search - Must be one of Directory.ID_ABSOLUTE (if the given node ID includes all paths from the root of the directory tree to the node being read) or Directory.ID_RELATIVE.

defaultValue - The default value returned if no value found in directory.

Returns:

The client config value as read with the directory rpc.

read

public T read(WebDriverType webDriverType,
              Utils.DirScope scope,
              T defaultValue,
              DirectoryService ds,
              java.lang.String placeholderValue,
              java.lang.String[] accountIds)

Reads the client config with the specified default value.

Parameters:

webDriverType - The web driver type.

scope - The directory scope.

defaultValue - The default value returned if no value found in directory.

ds - The directory service.

placeholderValue - The value to replace the placeholder in the directory node name for the config.

accountIds - The account ids for the directory lookup.

Returns:

The client config value as read from directory.

readFullNode

private T readFullNode(java.lang.String fullNode,
                       Utils.DirScope scope,
                       T defaultValue,
                       DirectoryService ds,
                       java.lang.String[] accountIds)

Reads the client config with the specified default value.

Parameters:

fullNode - The full name of the node.

scope - The directory scope.

defaultValue - The default value returned if no value found in directory.

ds - The directory service.

accountIds - The account ids for the directory lookup.

Returns:

The client config value as read from directory.