com.paypal.selion.proxy

Class SeLionRemoteProxy

java.lang.Object

org.openqa.grid.internal.BaseRemoteProxy

org.openqa.grid.selenium.proxy.DefaultRemoteProxy

com.paypal.selion.proxy.SeLionRemoteProxy

All Implemented Interfaces:

Comparable<org.openqa.grid.internal.RemoteProxy>, org.openqa.grid.internal.listeners.CommandListener, org.openqa.grid.internal.listeners.SelfHealingProxy, org.openqa.grid.internal.listeners.TestSessionListener, org.openqa.grid.internal.listeners.TimeoutListener, org.openqa.grid.internal.RemoteProxy

public class SeLionRemoteProxy
extends org.openqa.grid.selenium.proxy.DefaultRemoteProxy

This is a customized DefaultRemoteProxy for SeLion.

This proxy, when utilized can:

• Count unique test sessions. After "n" test sessions, the proxy disconnects from the grid and issues a requests to NodeForceRestartServlet. The number of unique sessions is controlled via the json config file SeLionConfig.json with the setting uniqueSessionCount.
  
  For example:

    "uniqueSessionCount": 25
   

  Here the value 25 indicates that the proxy will stop accepting new connections after 25 unique sessions and trigger a graceful shutdown (see below). A value of <=0 indicates that this feature is disabled.
• Request remote proxy to shutdown either forcefully or gracefully -- issues a request to NodeForceRestartServlet. In the case of a graceful restart, the proxy respects a wait timeout for any sessions in progress to complete. This is controlled via the json config file SeLionConfig.json with the setting nodeRecycleThreadWaitTimeout.
  
  For example:

    "nodeRecycleThreadWaitTimeout": 300
   

  Here the value 300 is in seconds -- the proxy will wait this amount of time before forcing a shutdown action. A value of 0 indicates that the proxy will wait indefinitely.
• Request remote proxy to auto upgrade -- issues a request to NodeAutoUpgradeServlet.
• Determine whether the remote proxy supports NodeAutoUpgradeServlet, NodeForceRestartServlet, and LogServlet

Field Summary

Fields inherited from class org.openqa.grid.selenium.proxy.DefaultRemoteProxy

DEFAULT_DOWN_POLLING_LIMIT, DEFAULT_POLLING_INTERVAL, DEFAULT_UNREGISTER_DELAY

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

remoteHost

Constructor Summary

Constructors

Constructor and Description
SeLionRemoteProxy(org.openqa.grid.common.RegistrationRequest request, org.openqa.grid.internal.Registry registry)

Method Summary

Modifier and Type	Method and Description
void	afterSession(org.openqa.grid.internal.TestSession session)
void	forceNodeShutdown() Forcefully shuts the node down by calling NodeForceRestartServlet
org.openqa.grid.internal.TestSession	getNewSession(Map<String,Object> requestedCapability)
int	getTotalSessionsComplete()
int	getTotalSessionsStarted()
long	getUptimeInMinutes()
boolean	isScheduledForRecycle()
void	requestNodeShutdown() Gracefully shuts the node down by; 1.
boolean	supportsAutoUpgrade()
boolean	supportsForceShutdown()
boolean	supportsViewLogs()
boolean	upgradeNode(String downloadJSON) Upgrades the node by calling NodeAutoUpgradeServlet and then requestNodeShutdown()

Methods inherited from class org.openqa.grid.selenium.proxy.DefaultRemoteProxy

addNewEvent, afterCommand, beforeCommand, beforeRelease, beforeSession, getHtmlRender, isAlive, isDown, onEvent, startPolling, stopPolling, teardown

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

compareTo, equals, forceSlotCleanerRun, getCapabilityHelper, getConfig, getHttpClientFactory, getId, getLastSessionStart, getMaxNumberOfConcurrentTestSessions, getNewInstance, getOriginalRegistrationRequest, getRegistry, getRemoteHost, getResourceUsageInPercent, getStatus, getTestSlots, getTimeOut, getTotalUsed, hasCapability, hashCode, isBusy, setupTimeoutListener, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SeLionRemoteProxy

public SeLionRemoteProxy(org.openqa.grid.common.RegistrationRequest request,
                         org.openqa.grid.internal.Registry registry)
                  throws IOException

Parameters:

request - a RegistrationRequest request which represents the basic information that is to be consumed by the grid when it is registering a new node.

registry - a Registry object that represents the Grid's registry.

Throws:

IOException

Method Detail

upgradeNode

public boolean upgradeNode(String downloadJSON)

Upgrades the node by calling NodeAutoUpgradeServlet and then requestNodeShutdown()

Parameters:

downloadJSON - the download.json to install on node

Returns:

true on success. false when an error occured.

getNewSession

public org.openqa.grid.internal.TestSession getNewSession(Map<String,Object> requestedCapability)

Specified by:

getNewSession in interface org.openqa.grid.internal.RemoteProxy

Overrides:

getNewSession in class org.openqa.grid.selenium.proxy.DefaultRemoteProxy

afterSession

public void afterSession(org.openqa.grid.internal.TestSession session)

Specified by:

afterSession in interface org.openqa.grid.internal.listeners.TestSessionListener

Overrides:

afterSession in class org.openqa.grid.selenium.proxy.DefaultRemoteProxy

requestNodeShutdown

public void requestNodeShutdown()

Gracefully shuts the node down by;

1. Stops accepting new sessions
2. Waits for sessions to complete
3. Calls forceNodeShutdown()

forceNodeShutdown

public void forceNodeShutdown()

Forcefully shuts the node down by calling NodeForceRestartServlet

getUptimeInMinutes

public long getUptimeInMinutes()

Returns:

total uptime since proxy came online in minutes

getTotalSessionsComplete

public int getTotalSessionsComplete()

Returns:

total number of sessions completed since proxy came online

getTotalSessionsStarted

public int getTotalSessionsStarted()

Returns:

total number of sessions started since proxy came online

isScheduledForRecycle

public boolean isScheduledForRecycle()

Returns:

true or false, whether the proxy is scheduled for recycle

supportsForceShutdown

public boolean supportsForceShutdown()

Returns:

whether the proxy supports/has running NodeForceRestartServlet

supportsAutoUpgrade

public boolean supportsAutoUpgrade()

Returns:

whether the proxy supports/has running NodeAutoUpgradeServlet

supportsViewLogs

public boolean supportsViewLogs()

Returns:

whether the proxy supports/has running LogServlet