org.openqa.grid.internal

Class TestSession

java.lang.Object

org.openqa.grid.internal.TestSession

public class TestSession
extends java.lang.Object

Represent a running test for the hub/registry. A test session is created when a TestSlot becomes available for a test.

The session is destroyed when the test ends ( ended by the client or timed out)

Field Summary

Fields

Modifier and Type	Field and Description
private ExternalSessionKey	externalKey
private boolean	forwardingRequest
private boolean	ignoreTimeout
private java.lang.String	internalKey
private long	lastActivity
private static java.util.logging.Logger	log
(package private) static int	MAX_IDLE_TIME_BEFORE_CONSIDERED_ORPHANED
private int	MAX_NETWORK_LATENCY
private java.util.Map<java.lang.String,java.lang.Object>	objects
private java.util.Map<java.lang.String,java.lang.Object>	requestedCapabilities
private long	sessionCreatedAt
private TestSlot	slot
private TimeSource	timeSource

Constructor Summary

Constructors

Constructor and Description
TestSession(TestSlot slot, java.util.Map<java.lang.String,java.lang.Object> requestedCapabilities, TimeSource timeSource)

Method Summary

Modifier and Type	Method and Description
private byte[]	drainInputStream(java.io.InputStream in)
boolean	equals(java.lang.Object obj)
java.lang.String	forward(SeleniumBasedRequest request, javax.servlet.http.HttpServletResponse response, boolean newSessionRequest)
java.lang.Object	get(java.lang.String key) Allow you to retrieve an object previously stored on the test session.
private org.apache.http.client.HttpClient	getClient()
ExternalSessionKey	getExternalKey() Get the session key from the remote.
long	getInactivityTime() give the time in milliseconds since the last access to this test session, or 0 is ignore time out has been set to true.
java.lang.String	getInternalKey()
java.util.Map<java.lang.String,java.lang.Object>	getRequestedCapabilities()
private java.lang.String	getResponseUtf8Content(java.io.InputStream in)
TestSlot	getSlot()
int	hashCode()
boolean	isForwardingRequest()
boolean	isOrphaned()
private static boolean	isSuccessJsonResponse(org.apache.http.HttpResponse response)
private org.apache.http.HttpRequest	prepareProxyRequest(javax.servlet.http.HttpServletRequest request)
private void	processResponseHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.net.URL remoteURL, org.apache.http.HttpResponse proxyResponse)
void	put(java.lang.String key, java.lang.Object value) Allows you to store an object on the test session.
private void	removeIncompleteNewSessionRequest()
private void	removeSessionBrowserTimeout()
boolean	sendDeleteSessionRequest() Sends a DELETE/testComplete (webdriver/selenium) session command to the remote, following web driver protocol.
private org.apache.http.HttpResponse	sendRequestToNode(org.apache.http.HttpRequest proxyRequest)
void	setExternalKey(ExternalSessionKey externalKey) associate this session to the session provided by the remote.
void	setIgnoreTimeout(boolean ignore) allow to bypass time out for this session.
private void	setThreadDisplayName()
java.lang.String	toString()
private byte[]	updateHubIfNewWebDriverSession(SeleniumBasedRequest request, org.apache.http.HttpResponse proxyResponse)
private void	updateHubNewSeleniumSession(java.lang.String content)
private void	writeRawBody(javax.servlet.http.HttpServletResponse response, byte[] rawBody)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final java.util.logging.Logger log

MAX_IDLE_TIME_BEFORE_CONSIDERED_ORPHANED

static final int MAX_IDLE_TIME_BEFORE_CONSIDERED_ORPHANED

See Also:

Constant Field Values

internalKey

private final java.lang.String internalKey

slot

private final TestSlot slot

externalKey

private volatile ExternalSessionKey externalKey

sessionCreatedAt

private volatile long sessionCreatedAt

lastActivity

private volatile long lastActivity

requestedCapabilities

private final java.util.Map<java.lang.String,java.lang.Object> requestedCapabilities

objects

private java.util.Map<java.lang.String,java.lang.Object> objects

ignoreTimeout

private volatile boolean ignoreTimeout

timeSource

private final TimeSource timeSource

forwardingRequest

private volatile boolean forwardingRequest

