org.openqa.grid.internal.utils.configuration

Class GridHubConfiguration

java.lang.Object

org.openqa.grid.internal.utils.configuration.StandaloneConfiguration

org.openqa.grid.internal.utils.configuration.GridHubConfiguration

public class GridHubConfiguration
extends StandaloneConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GridHubConfiguration.CapabilityMatcherAdapter
protected static class	GridHubConfiguration.PrioritizerAdapter
protected static class	GridHubConfiguration.SimpleClassNameAdapter<T>

Field Summary

Fields

Modifier and Type	Field and Description
CapabilityMatcher	capabilityMatcher Capability matcher to use.
java.lang.Integer	cleanUpCycle Clean up cycle for remote proxies.
java.util.Map<java.lang.String,java.lang.String>	custom Custom key/value pairs for the hub registry.
static java.lang.String	DEFAULT_HUB_CONFIG_FILE
java.lang.String	host Hostname or IP to use.
java.lang.String	hubConfig Hub specific json config file to use.
java.lang.Integer	maxSession Max "browser" sessions a node can handle.
java.lang.Integer	newSessionWaitTimeout Timeout for new session requests.
Prioritizer	prioritizer Prioritizer for new honoring session requests based on some priority.
java.lang.String	registry
java.util.List<java.lang.String>	servlets Extra servlets to initialize/use on the hub or node.
java.lang.Boolean	throwOnCapabilityNotPresent Whether to throw an Exception when there are no capabilities available that match the request.
java.util.List<java.lang.String>	withoutServlets Default servlets to exclude on the hub or node.

Fields inherited from class org.openqa.grid.internal.utils.configuration.StandaloneConfiguration

browserTimeout, debug, DEFAULT_STANDALONE_CONFIG_FILE, help, jettyMaxThreads, log, port, role, timeout, version

Constructor Summary

Constructors

Constructor and Description
GridHubConfiguration() Creates a new configuration using the default values.

Method Summary

Modifier and Type	Method and Description
protected void	addJsonTypeAdapter(com.google.gson.GsonBuilder builder)
boolean	isWithOutServlet(java.lang.Class<? extends javax.servlet.Servlet> servlet)
static GridHubConfiguration	loadFromJSON(com.google.gson.JsonObject json)
static GridHubConfiguration	loadFromJSON(java.lang.String filePath)
void	merge(org.openqa.grid.internal.utils.configuration.GridConfiguration other) replaces this instance of configuration value with the 'other' value if it's set.
void	merge(GridHubConfiguration other) Merge this configuration with the specified GridHubConfiguration
void	merge(GridNodeConfiguration other) Merge this configuration with the specified GridNodeConfiguration
protected static void	staticAddJsonTypeAdapter(com.google.gson.GsonBuilder builder)
java.lang.String	toString(java.lang.String format)

Methods inherited from class org.openqa.grid.internal.utils.configuration.StandaloneConfiguration

isMergeAble, loadJSONFromResourceOrFile, merge, toJson, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HUB_CONFIG_FILE

public static final java.lang.String DEFAULT_HUB_CONFIG_FILE

See Also:

Constant Field Values

hubConfig

public java.lang.String hubConfig

Hub specific json config file to use. Defaults to null.

capabilityMatcher

@Expose
public CapabilityMatcher capabilityMatcher

Capability matcher to use. Defaults to DefaultCapabilityMatcher

newSessionWaitTimeout

@Expose
public java.lang.Integer newSessionWaitTimeout

Timeout for new session requests. Defaults to unlimited.

prioritizer

@Expose
public Prioritizer prioritizer

Prioritizer for new honoring session requests based on some priority. Defaults to null.

throwOnCapabilityNotPresent

@Expose
public java.lang.Boolean throwOnCapabilityNotPresent

Whether to throw an Exception when there are no capabilities available that match the request. Defaults to true.

registry

@Expose
public java.lang.String registry

cleanUpCycle

@Expose
public java.lang.Integer cleanUpCycle

Clean up cycle for remote proxies. Default determined by configuration type.

custom

@Expose
public java.util.Map<java.lang.String,java.lang.String> custom

Custom key/value pairs for the hub registry. Default empty.

host

@Expose
public java.lang.String host

Hostname or IP to use. Defaults to null. Automatically determined when null.

maxSession

@Expose
public java.lang.Integer maxSession

Max "browser" sessions a node can handle. Default determined by configuration type.

servlets

@Expose
public java.util.List<java.lang.String> servlets

Extra servlets to initialize/use on the hub or node. Default empty.

withoutServlets

@Expose
public java.util.List<java.lang.String> withoutServlets

Default servlets to exclude on the hub or node. Default empty.

Constructor Detail

GridHubConfiguration

public GridHubConfiguration()

Creates a new configuration using the default values.

Method Detail

loadFromJSON

public static GridHubConfiguration loadFromJSON(java.lang.String filePath)

Parameters:

filePath - hub config json file to load configuration from

loadFromJSON

public static GridHubConfiguration loadFromJSON(com.google.gson.JsonObject json)

Parameters:

json - JsonObject to load configuration from

merge

public void merge(GridNodeConfiguration other)

Merge this configuration with the specified GridNodeConfiguration

Parameters:

other -

merge

public void merge(GridHubConfiguration other)

Merge this configuration with the specified GridHubConfiguration

Parameters:

other -

toString

public java.lang.String toString(java.lang.String format)

addJsonTypeAdapter

protected void addJsonTypeAdapter(com.google.gson.GsonBuilder builder)

Overrides:

addJsonTypeAdapter in class StandaloneConfiguration

staticAddJsonTypeAdapter

protected static void staticAddJsonTypeAdapter(com.google.gson.GsonBuilder builder)

merge

public void merge(org.openqa.grid.internal.utils.configuration.GridConfiguration other)

replaces this instance of configuration value with the 'other' value if it's set.

Parameters:

other -

isWithOutServlet

public boolean isWithOutServlet(java.lang.Class<? extends javax.servlet.Servlet> servlet)

Parameters:

servlet - the Servlet to look for

Returns:

whether this configuration requests a 'default' servlet to be omitted