com.browserstack.automate

Class AutomateClient

java.lang.Object

com.browserstack.client.BrowserStackClient

com.browserstack.automate.AutomateClient

All Implemented Interfaces:

Automate, BrowserStackClientInterface

public final class AutomateClient
extends BrowserStackClient
implements Automate

Access and manage information about your BrowserStack Automate tests.

Nested Class Summary

Nested classes/interfaces inherited from class com.browserstack.client.BrowserStackClient

BrowserStackClient.Method, BrowserStackClient.Product

Nested classes/interfaces inherited from interface com.browserstack.automate.Automate

Automate.BuildStatus, Automate.SessionStatus

Field Summary

Fields inherited from class com.browserstack.client.BrowserStackClient

cacheMap

Constructor Summary

Constructors

Constructor and Description
AutomateClient(String username, String accessKey) Construct an instance of AutomateClient with your BrowserStack account credentials.

Method Summary

Modifier and Type	Method and Description
boolean	deleteBuild(String buildId) Delete the build identified by the build identifier.
boolean	deleteProject(int projectId) Deletes the project identified by the specified project identifier.
boolean	deleteSession(String sessionId) Deletes the session identified by the supplied identifier.
AccountUsage	getAccountUsage() Returns details for the BrowserStack Automate plan.
List<Browser>	getBrowsers() Returns a (cached) list of Desktop and Mobile browsers offered for Automate.
List<Browser>	getBrowsers(boolean cache) Returns a (cached) list of Desktop and Mobile browsers offered for Automate.
Build	getBuild(String buildId) Gets the build identified by the build identifier.
Build	getBuildByName(String buildName) Gets the build identified by the build name.
List<Build>	getBuilds() Gets the list of builds.
List<Build>	getBuilds(Automate.BuildStatus status) Gets the list of builds.
List<Build>	getBuilds(Automate.BuildStatus status, int limit) Gets the list of builds.
List<Build>	getBuilds(int limit) Gets the list of builds.
Project	getProject(int projectId) Gets the project identified by its identifier.
List<Project>	getProjects() Gets a list of projects Projects are organizational structures for builds.
Session	getSession(String sessionId) Gets the session associated with the specified identifier.
String	getSessionLogs(Session session) Fetches the text logs for a session.
String	getSessionLogs(String sessionId) Fetches the text logs for a session.
List<Session>	getSessions(String buildId) Retrieves the list of sessions existing under a specific build.
List<Session>	getSessions(String buildId, Automate.BuildStatus status) Retrieves the list of sessions existing under a specific build.
List<Session>	getSessions(String buildId, Automate.BuildStatus status, int limit) Retrieves the list of sessions existing under a specific build.
List<Session>	getSessions(String buildId, int limit) Retrieves the list of sessions existing under a specific build.
String	getSessionVideo(String sessionId) Returns the link for the session video.
String	recycleKey() Destroys the current access key and returns a new access key.
Session	updateSessionStatus(String sessionId, Automate.SessionStatus sessionStatus) Updates the status for a session.
Session	updateSessionStatus(String sessionId, Automate.SessionStatus sessionStatus, String reason) Updates the status for a session.
Session	updateSessionStatus(String sessionId, Map<String,Object> data) Updates the status for a session.

Methods inherited from class com.browserstack.client.BrowserStackClient

getAccessKey, getBrowsersForProduct, getBrowsersForProduct, getBuilds, newRequest, newRequest, newRequest, newRequest, setAccessKey, setProxy, signRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomateClient

public AutomateClient(String username,
                      String accessKey)

Construct an instance of AutomateClient with your BrowserStack account credentials. Go here to get them.

Parameters:

username - Username for your BrowserStack Automate account.

accessKey - Access Key for your BrowserStack Automate account.

Method Detail

getAccountUsage

public AccountUsage getAccountUsage()
                             throws AutomateException

Returns details for the BrowserStack Automate plan.

Specified by:

getAccountUsage in interface Automate

Returns:

an instance of AccountUsage containing subscription details.

Throws:

AutomateException - exception object for Automate sessions.

getBrowsers

public List<Browser> getBrowsers()
                          throws AutomateException

Returns a (cached) list of Desktop and Mobile browsers offered for Automate.

Specified by:

