org.openqa.grid.internal

Interface GridRegistry

All Known Implementing Classes:

BaseGridRegistry, DefaultGridRegistry

public interface GridRegistry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	KEY

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 requestHandler) 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.
org.openqa.selenium.remote.http.HttpClient	getHttpClient(java.net.URL url)
Hub	getHub()
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()
void	removeIfPresent(RemoteProxy proxy) Remove the RemoteProxy specified from the registry
boolean	removeNewSessionRequest(RequestHandler requestHandler) Remove a new session request from the registry
void	setHub(Hub hub) Set the Hub for this 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, releasing the resources in the registry.

Field Detail

KEY

static final java.lang.String KEY

Method Detail

terminate

void terminate(TestSession session,
               SessionTerminationReason reason)

Ends this test session, releasing the resources in the registry. Resources should be released on a separate thread so the call does not block. MUST honor listeners for the TestSlot which is being released.

Parameters:

session - The session to terminate

reason - the reason for termination

removeIfPresent

void removeIfPresent(RemoteProxy proxy)

Remove the RemoteProxy specified from the registry

Parameters:

proxy -

forceRelease

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

getHub

Hub getHub()

Returns:

the Hub for this registry or null if no Hub is set.

setHub

void setHub(Hub hub)

Set the Hub for this registry

Parameters:

hub -

addNewSessionRequest

void addNewSessionRequest(RequestHandler requestHandler)

Add a new session request to the registry

Parameters:

requestHandler - the RequestHandler

add

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

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

getAllProxies

ProxySet getAllProxies()

Returns:

a ProxySet of all of the connected proxies/nodes

getUsedProxies

java.util.List<RemoteProxy> getUsedProxies()

Returns:

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

getSession

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

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

int getNewSessionRequestCount()

Returns:

the number of new session requests in the queue

start

void start()

Start the registry

getDesiredCapabilities

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

Returns:

an iteration of DesiredCapabilities in the new session queue

getActiveSessions

java.util.Set<TestSession> getActiveSessions()

Returns:

the Set of active TestSessions

getProxyById

RemoteProxy getProxyById(java.lang.String id)

Get the RemoteProxy using the id provided

Parameters:

id - the string identifier

Returns:

the RemoteProxy

stop

void stop()

Stop the registry

getHttpClient

org.openqa.selenium.remote.http.HttpClient getHttpClient(java.net.URL url)

Returns:

the HttpClient.Factory to use.

removeNewSessionRequest

boolean removeNewSessionRequest(RequestHandler requestHandler)

Remove a new session request from the registry

Parameters:

requestHandler - the RequestHandler

clearNewSessionRequests

void clearNewSessionRequests()

Clear all new session requests in the registry