com.smartbear.testleft

Class ApplicationManager

java.lang.Object

com.smartbear.testleft.ApplicationManager

public class ApplicationManager
extends Object

Provides properties and methods to enumerate and run applications

Constructor Summary

Constructors

Constructor and Description
ApplicationManager(com.smartbear.testleft._internal.DriverBase driver, com.smartbear.testleft._internal.webclient.WebClientApi api)

Method Summary

Modifier and Type	Method and Description
List<BrowserInfo>	getBrowsers() Returns information about all the supported browsers that are available on the current computer.
TestProcess	run(String path) Runs the specified application and returns its process object.
TestProcess	run(String path, String commandLine) Runs the specified application and returns its process object.
TestProcess	run(String path, String commandLine, String workingFolder) Runs the specified application and returns its process object.
TestProcess	runAs(String path, String userName, String password) Runs an application under another user account and returns the application process object.
TestProcess	runAs(String path, String userName, String password, String commandLine) Runs an application under another user account and returns the application process object.
TestProcess	runAs(String path, String userName, String password, String commandLine, String workingFolder) Runs an application under another user account and returns the application process object.
WebBrowser	runBrowser(BrowserInfo info) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserInfo info, String url) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserInfo info, String url, Integer waitTime) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserInfo info, String url, Integer waitTime, String additionalCommandLine) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserInfo info, String url, String additionalCommandLine) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, PlatformType platform) Launches a web browser of a particular bitness (32-bit or 64-bit).
WebBrowser	runBrowser(BrowserType family, PlatformType platform, String url) Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, PlatformType platform, String url, Integer waitTime) Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, PlatformType platform, String url, Integer waitTime, String additionalCommandLine) Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, PlatformType platform, String url, String additionalCommandLine) Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, String url) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, String url, int waitTime) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, String url, int waitTime, String additionalCommandLine) Launches a web browser and, if a URL is specified, navigates to the web page.
WebBrowser	runBrowser(BrowserType family, String url, String additionalCommandLine) Launches a web browser and, if a URL is specified, navigates to the web page.
WinRTProcess	runPackage(String packageName) Runs a Windows Store application package and returns the application process object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationManager

public ApplicationManager(com.smartbear.testleft._internal.DriverBase driver,
                          com.smartbear.testleft._internal.webclient.WebClientApi api)

Method Detail

getBrowsers

public List<BrowserInfo> getBrowsers()
                              throws ApiException,
                                     HttpException

Returns information about all the supported browsers that are available on the current computer.

Returns:

A list of browsers

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

run

public TestProcess run(String path)
                throws ApiException,
                       HttpException

Runs the specified application and returns its process object.

Parameters:

path - The path to the application. Can be specified as a fully-qualified path, as the application name (if the application is in PATH environment variables), or by using environment variables (%PROGRAMFILES%, %USERPFOFILE%).

Returns:

The TestProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

run

public TestProcess run(String path,
                       String commandLine)
                throws ApiException,
                       HttpException

Runs the specified application and returns its process object.

Parameters:

path - The path to the application. Can be specified as a fully-qualified path, as the application name (if the application is in PATH environment variables), or by using environment variables (%PROGRAMFILES%, %USERPFOFILE%).

commandLine - Command-line arguments for the application.

Returns:

The TestProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

run

public TestProcess run(String path,
                       String commandLine,
                       String workingFolder)
                throws ApiException,
                       HttpException

Runs the specified application and returns its process object.

Parameters:

path - The path to the application. Can be specified as a fully-qualified path, as the application name (if the application is in PATH environment variables), or by using environment variables (%PROGRAMFILES%, %USERPFOFILE%).

commandLine - Command-line arguments for the application.

workingFolder - The path to the working folder of the application.

Returns:

The TestProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runAs

public TestProcess runAs(String path,
                         String userName,
                         String password)
                  throws ApiException,
                         HttpException

Runs an application under another user account and returns the application process object.

Parameters:

path - The path to the application. Can be specified as a fully-qualified path, as the application name (if the application is in PATH environment variables), or by using environment variables (%PROGRAMFILES%, %USERPFOFILE%).

userName - The user name (in the format Domain\UserName) to be used to run the application.

password - The user's password.

Returns:

The TestProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runAs

public TestProcess runAs(String path,
                         String userName,
                         String password,
                         String commandLine)
                  throws ApiException,
                         HttpException

Runs an application under another user account and returns the application process object.

Parameters:

path - The path to the application. Can be specified as a fully-qualified path, as the application name (if the application is in PATH environment variables), or by using environment variables (%PROGRAMFILES%, %USERPFOFILE%).

userName - The user name (in the format Domain\UserName) to be used to run the application.

password - The user's password.

commandLine - Command-line arguments for the application.

Returns:

The TestProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runAs

public TestProcess runAs(String path,
                         String userName,
                         String password,
                         String commandLine,
                         String workingFolder)
                  throws ApiException,
                         HttpException

Runs an application under another user account and returns the application process object.

Parameters:

path - The path to the application. Can be specified as a fully-qualified path, as the application name (if the application is in PATH environment variables), or by using environment variables (%PROGRAMFILES%, %USERPFOFILE%).

userName - The user name (in the format Domain\UserName) to be used to run the application.

password - The user's password.

commandLine - Command-line arguments for the application.

workingFolder - The path to the working folder of the application.

Returns:

The TestProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runPackage

public WinRTProcess runPackage(String packageName)
                        throws ApiException,
                               HttpException

