org.openqa.grid.common
Class RegistrationRequest

java.lang.Object
  org.openqa.grid.common.RegistrationRequest

public class RegistrationRequest
extends java.lang.Object

helper to register to the grid. Using JSON to exchange the object between the node and grid.

Field Summary

static java.lang.String	APP
static java.lang.String	AUTO_REGISTER
static java.lang.String	BROWSER
static java.lang.String	BROWSER_TIME_OUT
static java.lang.String	CLEAN_SNAPSHOT
static java.lang.String	CLEAN_UP_CYCLE
static java.lang.String	HOST
static java.lang.String	HUB_HOST
static java.lang.String	HUB_PORT
static java.lang.String	ID
static java.lang.String	MAX_INSTANCES
static java.lang.String	MAX_SESSION
static java.lang.String	MAX_TESTS_BEFORE_CLEAN
static java.lang.String	NODE_POLLING
static java.lang.String	PATH
static java.lang.String	PLATFORM
static java.lang.String	PORT
static java.lang.String	PROXY_CLASS
static java.lang.String	REGISTER_CYCLE
static java.lang.String	REMOTE_HOST
static java.lang.String	SELENIUM_PROTOCOL
static java.lang.String	SERVLETS
static java.lang.String	TIME_OUT
static java.lang.String	UNREGISTER_IF_STILL_DOWN_AFTER
static java.lang.String	VERSION

Constructor Summary

RegistrationRequest()

Method Summary

void	addDesiredCapability(DesiredCapabilities c)
void	addDesiredCapability(java.util.Map<java.lang.String,java.lang.Object> c)
static RegistrationRequest	build(java.lang.String... args)
java.lang.String[]	getArgs()
org.json.JSONObject	getAssociatedJSON()
java.util.List<DesiredCapabilities>	getCapabilities()
int	getConfigAsInt(java.lang.String param, int defaultValue)
java.lang.String	getConfigAsString(java.lang.String param)
java.util.Map<java.lang.String,java.lang.Object>	getConfiguration()
java.lang.String	getDescription()
java.lang.String	getId()
java.lang.String	getName()
static RegistrationRequest	getNewInstance(java.lang.String json) Create an object from a registration request formatted as a json string.
org.json.JSONObject	getRegistrationRequest()
RemoteControlConfiguration	getRemoteControlConfiguration()
java.lang.String	getRemoteProxyClass() if a PROXY_CLASS is specified in the request, the proxy created following this request will be of that type.
GridRole	getRole()
void	loadFromJSON(java.lang.String resource) add config, but overwrite capabilities.
static RegistrationRequest	localWebdriverNoCapabilities()
void	setCapabilities(java.util.List<DesiredCapabilities> capabilities)
void	setConfiguration(java.util.Map<java.lang.String,java.lang.Object> configuration)
void	setDescription(java.lang.String description)
void	setId(java.lang.String id)
void	setName(java.lang.String name)
void	setRole(GridRole role)
java.lang.String	toJSON()
void	validate() Validate the current setting and throw a config exception is an invalid setup is detected.

Methods inherited from class java.lang.Object

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

Field Detail

APP

public static final java.lang.String APP

See Also:

Constant Field Values

MAX_INSTANCES

public static final java.lang.String MAX_INSTANCES

See Also:

Constant Field Values

SELENIUM_PROTOCOL

public static final java.lang.String SELENIUM_PROTOCOL

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

BROWSER

public static final java.lang.String BROWSER

See Also:

Constant Field Values

PLATFORM

public static final java.lang.String PLATFORM

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

REGISTER_CYCLE

public static final java.lang.String REGISTER_CYCLE

See Also:

Constant Field Values

PROXY_CLASS

public static final java.lang.String PROXY_CLASS

See Also:

Constant Field Values

CLEAN_UP_CYCLE

public static final java.lang.String CLEAN_UP_CYCLE

See Also:

Constant Field Values

TIME_OUT

public static final java.lang.String TIME_OUT

See Also:

Constant Field Values

BROWSER_TIME_OUT

public static final java.lang.String BROWSER_TIME_OUT

See Also:

Constant Field Values

REMOTE_HOST

public static final java.lang.String REMOTE_HOST

See Also:

Constant Field Values

MAX_SESSION

public static final java.lang.String MAX_SESSION

See Also:

Constant Field Values

AUTO_REGISTER

public static final java.lang.String AUTO_REGISTER

See Also:

Constant Field Values

NODE_POLLING

public static final java.lang.String NODE_POLLING

See Also:

Constant Field Values

UNREGISTER_IF_STILL_DOWN_AFTER

public static final java.lang.String UNREGISTER_IF_STILL_DOWN_AFTER

See Also:

Constant Field Values

MAX_TESTS_BEFORE_CLEAN

public static final java.lang.String MAX_TESTS_BEFORE_CLEAN

See Also:

Constant Field Values

CLEAN_SNAPSHOT

public static final java.lang.String CLEAN_SNAPSHOT

See Also:

Constant Field Values

HOST

public static final java.lang.String HOST

See Also:

Constant Field Values

PORT

public static final java.lang.String PORT

See Also:

Constant Field Values

HUB_HOST

public static final java.lang.String HUB_HOST

See Also:

Constant Field Values

HUB_PORT

public static final java.lang.String HUB_PORT

See Also:

Constant Field Values

SERVLETS

public static final java.lang.String SERVLETS

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

RegistrationRequest

public RegistrationRequest()

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

getCapabilities

public java.util.List<DesiredCapabilities> getCapabilities()

addDesiredCapability

public void addDesiredCapability(DesiredCapabilities c)

addDesiredCapability

public void addDesiredCapability(java.util.Map<java.lang.String,java.lang.Object> c)

setCapabilities

public void setCapabilities(java.util.List<DesiredCapabilities> capabilities)

getConfiguration

public java.util.Map<java.lang.String,java.lang.Object> getConfiguration()

setConfiguration

public void setConfiguration(java.util.Map<java.lang.String,java.lang.Object> configuration)

toJSON

public java.lang.String toJSON()

getAssociatedJSON

public org.json.JSONObject getAssociatedJSON()

getConfigAsString

public java.lang.String getConfigAsString(java.lang.String param)

getConfigAsInt

public int getConfigAsInt(java.lang.String param,
                          int defaultValue)

getNewInstance

public static RegistrationRequest getNewInstance(java.lang.String json)

Create an object from a registration request formatted as a json string.

Parameters:

json -

Returns:

create a request from the JSON request received.

getRemoteProxyClass

public java.lang.String getRemoteProxyClass()

if a PROXY_CLASS is specified in the request, the proxy created following this request will be of that type. If nothing is specified, it will use RemoteProxy

Returns:

null if no class was specified.

localWebdriverNoCapabilities

public static RegistrationRequest localWebdriverNoCapabilities()

build

public static RegistrationRequest build(java.lang.String... args)

getRegistrationRequest

public org.json.JSONObject getRegistrationRequest()

loadFromJSON

public void loadFromJSON(java.lang.String resource)

add config, but overwrite capabilities.

Parameters:

resource -

getRole

public GridRole getRole()

setRole

public void setRole(GridRole role)

getRemoteControlConfiguration

public RemoteControlConfiguration getRemoteControlConfiguration()

getArgs

public java.lang.String[] getArgs()

validate

public void validate()
              throws GridConfigurationException

Validate the current setting and throw a config exception is an invalid setup is detected.

Throws:

GridConfigurationException