Package org.openqa.selenium.grid.sessionqueue

Class NewSessionQueue

java.lang.Object

org.openqa.selenium.grid.sessionqueue.NewSessionQueue

All Implemented Interfaces:

HttpHandler, Routable, HasReadyState

Direct Known Subclasses:

LocalNewSessionQueue, RemoteNewSessionQueue

public abstract class NewSessionQueue
extends Object
implements HasReadyState, Routable

Field Summary

Fields

Modifier and Type	Field	Description
protected final Tracer	tracer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NewSessionQueue(Tracer tracer, Secret registrationSecret)

Method Summary

Modifier and Type	Method	Description
abstract HttpResponse	addToQueue(SessionRequest request)
abstract int	clearQueue()
abstract boolean	complete(RequestId reqId, Either<SessionNotCreatedException,CreateSessionResponse> result)
HttpResponse	execute(HttpRequest req)
abstract List<SessionRequest>	getNextAvailable(Map<Capabilities,Long> stereotypes)
abstract List<SessionRequestCapability>	getQueueContents()
boolean	matches(HttpRequest req)
abstract boolean	peekEmpty()	A fast-path to detect if the queue is empty, returns false if there is no fast-path available.
abstract Optional<SessionRequest>	remove(RequestId reqId)
abstract boolean	retryAddToQueue(SessionRequest request)

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.status.HasReadyState

isReady

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

with

Field Details

tracer

protected final Tracer tracer

Constructor Details

NewSessionQueue

protected NewSessionQueue(Tracer tracer,
 Secret registrationSecret)

Method Details

peekEmpty

public abstract boolean peekEmpty()

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

Returns:

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

addToQueue

public abstract HttpResponse addToQueue(SessionRequest request)

retryAddToQueue

public abstract boolean retryAddToQueue(SessionRequest request)

remove

public abstract Optional<SessionRequest> remove(RequestId reqId)

getNextAvailable

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

complete

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

clearQueue

public abstract int clearQueue()

getQueueContents

public abstract List<SessionRequestCapability> getQueueContents()

matches

public boolean matches(HttpRequest req)

Specified by:

matches in interface Routable

execute

public HttpResponse execute(HttpRequest req)

Specified by:

execute in interface HttpHandler