Runs a Windows Store application package and returns the application process object.

Parameters:

packageName - The application package name as it is specified in the package manifest.

Returns:

The WinRTProcess object that corresponds to the launched application instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserInfo info)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

info - The BrowserInfo object that specifies the browser to run. Use the testLeft.driver.getApplications().getBrowsers() property to get a list of BrowserInfo objects for all installed browsers. To learn more, see Run a Web Browser in TestLeft documentation.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserInfo info,
                             String url)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

info - The BrowserInfo object that specifies the browser to run. Use the testLeft.driver.getApplications().getBrowsers() property to get a list of BrowserInfo objects for all installed browsers. To learn more, see Run a Web Browser in TestLeft documentation.

url - The URL of the web page to open in the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserInfo info,
                             String url,
                             Integer waitTime)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

info - The BrowserInfo object that specifies the browser to run. Use the testLeft.driver.getApplications().getBrowsers() property to get a list of BrowserInfo objects for all installed browsers. To learn more, see Run a Web Browser in TestLeft documentation.

url - The URL of the web page to open in the browser.

waitTime - The time (in milliseconds) to wait until the browser loads the page and becomes ready to accept user input.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserInfo info,
                             String url,
                             Integer waitTime,
                             String additionalCommandLine)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

info - The BrowserInfo object that specifies the browser to run. Use the testLeft.driver.getApplications().getBrowsers() property to get a list of BrowserInfo objects for all installed browsers. To learn more, see Run a Web Browser in TestLeft documentation.

url - The URL of the web page to open in the browser.

waitTime - The time (in milliseconds) to wait until the browser loads the page and becomes ready to accept user input.

additionalCommandLine - Command-line arguments for the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserInfo info,
                             String url,
                             String additionalCommandLine)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

info - The BrowserInfo object that specifies the browser to run. Use the testLeft.driver.getApplications().getBrowsers() property to get a list of BrowserInfo objects for all installed browsers. To learn more, see Run a Web Browser in TestLeft documentation.

url - The URL of the web page to open in the browser.

additionalCommandLine - Command-line arguments for the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             PlatformType platform)
                      throws ApiException,
                             HttpException

Launches a web browser of a particular bitness (32-bit or 64-bit). The method pauses the execution until the browser loads the page and becomes ready to accept user input, or until the specified timeout is reached.

Parameters:

family - The browser's family name.

platform - The browser bitness - 32-bit, 64-bit or any.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             PlatformType platform,
                             String url)
                      throws ApiException,
                             HttpException

Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page. The method pauses the execution until the browser loads the page and becomes ready to accept user input, or until the specified timeout is reached.

Parameters:

family - The browser's family name.

platform - The browser bitness - 32-bit, 64-bit or any.

url - The URL of the web page to open in the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             PlatformType platform,
                             String url,
                             Integer waitTime)
                      throws ApiException,
                             HttpException

Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page. The method pauses the execution until the browser loads the page and becomes ready to accept user input, or until the specified timeout is reached.

Parameters:

family - The browser's family name.

platform - The browser bitness - 32-bit, 64-bit or any.

url - The URL of the web page to open in the browser.

waitTime - The time (in milliseconds) to wait until the browser loads the page and becomes ready to accept user input.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             PlatformType platform,
                             String url,
                             Integer waitTime,
                             String additionalCommandLine)
                      throws ApiException,
                             HttpException

Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page. The method pauses the execution until the browser loads the page and becomes ready to accept user input, or until the specified timeout is reached.

Parameters:

family - The browser's family name.

platform - The browser bitness - 32-bit, 64-bit or any.

url - The URL of the web page to open in the browser.

waitTime - The time (in milliseconds) to wait until the browser loads the page and becomes ready to accept user input.

additionalCommandLine - Command-line arguments for the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             PlatformType platform,
                             String url,
                             String additionalCommandLine)
                      throws ApiException,
                             HttpException

Launches a web browser of a particular bitness (32-bit or 64-bit) and, if a URL is specified, navigates to the web page. The method pauses the execution until the browser loads the page and becomes ready to accept user input, or until the specified timeout is reached.

Parameters:

family - The browser's family name.

platform - The browser bitness - 32-bit, 64-bit or any.

url - The URL of the web page to open in the browser.

additionalCommandLine - Command-line arguments for the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

family - The browser's family name.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             String url)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

family - The browser's family name.

url - The URL of the web page to open in the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             String url,
                             int waitTime)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

family - The browser's family name.

url - The URL of the web page to open in the browser.

waitTime - The time (in milliseconds) to wait until the browser loads the page and becomes ready to accept user input.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             String url,
                             int waitTime,
                             String additionalCommandLine)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

family - The browser's family name.

url - The URL of the web page to open in the browser.

waitTime - The time (in milliseconds) to wait until the browser loads the page and becomes ready to accept user input.

additionalCommandLine - Command-line arguments for the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.

runBrowser

public WebBrowser runBrowser(BrowserType family,
                             String url,
                             String additionalCommandLine)
                      throws ApiException,
                             HttpException

Launches a web browser and, if a URL is specified, navigates to the web page.

Parameters:

family - The browser's family name.

url - The URL of the web page to open in the browser.

additionalCommandLine - Command-line arguments for the browser.

Returns:

The WebBrowser object that corresponds to the launched browser instance.

Throws:

ApiException - Thrown if the application cannot be launched.

HttpException - Thrown if there are network problems.