org.openqa.grid.internal

Class Registry

java.lang.Object

org.openqa.grid.internal.Registry

@ThreadSafe
public class Registry
extends java.lang.Object

Kernel of the grid. Keeps track of what's happening, what's free/used and assigned resources to incoming requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Registry.Matcher iterates the queue of incoming new session request and assign them to proxy after they've been sorted by priority, with priority defined by the prioritizer.
private static class	Registry.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
private ActiveTestSessions	activeTestSessions
private GridHubConfiguration	configuration
private org.openqa.selenium.remote.internal.HttpClientFactory	httpClientFactory
private Hub	hub
static java.lang.String	KEY
private java.util.concurrent.locks.ReentrantLock	lock
private static java.util.logging.Logger	LOG
private Registry.Matcher	matcherThread
private NewSessionRequestQueue	newSessionQueue
private ProxySet	proxies
private java.util.List<RemoteProxy>	registeringProxies
private boolean	stop
private java.util.concurrent.locks.Condition	testSessionAvailable

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Registry(Hub hub, GridHubConfiguration config)

Method Summary

Modifier and Type	Method and Description
private void	_release(TestSlot testSlot, SessionTerminationReason reason) Release the test slot.
void	add(RemoteProxy proxy) Add a proxy to the list of proxy available for the grid to managed and link the proxy to the registry.
void	addNewSessionRequest(RequestHandler handler)
private void	assignRequestToProxy() iterates the list of incoming session request to find a potential match in the list of proxies.
void	clearNewSessionRequests()
private void	fireMatcherStateChanged()
void	forceRelease(TestSlot testSlot, SessionTerminationReason reason) Releases the test slot, WITHOUT running any listener.
java.util.Set<TestSession>	getActiveSessions()
ProxySet	getAllProxies()
GridHubConfiguration	getConfiguration()
java.lang.Iterable<org.openqa.selenium.remote.DesiredCapabilities>	getDesiredCapabilities()
TestSession	getExistingSession(ExternalSessionKey externalKey) gets the test existing session associated to this external key.
(package private) org.openqa.selenium.remote.internal.HttpClientFactory	getHttpClientFactory()
Hub	getHub()
int	getNewSessionRequestCount()
RemoteProxy	getProxyById(java.lang.String id)
TestSession	getSession(ExternalSessionKey externalKey) gets the test session associated to this external key.
java.util.List<RemoteProxy>	getUsedProxies()
static Registry	newInstance()
static Registry	newInstance(Hub hub, GridHubConfiguration config)
private void	release(java.lang.String internalKey, SessionTerminationReason reason)
private void	release(TestSession session, SessionTerminationReason reason) mark the session as finished for the registry.
void	removeIfPresent(RemoteProxy proxy)
boolean	removeNewSessionRequest(RequestHandler request)
void	setHub(Hub hub)
void	setThrowOnCapabilityNotPresent(boolean throwOnCapabilityNotPresent) If throwOnCapabilityNotPresent is set to true, the hub will reject test request for a capability that is not on the grid.
void	stop()
private boolean	takeRequestHandler(RequestHandler handler)
void	terminate(TestSession session, SessionTerminationReason reason) Ends this test session for the hub, releasing the resources in the hub / registry.
(package private) void	terminateSynchronousFOR_TEST_ONLY(TestSession testSession)

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final java.lang.String KEY

LOG

private static final java.util.logging.Logger LOG

lock

private final java.util.concurrent.locks.ReentrantLock lock

testSessionAvailable

private final java.util.concurrent.locks.Condition testSessionAvailable

proxies

private final ProxySet proxies

activeTestSessions

private final ActiveTestSessions activeTestSessions

configuration

private final GridHubConfiguration configuration

httpClientFactory

private final org.openqa.selenium.remote.internal.HttpClientFactory httpClientFactory

newSessionQueue

private final NewSessionRequestQueue newSessionQueue

matcherThread

private final Registry.Matcher matcherThread

registeringProxies

private final java.util.List<RemoteProxy> registeringProxies

stop

private volatile boolean stop

hub

private volatile Hub hub

