com.tplan.robot.scripting

Class ConnectionTimeout

java.lang.Object

com.tplan.robot.scripting.ConnectionTimeout

All Implemented Interfaces:

Runnable

public class ConnectionTimeout
extends Object
implements Runnable

A simple utility runnable used to wait for a desktop connection to be established or restored. The class accepts either a client instance or a valid execution context containing a client and its run() waits until the client connects or the time out value is reached. The time out value defaults to 5 seconds and can be configured in the Execution panel of the Preferences window or at the level of Java preferences (UserConfiguration.getInstance().setInteger("scripting.connectionTimeoutInSec", 5) ). The default value may be further overridden though the setTimeout(java.lang.Integer) method. If the connection gets established within the timeout period, the isConnected() method returns true.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Constructor Summary

Constructors

Constructor and Description
ConnectionTimeout(RemoteDesktopClient client) Connector for a desktop client.
ConnectionTimeout(ScriptingContext context, String timeoutMessage) Constructor to be used with a context.

Method Summary

Modifier and Type	Method and Description
int	getTimeout() Get the timeout value.
boolean	isConnected() Get the result achieved by the run() method.
void	run() Implementation of the Runnable interface.
void	setTimeout(Integer timeout) Set the timeout value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionTimeout

public ConnectionTimeout(ScriptingContext context,
                         String timeoutMessage)

Constructor to be used with a context.

Parameters:

context - a valid execution context of a test script which is being executed.

timeoutMessage - if not null the message will be fired as a script log. This typically makes the GUI display it in the status bar. The message may optionally contain the MessageFormat parameter of {0} which will be replaced with number of seconds remaining to the timeout.

ConnectionTimeout

public ConnectionTimeout(RemoteDesktopClient client)

Connector for a desktop client.

Parameters:

client - a desktop client.

Method Detail

run

public void run()

Implementation of the Runnable interface. This method waits for the connection as is specified in the class description.

Specified by:

run in interface Runnable

getTimeout

public int getTimeout()

Get the timeout value. If a custom value was set using setTimeout(java.lang.Integer), the method returns it. Otherwise it returns a value loaded from user preferences (parameter scripting.connectionTimeoutInSec).

Returns:

timeout value.

setTimeout

public void setTimeout(Integer timeout)

Set the timeout value. This overrides the default value loaded from user preferences.

Parameters:

timeout - in seconds.

isConnected

public boolean isConnected()

Get the result achieved by the run() method.

Returns:

true if the client got connected within the specified timeout, false if not.