com.smartbear.testleft

Class RemoteDriver

java.lang.Object

com.smartbear.testleft.RemoteDriver

All Implemented Interfaces:

Driver

public class RemoteDriver
extends Object
implements Driver

A class that represents the connection between TestLeft and the test engine on a remote machine.

Field Summary

Fields inherited from interface com.smartbear.testleft.Driver

DEFAULT_LOCAL_PORT

Constructor Summary

Constructors

Constructor and Description
RemoteDriver(String host, String userName, String password) Initializes a new instance of the RemoteDriver class using the specified host, user name and password.
RemoteDriver(String host, String userName, String password, int port) Initializes a new instance of the RemoteDriver class using the specified host, user name, password and port number.

Method Summary

Modifier and Type	Method and Description
<T extends ObjectTreeNode> T	find(Class clazz, SearchPattern pattern) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> T	find(Class clazz, SearchPattern pattern, int depth) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> T	find(Class clazz, SearchPattern pattern, int depth, int timeout) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> List<T>	findAll(Class clazz, SearchPattern pattern) Searches for objects that match the specified pattern.
<T extends ObjectTreeNode> List<T>	findAll(Class clazz, SearchPattern pattern, int depth) Searches for objects that match the specified pattern.
ApplicationManager	getApplications() Provides access to the "ApplicationManager" object used to run applications.
Desktop	getDesktop() Returns the object that represents the desktop.
Log	getLog() Provides access to the TestLeft test log.
OptionsManager	getOptions() Provides access to the OptionsManager object used configure test engine.
<T extends ObjectTreeNode> FindResult<T>	tryFind(Class clazz, SearchPattern pattern) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> FindResult<T>	tryFind(Class clazz, SearchPattern pattern, int depth) Searches for an object that matches the specified pattern.
<T extends ObjectTreeNode> FindResult<T>	tryFind(Class clazz, SearchPattern pattern, int depth, Integer timeout) Searches for an object that matches the specified pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteDriver

public RemoteDriver(String host,
                    String userName,
                    String password)
             throws RestConnectionRefused,
                    RestIncorrectUsernameOrPassword

Initializes a new instance of the RemoteDriver class using the specified host, user name and password. The default port number is 2377.

Parameters:

host - The IP address or host name.

userName - The user name in the format "Domain\Username".

password - The user password.

Throws:

RestConnectionRefused - Thrown if the connection is rejected.

RestIncorrectUsernameOrPassword - Thrown if an incorrect username or password is specified.

RemoteDriver

public RemoteDriver(String host,
                    String userName,
                    String password,
                    int port)
             throws RestConnectionRefused,
                    RestIncorrectUsernameOrPassword

Initializes a new instance of the RemoteDriver class using the specified host, user name, password and port number.

Parameters:

host - The IP address or host name.

userName - The user name in the format "Domain\Username".

password - The user password.

port - The port number.

Throws:

RestConnectionRefused - Throw if connection refused

RestIncorrectUsernameOrPassword - Throws if user pass incorrect username or password

Method Detail

find

public <T extends ObjectTreeNode> T find(Class clazz,
                                         SearchPattern pattern)
                                  throws ObjectTreeNodeNotFoundException,
                                         HttpException

Searches for an object that matches the specified pattern.

Specified by:

find in interface Driver

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

Returns:

The found object.

Throws:

ObjectTreeNodeNotFoundException - Throws if can't connect to rest server.

HttpException - Will be thrown if there are network problems.

find

public <T extends ObjectTreeNode> T find(Class clazz,
                                         SearchPattern pattern,
                                         int depth)
                                  throws ObjectTreeNodeNotFoundException,
                                         HttpException

Searches for an object that matches the specified pattern.

Specified by:

find in interface Driver

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

Returns:

The found object.

Throws:

ObjectTreeNodeNotFoundException - Throws if can't connect to rest server.

HttpException - Will be thrown if there are network problems.

find

public <T extends ObjectTreeNode> T find(Class clazz,
                                         SearchPattern pattern,
                                         int depth,
                                         int timeout)
                                  throws ObjectTreeNodeNotFoundException,
                                         HttpException

Searches for an object that matches the specified pattern.

Specified by:

find in interface Driver

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

timeout - The timeout, in milliseconds, used to wait for the object.

Returns:

The found object.

Throws:

ObjectTreeNodeNotFoundException - Throws if can't connect to rest server.

HttpException - Will be thrown if there are network problems.

findAll

public <T extends ObjectTreeNode> List<T> findAll(Class clazz,
                                                  SearchPattern pattern)
                                           throws HttpException

Searches for objects that match the specified pattern.

Specified by:

findAll in interface Driver

Type Parameters:

T - The interface of the elements in the returned sequence.

Parameters:

clazz - The interface of the elements in the returned sequence.

pattern - The search pattern.

Returns:

The sequence of the found objects.

Throws:

HttpException - Will be thrown if there are network problems.

findAll

public <T extends ObjectTreeNode> List<T> findAll(Class clazz,
                                                  SearchPattern pattern,
                                                  int depth)
                                           throws HttpException

Searches for objects that match the specified pattern.

Specified by:

findAll in interface Driver

Type Parameters:

T - The interface of the elements in the returned sequence.

Parameters:

clazz - The interface of the elements in the returned sequence.

pattern - The search pattern.

depth - The search depth.

Returns:

The sequence of the found objects.

Throws:

HttpException - Will be thrown if there are network problems.

tryFind

public <T extends ObjectTreeNode> FindResult<T> tryFind(Class clazz,
                                                        SearchPattern pattern)
                                                 throws HttpException

Searches for an object that matches the specified pattern.

Specified by:

tryFind in interface Driver

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

Returns:

The object that contains the search result and the found object.

Throws:

HttpException - Will be thrown if there are network problems.

tryFind

public <T extends ObjectTreeNode> FindResult<T> tryFind(Class clazz,
                                                        SearchPattern pattern,
                                                        int depth)
                                                 throws HttpException

Searches for an object that matches the specified pattern.

Specified by:

tryFind in interface Driver

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

Returns:

The object that contains the search result and the found object.

Throws:

HttpException - Will be thrown if there are network problems.

tryFind

public <T extends ObjectTreeNode> FindResult<T> tryFind(Class clazz,
                                                        SearchPattern pattern,
                                                        int depth,
                                                        Integer timeout)
                                                 throws HttpException

Searches for an object that matches the specified pattern.

Specified by:

tryFind in interface Driver

Type Parameters:

T - The interface that will be implemented in the returned object.

Parameters:

clazz - The interface that will be implemented in the returned object.

pattern - The search pattern.

depth - The search depth.

timeout - The timeout used to wait for the object.

Returns:

The object that contains the search result and the found object.

Throws:

HttpException - Will be thrown if there are network problems.

getLog

public Log getLog()

Provides access to the TestLeft test log.

Specified by:

getLog in interface Driver

Returns:

Log object

getOptions

public OptionsManager getOptions()

Provides access to the OptionsManager object used configure test engine.

Specified by:

getOptions in interface Driver

Returns:

OptionsManager object

getApplications

public ApplicationManager getApplications()

Provides access to the "ApplicationManager" object used to run applications.

Specified by:

getApplications in interface Driver

Returns:

ApplicationManager object

getDesktop

public Desktop getDesktop()
                   throws HttpException

Returns the object that represents the desktop.

Specified by:

getDesktop in interface Driver

Returns:

Desktop object

Throws:

HttpException - Will be thrown if there are network problems.