MAX_NETWORK_LATENCY

private final int MAX_NETWORK_LATENCY

See Also:

Constant Field Values

Constructor Detail

TestSession

public TestSession(TestSlot slot,
                   java.util.Map<java.lang.String,java.lang.Object> requestedCapabilities,
                   TimeSource timeSource)

Method Detail

getInternalKey

public java.lang.String getInternalKey()

getRequestedCapabilities

public java.util.Map<java.lang.String,java.lang.Object> getRequestedCapabilities()

Returns:

the capabilities the client requested. It will match the TestSlot capabilities, but is not equals.

getExternalKey

public ExternalSessionKey getExternalKey()

Get the session key from the remote. It's up to the remote to guarantee the key is unique. If 2 remotes return the same session key, the tests will overwrite each other.

Returns:

the key that was provided by the remote when the POST /session command was sent.

setExternalKey

public void setExternalKey(ExternalSessionKey externalKey)

associate this session to the session provided by the remote.

Parameters:

externalKey - external session key

getInactivityTime

public long getInactivityTime()

give the time in milliseconds since the last access to this test session, or 0 is ignore time out has been set to true.

Returns:

time in millis

See Also:

setIgnoreTimeout(boolean)

isOrphaned

public boolean isOrphaned()

getSlot

public TestSlot getSlot()

Returns:

the TestSlot this session is executed against.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getClient

private org.apache.http.client.HttpClient getClient()

forward

public java.lang.String forward(SeleniumBasedRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                boolean newSessionRequest)
                         throws java.io.IOException

Throws:

java.io.IOException

setThreadDisplayName

private void setThreadDisplayName()

removeIncompleteNewSessionRequest

private void removeIncompleteNewSessionRequest()

removeSessionBrowserTimeout

private void removeSessionBrowserTimeout()

updateHubNewSeleniumSession

private void updateHubNewSeleniumSession(java.lang.String content)

updateHubIfNewWebDriverSession

private byte[] updateHubIfNewWebDriverSession(SeleniumBasedRequest request,
                                              org.apache.http.HttpResponse proxyResponse)
                                       throws java.io.IOException

Throws:

java.io.IOException

isSuccessJsonResponse

private static boolean isSuccessJsonResponse(org.apache.http.HttpResponse response)

sendRequestToNode

private org.apache.http.HttpResponse sendRequestToNode(org.apache.http.HttpRequest proxyRequest)
                                                throws org.apache.http.client.ClientProtocolException,
                                                       java.io.IOException

Throws:

org.apache.http.client.ClientProtocolException

java.io.IOException

prepareProxyRequest

private org.apache.http.HttpRequest prepareProxyRequest(javax.servlet.http.HttpServletRequest request)
                                                 throws java.io.IOException

Throws:

java.io.IOException

writeRawBody

private void writeRawBody(javax.servlet.http.HttpServletResponse response,
                          byte[] rawBody)
                   throws java.io.IOException

Throws:

java.io.IOException

drainInputStream

private byte[] drainInputStream(java.io.InputStream in)
                         throws java.io.IOException

Throws:

java.io.IOException

getResponseUtf8Content

private java.lang.String getResponseUtf8Content(java.io.InputStream in)

processResponseHeaders

private void processResponseHeaders(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    java.net.URL remoteURL,
                                    org.apache.http.HttpResponse proxyResponse)
                             throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

get

public java.lang.Object get(java.lang.String key)

Allow you to retrieve an object previously stored on the test session.

Parameters:

key - key

Returns:

the object you stored

put

public void put(java.lang.String key,
                java.lang.Object value)

Allows you to store an object on the test session.

Parameters:

key - a non-null string

value - value object

sendDeleteSessionRequest

public boolean sendDeleteSessionRequest()

Sends a DELETE/testComplete (webdriver/selenium) session command to the remote, following web driver protocol.

Returns:

true is the remote replied successfully to the request.

setIgnoreTimeout

public void setIgnoreTimeout(boolean ignore)

allow to bypass time out for this session. ignore = true => the session will not time out. setIgnoreTimeout(true) also update the lastActivity to now.

Parameters:

ignore - true to ignore the timeout

isForwardingRequest

public boolean isForwardingRequest()