Class Node

java.lang.Object

org.openqa.selenium.grid.node.Node

All Implemented Interfaces:

HttpHandler, Routable, HasReadyState

Direct Known Subclasses:

LocalNode, RemoteNode

public abstract class Node
extends Object
implements HasReadyState, Routable

A place where individual webdriver sessions are running. Those sessions may be in-memory, or only reachable via localhost and a network. Or they could be something else entirely.

This class responds to the following URLs:

Verb	URL Template	Meaning
POST	/se/grid/node/session	Attempts to start a new session for the given node. The posted data should be a json-serialized Capabilities instance. Returns a serialized Session. Subclasses of Node are expected to register the session with the SessionMap.
GET	/se/grid/node/session/{sessionId}	Finds the Session identified by sessionId and returns the JSON-serialized form.
DELETE	/se/grid/node/session/{sessionId}	Stops the Session identified by sessionId. It is expected that this will also cause the session to removed from the SessionMap.
GET	/se/grid/node/owner/{sessionId}	Allows the node to be queried about whether or not it owns the Session identified by sessionId. This returns a boolean.
DELETE	/se/grid/node/connection/{sessionId}	Notifies the node about closure of a websocket connection for the Session identified by sessionId.
POST	/se/grid/node/connection/{sessionId}	Allows the node to be ask about whether or not new websocket connections are allowed for the Session identified by sessionId. This returns a boolean.
*	/session/{sessionId}/*	The request is forwarded to the Session identified by sessionId. When the Quit command is called, the Session should remove itself from the SessionMap.

Field Summary

Fields

Modifier and Type	Field	Description
protected final AtomicBoolean	draining
protected final AtomicBoolean	registered
protected final Tracer	tracer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Node(Tracer tracer, NodeId id, URI uri, Secret registrationSecret, Duration sessionTimeout)

Method Summary

Modifier and Type	Method	Description
abstract @Nullable HttpResponse	downloadFile(HttpRequest req, SessionId id)
abstract void	drain()
HttpResponse	execute(HttpRequest req)
abstract HttpResponse	executeWebDriverCommand(HttpRequest req)
HttpResponse	fireSessionEvent(HttpRequest req, SessionId id)	Fires a custom session event to the remote server event bus.
TemporaryFilesystem	getDownloadsFilesystem(SessionId id)
abstract HealthCheck	getHealthCheck()
NodeId	getId()
String	getNodeVersion()
Map<String,String>	getOsInfo()
abstract Session	getSession(SessionId id)
Duration	getSessionTimeout()
abstract NodeStatus	getStatus()
TemporaryFilesystem	getUploadsFilesystem(SessionId id)
URI	getUri()
boolean	isDraining()
boolean	isRegistered()
abstract boolean	isSessionOwner(SessionId id)
abstract boolean	isSupporting(Capabilities capabilities)
boolean	matches(HttpRequest req)
abstract Either<WebDriverException, CreateSessionResponse>	newSession(CreateSessionRequest sessionRequest)
void	register()
abstract void	releaseConnection(SessionId id)
abstract void	stop(SessionId id)
abstract boolean	tryAcquireConnection(SessionId id)
abstract @Nullable HttpResponse	uploadFile(HttpRequest req, SessionId id)

Methods inherited from class Object

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

Methods inherited from interface HasReadyState

isReady

Methods inherited from interface Routable

with

Field Details

tracer

protected final Tracer tracer

draining

protected final AtomicBoolean draining

registered

protected final AtomicBoolean registered

Constructor Details

Node

protected Node(Tracer tracer,
 NodeId id,
 URI uri,
 Secret registrationSecret,
 Duration sessionTimeout)

Method Details

getId

public NodeId getId()

getUri

public URI getUri()

getNodeVersion

public String getNodeVersion()

getOsInfo

public Map<String,String> getOsInfo()

newSession

public abstract Either<WebDriverException, CreateSessionResponse> newSession(CreateSessionRequest sessionRequest)

executeWebDriverCommand

public abstract HttpResponse executeWebDriverCommand(HttpRequest req)

getSession

public abstract Session getSession(SessionId id)
                            throws NoSuchSessionException

Throws:

NoSuchSessionException

getUploadsFilesystem

public TemporaryFilesystem getUploadsFilesystem(SessionId id)
                                         throws IOException

Throws:

IOException

getDownloadsFilesystem

public TemporaryFilesystem getDownloadsFilesystem(SessionId id)
                                           throws IOException

Throws:

IOException

uploadFile

public abstract @Nullable HttpResponse uploadFile(HttpRequest req,
 SessionId id)

downloadFile

public abstract @Nullable HttpResponse downloadFile(HttpRequest req,
 SessionId id)

fireSessionEvent

public HttpResponse fireSessionEvent(HttpRequest req,
 SessionId id)

Fires a custom session event to the remote server event bus. This allows test code to trigger server-side utilities that subscribe to the event bus.

Default implementation throws UnsupportedOperationException. Subclasses that support session events should override this method.

Parameters:

req - the HTTP request containing the event data

id - the session ID

Returns:

the HTTP response

stop

public abstract void stop(SessionId id)
                   throws NoSuchSessionException

Throws:

NoSuchSessionException

isSessionOwner

public abstract boolean isSessionOwner(SessionId id)

tryAcquireConnection

public abstract boolean tryAcquireConnection(SessionId id)

releaseConnection

public abstract void releaseConnection(SessionId id)

isSupporting

public abstract boolean isSupporting(Capabilities capabilities)

getStatus

public abstract NodeStatus getStatus()

getHealthCheck

public abstract HealthCheck getHealthCheck()

getSessionTimeout

public Duration getSessionTimeout()

isDraining

public boolean isDraining()

isRegistered

public boolean isRegistered()

register

public void register()

drain

public abstract void drain()

matches

public boolean matches(HttpRequest req)

Specified by:

matches in interface Routable

execute

public HttpResponse execute(HttpRequest req)

Specified by:

execute in interface HttpHandler