org.openqa.grid.internal

Class DefaultGridRegistry

java.lang.Object

org.openqa.grid.internal.BaseGridRegistry

org.openqa.grid.internal.DefaultGridRegistry

All Implemented Interfaces:

GridRegistry

@ThreadSafe
public class DefaultGridRegistry
extends BaseGridRegistry
implements GridRegistry

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultGridRegistry.UncaughtExceptionHandler

Field Summary

Fields inherited from class org.openqa.grid.internal.BaseGridRegistry

httpClientFactory, hub

Fields inherited from interface org.openqa.grid.internal.GridRegistry

KEY

Constructor Summary

Constructors

Constructor and Description
DefaultGridRegistry()
DefaultGridRegistry(Hub hub)

Method Summary

Modifier and Type	Method and Description
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) Add a new session request to the registry
void	clearNewSessionRequests() Clear all new session requests in the registry
void	forceRelease(TestSlot testSlot, SessionTerminationReason reason) Releases the test slot, WITHOUT running any listener.
java.util.Set<TestSession>	getActiveSessions()
ProxySet	getAllProxies()
java.lang.Iterable<org.openqa.selenium.remote.DesiredCapabilities>	getDesiredCapabilities()
TestSession	getExistingSession(ExternalSessionKey externalKey) gets the test existing session associated to this external key.
int	getNewSessionRequestCount()
RemoteProxy	getProxyById(java.lang.String id) Get the RemoteProxy using the id provided
TestSession	getSession(ExternalSessionKey externalKey) Gets the test session associated to this external key.
java.util.List<RemoteProxy>	getUsedProxies()
static GridRegistry	newInstance(Hub hub) Creates a new GridRegistry and starts it.
void	removeIfPresent(RemoteProxy proxy) Remove the RemoteProxy specified from the registry
boolean	removeNewSessionRequest(RequestHandler request) Remove a new session request from the registry
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	start() Start the registry
void	stop() Stop the registry
void	terminate(TestSession session, SessionTerminationReason reason) Ends this test session for the hub, releasing the resources in the hub / registry.

Methods inherited from class org.openqa.grid.internal.BaseGridRegistry

getHttpClient, getHub, setHub

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openqa.grid.internal.GridRegistry

getHttpClient, getHub, setHub

Constructor Detail

DefaultGridRegistry

public DefaultGridRegistry()

DefaultGridRegistry

public DefaultGridRegistry(Hub hub)

Method Detail

start

public void start()

Description copied from interface: GridRegistry

Start the registry

Specified by:

start in interface GridRegistry

newInstance

public static GridRegistry newInstance(Hub hub)

Creates a new GridRegistry and starts it.

Parameters:

hub - the Hub to associate this registry with

Returns:

the registry

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.

Specified by:

terminate in interface GridRegistry

Parameters:

session - The session to terminate

reason - the reason for termination

removeIfPresent

public void removeIfPresent(RemoteProxy proxy)

Description copied from interface: GridRegistry

Remove the RemoteProxy specified from the registry

Specified by:

removeIfPresent in interface GridRegistry

See Also:

GridRegistry.removeIfPresent(RemoteProxy)

forceRelease

public void forceRelease(TestSlot testSlot,
                         SessionTerminationReason reason)

Description copied from interface: GridRegistry

Releases the test slot, WITHOUT running any listener.

Specified by:

forceRelease in interface GridRegistry

Parameters:

testSlot - test slot to be released

reason - reason for termination

See Also:

GridRegistry.forceRelease(TestSlot, SessionTerminationReason)

stop

public void stop()

Description copied from interface: GridRegistry

Stop the registry

Specified by:

stop in interface GridRegistry

See Also:

GridRegistry.stop()

addNewSessionRequest

public void addNewSessionRequest(RequestHandler handler)

Description copied from interface: GridRegistry

Add a new session request to the registry

Specified by:

addNewSessionRequest in interface GridRegistry

Parameters:

handler - the RequestHandler

See Also:

GridRegistry.addNewSessionRequest(RequestHandler)

add

public void add(RemoteProxy proxy)

Description copied from interface: GridRegistry

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

Specified by:

add in interface GridRegistry

Parameters:

proxy - The proxy to add

See Also:

GridRegistry.add(RemoteProxy)

setThrowOnCapabilityNotPresent

public void setThrowOnCapabilityNotPresent(boolean throwOnCapabilityNotPresent)

Description copied from interface: GridRegistry

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.

Specified by:

setThrowOnCapabilityNotPresent in interface GridRegistry

Parameters:

throwOnCapabilityNotPresent - true to throw if capability not present

See Also:

GridRegistry.setThrowOnCapabilityNotPresent(boolean)

getAllProxies

public ProxySet getAllProxies()

Specified by:

getAllProxies in interface GridRegistry

Returns:

a ProxySet of all of the connected proxies/nodes

See Also:

GridRegistry.getAllProxies()

getUsedProxies

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

Specified by:

getUsedProxies in interface GridRegistry

Returns:

a List of all of the proxies/nodes which are in use

See Also:

GridRegistry.getUsedProxies()

getSession

public TestSession getSession(ExternalSessionKey externalKey)

Description copied from interface: GridRegistry

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

Specified by:

getSession in interface GridRegistry

Parameters:

externalKey - the external session key

Returns:

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

See Also:

GridRegistry.getSession(ExternalSessionKey)

getExistingSession

public TestSession getExistingSession(ExternalSessionKey externalKey)

Description copied from interface: GridRegistry

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

Specified by:

getExistingSession in interface GridRegistry

Parameters:

externalKey - the external session key

Returns:

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

See Also:

GridRegistry.getExistingSession(ExternalSessionKey)

getNewSessionRequestCount

public int getNewSessionRequestCount()

Specified by:

getNewSessionRequestCount in interface GridRegistry

Returns:

the number of new session requests in the queue

See Also:

GridRegistry.getNewSessionRequestCount()

clearNewSessionRequests

public void clearNewSessionRequests()

Description copied from interface: GridRegistry

Clear all new session requests in the registry

Specified by:

clearNewSessionRequests in interface GridRegistry

See Also:

GridRegistry.clearNewSessionRequests()

removeNewSessionRequest

public boolean removeNewSessionRequest(RequestHandler request)

Description copied from interface: GridRegistry

Remove a new session request from the registry

Specified by:

removeNewSessionRequest in interface GridRegistry

Parameters:

request - the RequestHandler

See Also:

GridRegistry.removeNewSessionRequest(RequestHandler)

getDesiredCapabilities

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

Specified by:

getDesiredCapabilities in interface GridRegistry

Returns:

an iteration of DesiredCapabilities in the new session queue

See Also:

GridRegistry.getDesiredCapabilities()

getActiveSessions

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

Specified by:

getActiveSessions in interface GridRegistry

Returns:

the Set of active TestSessions

See Also:

GridRegistry.getActiveSessions()

getProxyById

public RemoteProxy getProxyById(java.lang.String id)

Description copied from interface: GridRegistry

Get the RemoteProxy using the id provided

Specified by:

getProxyById in interface GridRegistry

Parameters:

id - the string identifier

Returns:

the RemoteProxy

See Also:

GridRegistry.getProxyById(String)