getBrowsers in interface Automate

Returns:

List of Browser objects

Throws:

AutomateException - exception object for Automate sessions.

getBrowsers

public List<Browser> getBrowsers(boolean cache)
                          throws AutomateException

Returns a (cached) list of Desktop and Mobile browsers offered for Automate.

Specified by:

getBrowsers in interface Automate

Parameters:

cache - Enable (true) or disable (false) returning of cached responses.

Returns:

List of Browser objects

Throws:

AutomateException - exception object for Automate sessions.

getProjects

public List<Project> getProjects()
                          throws AutomateException

Gets a list of projects

Projects are organizational structures for builds.

Specified by:

getProjects in interface Automate

Returns:

List of Project objects

Throws:

AutomateException - exception object for Automate sessions.

getProject

public Project getProject(int projectId)
                   throws ProjectNotFound,
                          AutomateException

Gets the project identified by its identifier.

Specified by:

getProject in interface Automate

Parameters:

projectId - id for the project to be retrieved.

Returns:

List of Project objects

Throws:

ProjectNotFound - could not find project with given id

AutomateException - exception object for Automate sessions.

deleteProject

public boolean deleteProject(int projectId)
                      throws AutomateException

Deletes the project identified by the specified project identifier.

Specified by:

deleteProject in interface Automate

Parameters:

projectId - id for the project to be deleted.

Returns:

true or false based on successful deletion of the project.

Throws:

AutomateException - exception object for Automate sessions.

getBuilds

public List<Build> getBuilds(Automate.BuildStatus status,
                             int limit)
                      throws AutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Parameters:

status - Return only builds that match the specified build status.

limit - Limit results to the specified count.

Returns:

List of Build objects.

Throws:

AutomateException - exception object for Automate sessions.

getBuilds

public List<Build> getBuilds()
                      throws AutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Returns:

List of Build objects.

Throws:

AutomateException - exception object fdr Automate sessions.

getBuilds

public List<Build> getBuilds(int limit)
                      throws AutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Parameters:

limit - Limit results to the specified count.

Returns:

List of Build objects.

Throws:

AutomateException - exception object for Automate sessions.

getBuilds

public List<Build> getBuilds(Automate.BuildStatus status)
                      throws AutomateException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Overrides:

getBuilds in class BrowserStackClient

Parameters:

status - Include only builds that match the specified build status.

Returns:

List of Build objects.

Throws:

AutomateException - exception object for Automate sessions.

getBuild

public Build getBuild(String buildId)
               throws BuildNotFound,
                      AutomateException

Gets the build identified by the build identifier.

Specified by:

getBuild in interface BrowserStackClientInterface

Overrides:

getBuild in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

List of Build objects.

Throws:

BuildNotFound - could not find build with given id.

AutomateException - exception object for Automate sessions.

getBuildByName

public Build getBuildByName(@Nonnull
                            String buildName)
                     throws BuildNotFound,
                            AutomateException

Gets the build identified by the build name.

Specified by:

getBuildByName in interface BrowserStackClientInterface

Overrides:

getBuildByName in class BrowserStackClient

Parameters:

buildName - - Name of the build to search with

Returns:

Build object.

Throws:

BuildNotFound - could not find build with given id.

AutomateException - exception object for Automate sessions.

deleteBuild

public boolean deleteBuild(String buildId)
                    throws AutomateException

Delete the build identified by the build identifier.

Specified by:

deleteBuild in interface BrowserStackClientInterface

Overrides:

deleteBuild in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

true or false based on successful deletion of the build.

Throws:

AutomateException - exception object for Automate sessions.

getSessions

public List<Session> getSessions(String buildId,
                                 Automate.BuildStatus status,
                                 int limit)
                          throws BuildNotFound,
                                 AutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

status - Include only builds that match the specified build status.

limit - Limit results to the specified count.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id.

AutomateException - exception object for Automate sessions.

getSessions

public List<Session> getSessions(String buildId)
                          throws BuildNotFound,
                                 AutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id.

AutomateException - exception object for Automate sessions.

getSessions

public List<Session> getSessions(String buildId,
                                 int limit)
                          throws BuildNotFound,
                                 AutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

limit - Limit results to the specified count.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id.

