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
private java.lang.String	clazz
private GridNodeConfiguration	configuration
private java.lang.String	description
static java.lang.String	MAX_INSTANCES
private java.lang.String	name
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(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.
private void	fixUpCapabilities()
private void	fixUpHost()
static RegistrationRequest	fromJson(com.google.gson.JsonObject json) Create an object from a registration request formatted as a JsonObject
static RegistrationRequest	fromJson(java.lang.String json) Create an object from a registration request formatted as a json string.
GridNodeConfiguration	getConfiguration()
java.lang.String	getDescription()
java.lang.String	getName()
com.google.gson.JsonObject	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

clazz

private final java.lang.String clazz

name

private java.lang.String name

description

private java.lang.String description

configuration

private GridNodeConfiguration configuration

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

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

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

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 com.google.gson.JsonObject toJson()

fromJson

public static RegistrationRequest fromJson(com.google.gson.JsonObject json)
                                    throws com.google.gson.JsonSyntaxException

Create an object from a registration request formatted as a JsonObject

Parameters:

json - JsonObject

Returns:

Throws:

com.google.gson.JsonSyntaxException

fromJson

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

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

Parameters:

json - JSON String

Returns:

Throws:

com.google.gson.JsonSyntaxException

build

public static RegistrationRequest build(GridNodeConfiguration configuration)

Build a RegistrationRequest from the provided GridNodeConfiguration. This is different than new RegistrationRequest(GridNodeConfiguration) because it will merge the provided configuration onto the GridNodeConfiguration.DEFAULT_NODE_CONFIG_FILE and then "fixup" the resulting RegistrationRequest before returning the result

Parameters:

configuration - the GridNodeConfiguration to use

Returns:

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 merge the provided configuration onto the GridNodeConfiguration.DEFAULT_NODE_CONFIG_FILE and then "fixup" the resulting RegistrationRequest before returning the result

Parameters:

configuration - the GridNodeConfiguration to use

name - the name for the remote

Returns:

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 merge the provided configuration onto the GridNodeConfiguration.DEFAULT_NODE_CONFIG_FILE and then "fixup" the resulting RegistrationRequest before returning the result

Parameters:

configuration - the GridNodeConfiguration to use

name - the name for the remote

description - the description for the remote host

Returns:

fixUpCapabilities

private void fixUpCapabilities()

fixUpHost

private void fixUpHost()

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