Constructor Detail

Registry

private Registry(Hub hub,
                 GridHubConfiguration config)

Method Detail

newInstance

public static Registry newInstance()

newInstance

public static Registry newInstance(Hub hub,
                                   GridHubConfiguration config)

getConfiguration

public GridHubConfiguration getConfiguration()

terminate

public void terminate(TestSession session,
                      SessionTerminationReason reason)

Ends this test session for the hub, releasing the resources in the hub / registry. It does not release anything on the remote. The resources are released in a separate thread, so the call returns immediately. It allows release with long duration not to block the test while the hub is releasing the resource.

Parameters:

session - The session to terminate

reason - the reason for termination

_release

private void _release(TestSlot testSlot,
                      SessionTerminationReason reason)

Release the test slot. Free the resource on the slot itself and the registry. If also invokes the TestSessionListener.afterSession(TestSession) if applicable.

Parameters:

testSlot - The slot to release

terminateSynchronousFOR_TEST_ONLY

void terminateSynchronousFOR_TEST_ONLY(TestSession testSession)

removeIfPresent

public void removeIfPresent(RemoteProxy proxy)

forceRelease

public void forceRelease(TestSlot testSlot,
                         SessionTerminationReason reason)

Releases the test slot, WITHOUT running any listener.

Parameters:

testSlot - test slot to be released

reason - reason for termination

stop

public void stop()

getHub

public Hub getHub()

setHub

public void setHub(Hub hub)

addNewSessionRequest

public void addNewSessionRequest(RequestHandler handler)

assignRequestToProxy

private void assignRequestToProxy()

iterates the list of incoming session request to find a potential match in the list of proxies. If something changes in the registry, the matcher iteration is stopped to account for that change.

takeRequestHandler

private boolean takeRequestHandler(RequestHandler handler)

release

private void release(TestSession session,
                     SessionTerminationReason reason)

mark the session as finished for the registry. The resources that were associated to it are now free to be reserved by other tests

Parameters:

session - The session

reason - the reason for the release

release

private void release(java.lang.String internalKey,
                     SessionTerminationReason reason)

add

public void add(RemoteProxy proxy)

Add a proxy to the list of proxy available for the grid to managed and link the proxy to the registry.

Parameters:

proxy - The proxy to add

setThrowOnCapabilityNotPresent

public void setThrowOnCapabilityNotPresent(boolean throwOnCapabilityNotPresent)

If throwOnCapabilityNotPresent is set to true, the hub will reject test request for a capability that is not on the grid. No exception will be thrown if the capability is present but busy.

If set to false, the test will be queued hoping a new proxy will register later offering that capability.

Parameters:

throwOnCapabilityNotPresent - true to throw if capability not present

fireMatcherStateChanged

private void fireMatcherStateChanged()

getAllProxies

public ProxySet getAllProxies()

getUsedProxies

public java.util.List<RemoteProxy> getUsedProxies()

getSession

public TestSession getSession(ExternalSessionKey externalKey)

gets the test session associated to this external key. The external key is the session used by webdriver.

Parameters:

externalKey - the external session key

Returns:

null if the hub doesn't have a node associated to the provided externalKey

getExistingSession

public TestSession getExistingSession(ExternalSessionKey externalKey)

gets the test existing session associated to this external key. The external key is the session used by webdriver. This method will log complaints and reasons if the key cannot be found

Parameters:

externalKey - the external session key

Returns:

null if the hub doesn't have a node associated to the provided externalKey

getNewSessionRequestCount

public int getNewSessionRequestCount()

clearNewSessionRequests

public void clearNewSessionRequests()

removeNewSessionRequest

public boolean removeNewSessionRequest(RequestHandler request)

getDesiredCapabilities

public java.lang.Iterable<org.openqa.selenium.remote.DesiredCapabilities> getDesiredCapabilities()

getActiveSessions

public java.util.Set<TestSession> getActiveSessions()

getProxyById

public RemoteProxy getProxyById(java.lang.String id)

getHttpClientFactory

org.openqa.selenium.remote.internal.HttpClientFactory getHttpClientFactory()