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

Fields

Modifier and Type	Field and Description
private java.util.List<org.openqa.selenium.remote.DesiredCapabilities>	capabilities
private GridNodeConfiguration	configuration
private java.lang.String	description
static java.lang.String	MAX_INSTANCES
private java.lang.String	name
static java.lang.String	PATH
private GridRole	role
static java.lang.String	SELENIUM_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
RegistrationRequest()

Method Summary

Modifier and Type	Method and Description
void	addDesiredCapability(org.openqa.selenium.remote.DesiredCapabilities c)
void	addDesiredCapability(java.util.Map<java.lang.String,java.lang.Object> c)
private void	addPlatformInfoToCapabilities()
static RegistrationRequest	build(GridNodeConfiguration configuration)
com.google.gson.JsonObject	getAssociatedJSON()
java.util.List<org.openqa.selenium.remote.DesiredCapabilities>	getCapabilities()
GridNodeConfiguration	getConfiguration()
java.lang.String	getDescription()
java.lang.String	getName()
static RegistrationRequest	getNewInstance(java.lang.String json) Create an object from a registration request formatted as a json string.
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()
private static java.lang.String	guessHost(java.lang.String host)
void	loadFromJSON(java.lang.String resource) add config, but overwrite capabilities.
static RegistrationRequest	newFromJSON(java.lang.String resource)
void	setCapabilities(java.util.List<org.openqa.selenium.remote.DesiredCapabilities> capabilities)
void	setConfiguration(GridNodeConfiguration configuration)
void	setDescription(java.lang.String description)
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

name

private java.lang.String name

description

private java.lang.String description

role

private GridRole role

capabilities

private java.util.List<org.openqa.selenium.remote.DesiredCapabilities> capabilities

configuration

private GridNodeConfiguration configuration

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

Constructor Detail

RegistrationRequest

public RegistrationRequest()

Method Detail

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<org.openqa.selenium.remote.DesiredCapabilities> getCapabilities()

addDesiredCapability

public void addDesiredCapability(org.openqa.selenium.remote.DesiredCapabilities c)

addDesiredCapability

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

setCapabilities

public void setCapabilities(java.util.List<org.openqa.selenium.remote.DesiredCapabilities> capabilities)

getConfiguration

public GridNodeConfiguration getConfiguration()

setConfiguration

public void setConfiguration(GridNodeConfiguration configuration)

toJSON

public java.lang.String toJSON()

getAssociatedJSON

public com.google.gson.JsonObject getAssociatedJSON()

getNewInstance

public static RegistrationRequest getNewInstance(java.lang.String json)
                                          throws com.google.gson.JsonSyntaxException

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

Parameters:

json - JSON

Returns:

create a request from the JSON request received.

Throws:

com.google.gson.JsonSyntaxException

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.

build

public static RegistrationRequest build(GridNodeConfiguration configuration)

addPlatformInfoToCapabilities

private void addPlatformInfoToCapabilities()

guessHost

private static java.lang.String guessHost(java.lang.String host)

loadFromJSON

public void loadFromJSON(java.lang.String resource)

add config, but overwrite capabilities.

Parameters:

resource - resource

newFromJSON

public static RegistrationRequest newFromJSON(java.lang.String resource)

getRole

public GridRole getRole()

setRole

public void setRole(GridRole role)

validate

public void validate()
              throws GridConfigurationException

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

Throws:

GridConfigurationException - grid configuration