Package org.openqa.selenium.grid.sessionqueue.local

Class LocalNewSessionQueue

java.lang.Object

org.openqa.selenium.grid.sessionqueue.NewSessionQueue

org.openqa.selenium.grid.sessionqueue.local.LocalNewSessionQueue

All Implemented Interfaces:

Closeable, AutoCloseable, HttpHandler, Routable, HasReadyState

public class LocalNewSessionQueue
extends NewSessionQueue
implements Closeable

An in-memory implementation of the list of new session requests.

The lifecycle of a request can be described as:

1. User adds an item on to the queue using addToQueue(SessionRequest). This will block until the request completes in some way.
2. If the session request is completed, then complete(RequestId, Either) must be called. This will ensure that addToQueue(SessionRequest) returns.
3. If the request cannot be handled right now, call retryAddToQueue(SessionRequest) to return the session request to the front of the queue.

There is a background thread that will reap SessionRequests that have timed out. This means that a request can either complete by a listener calling complete(RequestId, Either) directly, or by being reaped by the thread.

Field Summary

Fields inherited from class org.openqa.selenium.grid.sessionqueue.NewSessionQueue

tracer

Constructor Summary

Constructors

Constructor	Description
LocalNewSessionQueue(Tracer tracer, SlotMatcher slotMatcher, Duration requestTimeoutCheck, Duration requestTimeout, Secret registrationSecret, int batchSize)

Method Summary

Modifier and Type	Method	Description
HttpResponse	addToQueue(SessionRequest request)
int	clearQueue()
void	close()
boolean	complete(RequestId reqId, Either<SessionNotCreatedException,CreateSessionResponse> result)	Returns true if the session is still valid (not timed out)
static NewSessionQueue	create(Config config)
List<SessionRequest>	getNextAvailable(Map<Capabilities,Long> stereotypes)
List<SessionRequestCapability>	getQueueContents()
int	getQueueSize()
boolean	isReady()
boolean	peekEmpty()	A fast-path to detect if the queue is empty, returns false if there is no fast-path available.
Optional<SessionRequest>	remove(RequestId reqId)
boolean	retryAddToQueue(SessionRequest request)

Methods inherited from class org.openqa.selenium.grid.sessionqueue.NewSessionQueue

execute, matches

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.selenium.remote.http.Routable

with

Constructor Details

LocalNewSessionQueue

public LocalNewSessionQueue(Tracer tracer,
 SlotMatcher slotMatcher,
 Duration requestTimeoutCheck,
 Duration requestTimeout,
 Secret registrationSecret,
 int batchSize)

Method Details

create

public static NewSessionQueue create(Config config)

peekEmpty

public boolean peekEmpty()

Description copied from class: NewSessionQueue

A fast-path to detect if the queue is empty, returns false if there is no fast-path available.

Specified by:

peekEmpty in class NewSessionQueue

Returns:

true if the queue is empty, false if it is not empty or unknown

addToQueue

public HttpResponse addToQueue(SessionRequest request)

Specified by:

addToQueue in class NewSessionQueue

retryAddToQueue

public boolean retryAddToQueue(SessionRequest request)

Specified by:

retryAddToQueue in class NewSessionQueue

remove

public Optional<SessionRequest> remove(RequestId reqId)

Specified by:

remove in class NewSessionQueue

getNextAvailable

public List<SessionRequest> getNextAvailable(Map<Capabilities,Long> stereotypes)

Specified by:

getNextAvailable in class NewSessionQueue

complete

public boolean complete(RequestId reqId,
 Either<SessionNotCreatedException,CreateSessionResponse> result)

Returns true if the session is still valid (not timed out)

Specified by:

complete in class NewSessionQueue

clearQueue

public int clearQueue()

Specified by:

clearQueue in class NewSessionQueue

getQueueContents

public List<SessionRequestCapability> getQueueContents()

Specified by:

getQueueContents in class NewSessionQueue

getQueueSize

public int getQueueSize()

isReady

public boolean isReady()

Specified by:

isReady in interface HasReadyState

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException