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 the hub.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MAX_INSTANCES
static java.lang.String	PATH
static java.lang.String	SELENIUM_PROTOCOL

Constructor Summary

Constructors

Constructor and Description
RegistrationRequest() Create a new registration request using the default values of a GridNodeConfiguration
RegistrationRequest(GridNodeConfiguration configuration) Create a new registration request using the supplied GridNodeConfiguration
RegistrationRequest(GridNodeConfiguration configuration, java.lang.String name) Create a new registration request using the supplied GridNodeConfiguration, and name
RegistrationRequest(GridNodeConfiguration configuration, java.lang.String name, java.lang.String description) Create a new registration request using the supplied GridNodeConfiguration, name, and description

Method Summary

Modifier and Type	Method and Description
static RegistrationRequest	build() Build a RegistrationRequest.
static RegistrationRequest	build(GridNodeConfiguration configuration) Build a RegistrationRequest from the provided GridNodeConfiguration.
static RegistrationRequest	build(GridNodeConfiguration configuration, java.lang.String name) Build a RegistrationRequest from the provided GridNodeConfiguration, use the provided name.
static RegistrationRequest	build(GridNodeConfiguration configuration, java.lang.String name, java.lang.String description) Build a RegistrationRequest from the provided GridNodeConfiguration, use the provided name and description.
static RegistrationRequest	fromJson(java.lang.String jsonString) Create an object from a registration request formatted as a json string.
GridNodeConfiguration	getConfiguration()
java.lang.String	getDescription()
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.Object>	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

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()

Create a new registration request using the default values of a GridNodeConfiguration

RegistrationRequest

public RegistrationRequest(GridNodeConfiguration configuration)

Create a new registration request using the supplied GridNodeConfiguration

Parameters:

configuration - the GridNodeConfiguration to use. Internally calls new GridNodeConfiguration() if a null value is provided since a request without configuration is not valid.

RegistrationRequest

public RegistrationRequest(GridNodeConfiguration configuration,
                           java.lang.String name)

Create a new registration request using the supplied GridNodeConfiguration, and name

Parameters:

configuration - the GridNodeConfiguration to use. Internally calls new GridNodeConfiguration() if a null value is provided since a request without configuration is not valid.

name - the name for the remote

RegistrationRequest

public RegistrationRequest(GridNodeConfiguration configuration,
                           java.lang.String name,
                           java.lang.String description)

Create a new registration request using the supplied GridNodeConfiguration, name, and description

Parameters:

configuration - the GridNodeConfiguration to use. Internally calls new GridNodeConfiguration() if a null value is provided since a request without configuration is not valid.

name - the name for the remote

description - the description for the remote host

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getConfiguration

public GridNodeConfiguration getConfiguration()

toJson

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

fromJson

public static RegistrationRequest fromJson(java.lang.String jsonString)
                                    throws org.openqa.selenium.json.JsonException

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

Throws:

org.openqa.selenium.json.JsonException

build

public static RegistrationRequest build()

Build a RegistrationRequest.

build

public static RegistrationRequest build(GridNodeConfiguration configuration)

Build a RegistrationRequest from the provided GridNodeConfiguration. This is different than new RegistrationRequest(GridNodeConfiguration) because it will first load any specified GridNodeConfiguration.nodeConfigFile and then merge the provided configuration onto it.

Parameters:

configuration - the GridNodeConfiguration to use. Internally calls new GridNodeConfiguration() if a null value is provided since a request without configuration is not valid.

build

public static RegistrationRequest build(GridNodeConfiguration configuration,
                                        java.lang.String name)

Build a RegistrationRequest from the provided GridNodeConfiguration, use the provided name. This is different than new RegistrationRequest(GridNodeConfiguration, String) because it will first load any specified GridNodeConfiguration.nodeConfigFile and then merge the provided configuration onto it.

Parameters:

configuration - the GridNodeConfiguration to use. Internally calls new GridNodeConfiguration() if a null value is provided since a request without configuration is not valid.

name - the name for the remote

build

public static RegistrationRequest build(GridNodeConfiguration configuration,
                                        java.lang.String name,
                                        java.lang.String description)

Build a RegistrationRequest from the provided GridNodeConfiguration, use the provided name and description. This is different than new RegistrationRequest(GridNodeConfiguration, String, String) because it will first load any specified GridNodeConfiguration.nodeConfigFile and then merge the provided configuration onto it.

Parameters:

configuration - the GridNodeConfiguration to use. Internally calls new GridNodeConfiguration() if a null value is provided since a request without configuration is not valid.

name - the name for the remote

description - the description for the remote host

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