com.goldencode.p2j.main

Class WebClientBuilderOptions

java.lang.Object

com.goldencode.p2j.main.WebClientBuilderOptions

All Implemented Interfaces:

ClientBuilderOptions, WebConfigurationConstants

public class WebClientBuilderOptions
extends java.lang.Object
implements ClientBuilderOptions, WebConfigurationConstants

The parameters stored inside this structure are read from directory on server start-up and are used as default parameters to create and spawn a web client process.

This class MUST NOT BE USED from client side, as it uses a direct access to the server. Also, this class can be instantiated only from threads with a P2J context for the running P2J server.

Field Summary

Fields

Modifier and Type	Field and Description
private BaseClientBuilderOptions	baseOptions Base options.
private java.util.Map<java.lang.String,java.lang.String>	dirOptions Options storage.
private WebDriverType	driverType The web driver type.
private java.lang.ThreadLocal<java.util.Map<java.lang.String,java.lang.String>>	overriddenOptions Storage for overridden options.
private java.lang.String	projectToken Project token
private static java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	tokenConfigsCachedPairs Cache for configs (resolved by readConfigs()), stored by project token.

Fields inherited from interface com.goldencode.p2j.web.WebConfigurationConstants

CONNECTION_RESTORED_MESSAGE, CONNECTION_TIMEOUT, DELAY_BETWEEN_CONNECT_TRIES, DELAY_BETWEEN_PING_TRIES, ENABLE_DEBUG_LOGGING, INFINITE_TIMEOUT, MAX_BINARY_MESSAGE_SIZE, MAX_LOST_PINGS, MAX_TEXT_MESSAGE_SIZE, MAX_WEB_SOCKET_IDLE_TIMEOUT, OUTPUT_AGGREGATION_SIZE, OUTPUT_BUFFER_SIZE, PING_PONG_INTERVAL, REQUEST_HEADER_SIZE, RESPONSE_HEADER_SIZE, SERVER_UNAVAILABLE_MESSAGE, TRY_TO_CONNECT_MESSAGE, WATCH_DOG_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
WebClientBuilderOptions(WebDriverType driverType) Public constructor.

Method Summary

Modifier and Type	Method and Description
private static <T> void	add(java.util.Map<java.lang.String,java.lang.String> options, ConfigItem<T> clientConfig, T defaultValue) Convenience method to add to the options map the name and value of the client config.
private static <T> void	add(java.util.Map<java.lang.String,java.lang.String> options, ConfigItem<T> clientConfig, T defaultValue, boolean quoteStrings) Convenience method to add to the options map the name and value of the client config.
(package private) java.lang.String	get(ConfigItem clientConfig) Returns the value stored for the client config parameter.
BaseClientBuilderOptions	getBaseOptions() Returns the base client options.
(package private) java.util.Map<java.lang.String,java.lang.String>	getDefaults() Returns the default web client options.
WebDriverType	getDriverType() Returns the driverType.
(package private) java.util.Map<java.lang.String,java.lang.String>	getOverriddenOptions() Returns the default web client options.
java.lang.String	getProjectToken() Returns the projectToken.
(package private) void	override(java.lang.String name, java.lang.String value) Add the given named option to the overridden options map.
(package private) static java.util.Map<java.lang.String,java.lang.String>	readConfigs() Reads the configuration from the directory and calculates certain runtime values that will be used by web client launching.
void	reset() Resets the thread local value of overriddenOptions.

Methods inherited from class java.lang.Object

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

Field Detail

tokenConfigsCachedPairs

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

Cache for configs (resolved by readConfigs()), stored by project token. The values are unmodifiable maps of ConfigItem.name() : value.

dirOptions

private final java.util.Map<java.lang.String,java.lang.String> dirOptions

Options storage. Unmodifiable map.

baseOptions

private final BaseClientBuilderOptions baseOptions

Base options.

overriddenOptions

private final java.lang.ThreadLocal<java.util.Map<java.lang.String,java.lang.String>> overriddenOptions

Storage for overridden options. Different on the different Jetty threads. To be reset.

driverType

private final WebDriverType driverType

The web driver type. Can't be in WebClientBuilderOptions to resolve the parent options.

projectToken

private final java.lang.String projectToken

Project token

Constructor Detail

WebClientBuilderOptions

public WebClientBuilderOptions(WebDriverType driverType)

Public constructor. Reads the configuration from the directory and calculates certain runtime values that will be used by web client launching.

Parameters:

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

Throws:

java.lang.IllegalStateException - If this is called from P2J clients.

Method Detail

reset

public void reset()

Resets the thread local value of overriddenOptions.

getDriverType

public WebDriverType getDriverType()

Returns the driverType.

Returns:

See above.

getProjectToken

public java.lang.String getProjectToken()

Returns the projectToken.

Returns:

See above.

readConfigs

static java.util.Map<java.lang.String,java.lang.String> readConfigs()

Reads the configuration from the directory and calculates certain runtime values that will be used by web client launching.

Returns:

Unmodifiable map of options.

getBaseOptions

public BaseClientBuilderOptions getBaseOptions()

Returns the base client options.

Specified by:

getBaseOptions in interface ClientBuilderOptions

Returns:

The base client options.

override

void override(java.lang.String name,
              java.lang.String value)

Add the given named option to the overridden options map.

Parameters:

name - The option name

value - The option value

get

java.lang.String get(ConfigItem clientConfig)

Returns the value stored for the client config parameter. First checks the overridden options and then falls back to the default options.

Parameters:

clientConfig - The client config.

Returns:

The value stored for the client config parameter.

getDefaults

java.util.Map<java.lang.String,java.lang.String> getDefaults()

Returns the default web client options.

Returns:

See above.

getOverriddenOptions

java.util.Map<java.lang.String,java.lang.String> getOverriddenOptions()

Returns the default web client options.

Returns:

See above.

add

private static <T> void add(java.util.Map<java.lang.String,java.lang.String> options,
                            ConfigItem<T> clientConfig,
                            T defaultValue)

Convenience method to add to the options map the name and value of the client config.

Type Parameters:

T - The type of the client config value.

Parameters:

options - The options map of client config name : value pairs.

clientConfig - The client config.

defaultValue - The default value.

add

private static <T> void add(java.util.Map<java.lang.String,java.lang.String> options,
                            ConfigItem<T> clientConfig,
                            T defaultValue,
                            boolean quoteStrings)

Convenience method to add to the options map the name and value of the client config.

Type Parameters:

T - The type of the client config value.

Parameters:

options - The options map of client config name : value pairs.

clientConfig - The client config.

defaultValue - The default value.

quoteStrings - Flag to add quotes to the string.