Class LocalNode

java.lang.Object

org.openqa.selenium.grid.node.Node

org.openqa.selenium.grid.node.local.LocalNode

All Implemented Interfaces:

Closeable, AutoCloseable, HttpHandler, Routable, HasReadyState

public class LocalNode
extends Node
implements Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalNode.Builder

Field Summary

Fields inherited from class Node

draining, registered, tracer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LocalNode(Tracer tracer, EventBus bus, URI uri, URI gridUri, @Nullable HealthCheck healthCheck, int maxSessionCount, int drainAfterSessionCount, boolean cdpEnabled, boolean bidiEnabled, com.github.benmanes.caffeine.cache.Ticker ticker, Duration sessionTimeout, Duration heartbeatPeriod, List<SessionSlot> factories, Secret registrationSecret, boolean managedDownloadsEnabled, int connectionLimitPerSession, int nodeDownFailureThreshold, List<NodeCommandInterceptor> interceptors)

Method Summary

Modifier and Type	Method	Description
static LocalNode.Builder	builder(Tracer tracer, EventBus bus, URI uri, URI gridUri, Secret registrationSecret)
void	close()
HttpResponse	downloadFile(HttpRequest req, SessionId id)
void	drain()
HttpResponse	executeWebDriverCommand(HttpRequest req)
HttpResponse	fireSessionEvent(HttpRequest req, SessionId id)	Fires a custom session event to the remote server event bus.
Availability	getAvailability()
int	getConsecutiveSessionFailures()
int	getCurrentSessionCount()
TemporaryFilesystem	getDownloadsFilesystem(SessionId sessionId)
URI	getExternalUri()
URI	getGridUri()
HealthCheck	getHealthCheck()
float	getLoad()
int	getMaxSessionCount()
String	getNodeId()
Session	getSession(SessionId id)
NodeStatus	getStatus()
int	getTotalSlots()
TemporaryFilesystem	getUploadsFilesystem(SessionId id)
long	getUsedSlots()
boolean	isReady()
boolean	isSessionOwner(SessionId id)
boolean	isSupporting(Capabilities capabilities)
Either<WebDriverException, CreateSessionResponse>	newSession(CreateSessionRequest sessionRequest)
void	releaseConnection(SessionId id)
void	resetConsecutiveSessionFailures()	Resets the consecutive session creation failure counter.
void	stop(SessionId id)
boolean	tryAcquireConnection(SessionId id)
HttpResponse	uploadFile(HttpRequest req, SessionId id)

Methods inherited from class Node

execute, getId, getNodeVersion, getOsInfo, getSessionTimeout, getUri, isDraining, isRegistered, matches, register

Methods inherited from class Object

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

Methods inherited from interface Routable

with

Constructor Details

LocalNode

protected LocalNode(Tracer tracer,
 EventBus bus,
 URI uri,
 URI gridUri,
 @Nullable HealthCheck healthCheck,
 int maxSessionCount,
 int drainAfterSessionCount,
 boolean cdpEnabled,
 boolean bidiEnabled,
 com.github.benmanes.caffeine.cache.Ticker ticker,
 Duration sessionTimeout,
 Duration heartbeatPeriod,
 List<SessionSlot> factories,
 Secret registrationSecret,
 boolean managedDownloadsEnabled,
 int connectionLimitPerSession,
 int nodeDownFailureThreshold,
 List<NodeCommandInterceptor> interceptors)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

builder

public static LocalNode.Builder builder(Tracer tracer,
 EventBus bus,
 URI uri,
 URI gridUri,
 Secret registrationSecret)

isReady

public boolean isReady()

Specified by:

isReady in interface HasReadyState

getCurrentSessionCount

public int getCurrentSessionCount()

getMaxSessionCount

public int getMaxSessionCount()

getAvailability

public Availability getAvailability()

getTotalSlots

public int getTotalSlots()

getUsedSlots

public long getUsedSlots()

getLoad

public float getLoad()

getConsecutiveSessionFailures

public int getConsecutiveSessionFailures()

resetConsecutiveSessionFailures

public void resetConsecutiveSessionFailures()

Resets the consecutive session creation failure counter. This can be used to recover a node that was marked as DOWN due to exceeding the failure threshold, for example after external intervention has resolved the underlying issue.

getExternalUri

public URI getExternalUri()

getGridUri

public URI getGridUri()

getNodeId

public String getNodeId()

isSupporting

public boolean isSupporting(Capabilities capabilities)

Specified by:

isSupporting in class Node

newSession

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

Specified by:

newSession in class Node

isSessionOwner

public boolean isSessionOwner(SessionId id)

Specified by:

isSessionOwner in class Node

tryAcquireConnection

public boolean tryAcquireConnection(SessionId id)
                             throws NoSuchSessionException

Specified by:

tryAcquireConnection in class Node

Throws:

NoSuchSessionException

releaseConnection

public void releaseConnection(SessionId id)

Specified by:

releaseConnection in class Node

getSession

public Session getSession(SessionId id)
                   throws NoSuchSessionException

Specified by:

getSession in class Node

Throws:

NoSuchSessionException

getUploadsFilesystem

public TemporaryFilesystem getUploadsFilesystem(SessionId id)
                                         throws IOException

Overrides:

getUploadsFilesystem in class Node

Throws:

IOException

getDownloadsFilesystem

public TemporaryFilesystem getDownloadsFilesystem(SessionId sessionId)

Overrides:

getDownloadsFilesystem in class Node

executeWebDriverCommand

public HttpResponse executeWebDriverCommand(HttpRequest req)

Specified by:

executeWebDriverCommand in class Node

downloadFile

public HttpResponse downloadFile(HttpRequest req,
 SessionId id)

Specified by:

downloadFile in class Node

uploadFile

public HttpResponse uploadFile(HttpRequest req,
 SessionId id)

Specified by:

uploadFile in class Node

fireSessionEvent

public HttpResponse fireSessionEvent(HttpRequest req,
 SessionId id)

Description copied from class: Node

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.

Overrides:

fireSessionEvent in class Node

Parameters:

req - the HTTP request containing the event data

id - the session ID

Returns:

the HTTP response

stop

public void stop(SessionId id)
          throws NoSuchSessionException

Specified by:

stop in class Node

Throws:

NoSuchSessionException

getStatus

public NodeStatus getStatus()

Specified by:

getStatus in class Node

getHealthCheck

public HealthCheck getHealthCheck()

Specified by:

getHealthCheck in class Node

drain

public void drain()

Specified by:

drain in class Node