Class RedisBackedDistributor

java.lang.Object

org.openqa.selenium.grid.distributor.Distributor

org.openqa.selenium.grid.distributor.redis.RedisBackedDistributor

All Implemented Interfaces:

Closeable, AutoCloseable, Predicate<HttpRequest>, HttpHandler, Routable, HasReadyState

public class RedisBackedDistributor
extends Distributor
implements Closeable

Stateless, horizontally-scalable implementation of Distributor backed by Redis.

All grid model state (node registry, slot reservations, health counts) is stored in Redis via RedisBackedNodeRegistry and RedisBackedGridModel. Multiple replicas of this class can safely run concurrently against the same Redis instance; slot reservation uses atomic SET NX to prevent double-allocation.

Configure via:

[distributor]
implementation = "org.openqa.selenium.grid.distributor.redis.RedisBackedDistributor"
redis-url = "redis://redis-service:6379"

Constructor Summary

Constructors

Constructor	Description
RedisBackedDistributor(Tracer tracer, EventBus bus, HttpClient.Factory clientFactory, SessionMap sessions, NewSessionQueue sessionQueue, SlotSelector slotSelector, Secret registrationSecret, Duration healthcheckInterval, boolean rejectUnsupportedCaps, Duration sessionRequestRetryInterval, int newSessionThreadPoolSize, SlotMatcher slotMatcher, Duration purgeNodesInterval, URI redisUri)

Method Summary

Modifier and Type	Method	Description
RedisBackedDistributor	add(Node node)
void	close()
static Distributor	create(Config config)
boolean	drain(NodeId nodeId)
int	getActiveSlots()
protected Set<NodeStatus>	getAvailableNodes()
long	getDownNodeCount()
int	getIdleSlots()
protected @Nullable Node	getNodeFromURI(URI uri)
DistributorStatus	getStatus()
long	getUpNodeCount()
boolean	isReady()
Either<SessionNotCreatedException, CreateSessionResponse>	newSession(SessionRequest request)
void	refresh()
void	remove(NodeId nodeId)

Methods inherited from class Distributor

execute, matches, test

Methods inherited from class Object

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

Methods inherited from interface Predicate

and, negate, or

Methods inherited from interface Routable

with

Constructor Details

RedisBackedDistributor

public RedisBackedDistributor(Tracer tracer,
 EventBus bus,
 HttpClient.Factory clientFactory,
 SessionMap sessions,
 NewSessionQueue sessionQueue,
 SlotSelector slotSelector,
 Secret registrationSecret,
 Duration healthcheckInterval,
 boolean rejectUnsupportedCaps,
 Duration sessionRequestRetryInterval,
 int newSessionThreadPoolSize,
 SlotMatcher slotMatcher,
 Duration purgeNodesInterval,
 URI redisUri)

Method Details

create

public static Distributor create(Config config)

isReady

public boolean isReady()

Specified by:

isReady in interface HasReadyState

add

public RedisBackedDistributor add(Node node)

Specified by:

add in class Distributor

drain

public boolean drain(NodeId nodeId)

Specified by:

drain in class Distributor

remove

public void remove(NodeId nodeId)

Specified by:

remove in class Distributor

getStatus

public DistributorStatus getStatus()

Specified by:

getStatus in class Distributor

refresh

@Beta
public void refresh()

getAvailableNodes

protected Set<NodeStatus> getAvailableNodes()

newSession

public Either<SessionNotCreatedException, CreateSessionResponse> newSession(SessionRequest request)
                                                                     throws SessionNotCreatedException

Specified by:

newSession in class Distributor

Throws:

SessionNotCreatedException

getUpNodeCount

public long getUpNodeCount()

getDownNodeCount

public long getDownNodeCount()

getActiveSlots

public int getActiveSlots()

getIdleSlots

public int getIdleSlots()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getNodeFromURI

protected @Nullable Node getNodeFromURI(URI uri)