AutomateException - exception object for Automate sessions.

getSessions

public List<Session> getSessions(String buildId,
                                 Automate.BuildStatus status)
                          throws BuildNotFound,
                                 AutomateException

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

Overrides:

getSessions in class BrowserStackClient

Parameters:

buildId - ID that uniquely identifies a build.

status - Include only builds that match the specified build status.

Returns:

List of Session objects containing test session information.

Throws:

BuildNotFound - could not find build with given id.

AutomateException - exception object for Automate sessions.

getSession

public Session getSession(String sessionId)
                   throws SessionNotFound,
                          AutomateException

Gets the session associated with the specified identifier.

Specified by:

getSession in interface BrowserStackClientInterface

Overrides:

getSession in class BrowserStackClient

Parameters:

sessionId - ID that uniquely identifies a session.

Returns:

Session objects containing test session information.

Throws:

AutomateException - exception object for Automate sessions.

SessionNotFound - could not find session with given id

updateSessionStatus

public Session updateSessionStatus(String sessionId,
                                   Map<String,Object> data)
                            throws AutomateException

Updates the status for a session.

Specified by:

updateSessionStatus in interface Automate

Parameters:

sessionId - ID that uniquely identifies a session.

data - Key-Value pairs containing session update information.

Returns:

Updated Session object.

Throws:

AutomateException - exception object for Automate sessions.

updateSessionStatus

public Session updateSessionStatus(String sessionId,
                                   Automate.SessionStatus sessionStatus,
                                   String reason)
                            throws SessionNotFound,
                                   AutomateException

Updates the status for a session.

Specified by:

updateSessionStatus in interface Automate

Parameters:

sessionId - ID that uniquely identifies a session.

sessionStatus - State with which the session should be marked (Error, Done).

reason - Message containing reason for marking session with new status.

Returns:

Updated Session object.

Throws:

SessionNotFound - could not find session with given id.

AutomateException - exception object for Automate sessions.

updateSessionStatus

public Session updateSessionStatus(String sessionId,
                                   Automate.SessionStatus sessionStatus)
                            throws SessionNotFound,
                                   AutomateException

Updates the status for a session.

Specified by:

updateSessionStatus in interface Automate

Parameters:

sessionId - ID that uniquely identifies a session.

sessionStatus - State with which the session should be marked (Error, Done).

Returns:

Updated Session object.

Throws:

SessionNotFound - could not find session with given id.

AutomateException - exception object for Automate sessions.

getSessionLogs

public String getSessionLogs(String sessionId)
                      throws SessionNotFound,
                             AutomateException

Fetches the text logs for a session.

Specified by:

getSessionLogs in interface Automate

Parameters:

sessionId - ID that uniquely identifies a session.

Returns:

Raw text logs for the session.

Throws:

SessionNotFound - could not find session with given id.

AutomateException - exception object for Automate sessions.

getSessionLogs

public String getSessionLogs(Session session)
                      throws AutomateException

Fetches the text logs for a session.

Specified by:

getSessionLogs in interface Automate

Parameters:

session - Session for which to retrieve logs.

Returns:

Raw text logs for the session.

Throws:

AutomateException - exception object for Automate sessions.

getSessionVideo

public String getSessionVideo(String sessionId)
                       throws SessionNotFound,
                              AutomateException

Returns the link for the session video.

Specified by:

getSessionVideo in interface Automate

Parameters:

sessionId - ID that uniquely identifies a session.

Returns:

Web link to the video for the session.

Throws:

SessionNotFound - could not find session with given id.

AutomateException - exception object for Automate sessions.

deleteSession

public boolean deleteSession(String sessionId)
                      throws SessionNotFound,
                             AutomateException

Deletes the session identified by the supplied identifier.

Specified by:

deleteSession in interface Automate

Parameters:

sessionId - ID that uniquely identifies a session.

Returns:

true or false depending on successful deletion.

Throws:

SessionNotFound - could not find session with given id.

AutomateException - exception object for Automate sessions.

recycleKey

public String recycleKey()
                  throws AutomateException

Destroys the current access key and returns a new access key.

Note that all uses of the current key will need to be updated.

Specified by:

recycleKey in interface Automate

Returns:

the new access key.

Throws:

AutomateException - exception for Automate sessions.