org.openqa.grid.internal.utils.configuration

Class GridNodeConfiguration

java.lang.Object

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

org.openqa.grid.internal.utils.configuration.GridNodeConfiguration

public class GridNodeConfiguration
extends StandaloneConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GridNodeConfiguration.CollectionOfDesiredCapabilitiesDeSerializer
static class	GridNodeConfiguration.CollectionOfDesiredCapabilitiesSerializer

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<org.openqa.selenium.MutableCapabilities>	capabilities The capabilties of this node.
java.lang.Integer	cleanUpCycle Clean up cycle for remote proxies.
static java.lang.String	CONFIG_UUID_CAPABILITY
java.util.Map<java.lang.String,java.lang.String>	custom Custom key/value pairs for the hub registry.
static java.lang.String	DEFAULT_NODE_CONFIG_FILE
java.lang.Integer	downPollingLimit The down polling limit for the node.
java.lang.String	host Hostname or IP to use.
java.lang.String	hub The hub url.
java.lang.String	id The id tu use for this node.
java.lang.Integer	maxSession Max "browser" sessions a node can handle.
java.lang.String	nodeConfigFile Node specific json config file to use.
java.lang.Integer	nodePolling How often to pull the node.
java.lang.Integer	nodeStatusCheckTimeout When to time out a node status check.
java.lang.String	proxy The proxy class name to use.
java.lang.Boolean	register Whether to register this node with the hub.
java.lang.Integer	registerCycle How often to re-register this node with the hub.
java.util.List<java.lang.String>	servlets Extra servlets to initialize/use on the hub or node.
java.lang.Integer	unregisterIfStillDownAfter How long to wait before marking this node down.
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, enablePassThrough, help, jettyMaxThreads, log, port, role, timeout, version

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addJsonTypeAdapter(com.google.gson.GsonBuilder builder)
void	fixUpCapabilities()
void	fixUpHost()
java.lang.String	getHubHost()
java.lang.Integer	getHubPort()
java.lang.String	getRemoteHost()
boolean	isWithOutServlet(java.lang.Class<? extends javax.servlet.Servlet> servlet)
static GridNodeConfiguration	loadFromJSON(com.google.gson.JsonObject json)
static GridNodeConfiguration	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(GridNodeConfiguration other)
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, merge, toJson, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NODE_CONFIG_FILE

public static final java.lang.String DEFAULT_NODE_CONFIG_FILE

See Also:

Constant Field Values

CONFIG_UUID_CAPABILITY

public static final java.lang.String CONFIG_UUID_CAPABILITY

See Also:

Constant Field Values

nodeConfigFile

public java.lang.String nodeConfigFile

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

id

@Expose
public java.lang.String id

The id tu use for this node. Automatically generated when null. Defaults to null.

capabilities

@Expose
public java.util.List<org.openqa.selenium.MutableCapabilities> capabilities

The capabilties of this node. Defaults from the capabilities specified in the DEFAULT_NODE_CONFIG_FILE or an empty list if the DEFAULT_NODE_CONFIG_FILE can not be loaded.

downPollingLimit

@Expose
public java.lang.Integer downPollingLimit

The down polling limit for the node. Defaults to null.

hub

@Expose
public java.lang.String hub

The hub url. Defaults to http://localhost:4444.

nodePolling

@Expose
public java.lang.Integer nodePolling

How often to pull the node. Defaults to 5000 ms

nodeStatusCheckTimeout

@Expose
public java.lang.Integer nodeStatusCheckTimeout

When to time out a node status check. Defaults is after 5000 ms.

proxy

@Expose
public java.lang.String proxy

The proxy class name to use. Defaults to org.openqa.grid.selenium.proxy.DefaultRemoteProxy.

register

@Expose
public java.lang.Boolean register

Whether to register this node with the hub. Defaults to true

registerCycle

@Expose
public java.lang.Integer registerCycle

How often to re-register this node with the hub. Defaults to every 5000 ms.

unregisterIfStillDownAfter

@Expose
public java.lang.Integer unregisterIfStillDownAfter

How long to wait before marking this node down. Defaults is 60000 ms.

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

GridNodeConfiguration

public GridNodeConfiguration()

Creates a new configuration using the default values.

Method Detail

getHubHost

public java.lang.String getHubHost()

getHubPort

public java.lang.Integer getHubPort()

getRemoteHost

public java.lang.String getRemoteHost()

merge

public void merge(GridNodeConfiguration other)

toString

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

loadFromJSON

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

Parameters:

filePath - node config json file to load configuration from

loadFromJSON

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

Parameters:

json - JsonObject to load configuration from

addJsonTypeAdapter

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

Overrides:

addJsonTypeAdapter in class StandaloneConfiguration

staticAddJsonTypeAdapter

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

fixUpCapabilities

public void fixUpCapabilities()

fixUpHost

public void fixUpHost()

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