com.browserstack.client

Class BrowserStackClient

java.lang.Object

com.browserstack.client.BrowserStackClient

All Implemented Interfaces:

BrowserStackClientInterface

Direct Known Subclasses:

AppAutomateClient, AutomateClient

public abstract class BrowserStackClient
extends Object
implements BrowserStackClientInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BrowserStackClient.Method
static class	BrowserStackClient.Product

Field Summary

Fields

Modifier and Type	Field and Description
protected BrowserStackCache<String,Object>	cacheMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BrowserStackClient()
	BrowserStackClient(String baseUrl, String username, String accessKey)

Method Summary

Modifier and Type	Method and Description
boolean	deleteBuild(String buildId) Delete the build identified by the build identifier.
protected String	getAccessKey()
protected BrowserListing	getBrowsersForProduct(BrowserStackClient.Product product)
protected BrowserListing	getBrowsersForProduct(BrowserStackClient.Product product, boolean cache)
Build	getBuild(String buildId) Gets the build identified by the build identifier.
Build	getBuildByName(String buildName) Gets the build identified using 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 via build status and the count required
List<Build>	getBuilds(Automate.BuildStatus status, int limit, String buildName) Gets the list of builds.
List<Build>	getBuilds(int limit) Gets the list of builds.
Session	getSession(String sessionId)
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.
protected BrowserStackRequest	newRequest(BrowserStackClient.Method method, String path)
protected BrowserStackRequest	newRequest(BrowserStackClient.Method method, String path, boolean prependUrl)
protected BrowserStackRequest	newRequest(BrowserStackClient.Method method, String path, Map<String,Object> data)
protected BrowserStackRequest	newRequest(BrowserStackClient.Method method, String path, Map<String,Object> data, Map<String,String> headers)
protected void	setAccessKey(String accessKey)
void	setProxy(String proxyHost, int proxyPort, String proxyUsername, String proxyPassword) Sets proxy configuration for requests
protected BrowserStackRequest	signRequest(com.google.api.client.http.HttpRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

cacheMap

protected final BrowserStackCache<String,Object> cacheMap

Constructor Detail

BrowserStackClient

protected BrowserStackClient()

BrowserStackClient

public BrowserStackClient(String baseUrl,
                          String username,
                          String accessKey)

Method Detail

setProxy

public void setProxy(String proxyHost,
                     int proxyPort,
                     String proxyUsername,
                     String proxyPassword)

Sets proxy configuration for requests

Specified by:

setProxy in interface BrowserStackClientInterface

Parameters:

proxyHost - Host of the proxy

proxyPort - Port of the proxy

proxyUsername - Username of proxy

proxyPassword - password of the proxy

getAccessKey

protected String getAccessKey()

setAccessKey

protected void setAccessKey(String accessKey)

getBrowsersForProduct

protected BrowserListing getBrowsersForProduct(BrowserStackClient.Product product)
                                        throws BrowserStackException

Throws:

BrowserStackException

getBrowsersForProduct

protected BrowserListing getBrowsersForProduct(BrowserStackClient.Product product,
                                               boolean cache)
                                        throws BrowserStackException

Throws:

BrowserStackException

newRequest

protected BrowserStackRequest newRequest(BrowserStackClient.Method method,
                                         String path)
                                  throws BrowserStackException

Throws:

BrowserStackException

newRequest

protected BrowserStackRequest newRequest(BrowserStackClient.Method method,
                                         String path,
                                         boolean prependUrl)
                                  throws BrowserStackException

Throws:

BrowserStackException

newRequest

protected BrowserStackRequest newRequest(BrowserStackClient.Method method,
                                         String path,
                                         Map<String,Object> data)
                                  throws BrowserStackException

Throws:

BrowserStackException

newRequest

protected BrowserStackRequest newRequest(BrowserStackClient.Method method,
                                         String path,
                                         Map<String,Object> data,
                                         Map<String,String> headers)
                                  throws BrowserStackException

Throws:

BrowserStackException

signRequest

protected BrowserStackRequest signRequest(com.google.api.client.http.HttpRequest request)

getBuilds

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

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Parameters:

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

limit - Limit results to the specified count.

buildName - build name to be searched with.

Returns:

List of Build objects.

Throws:

BrowserStackException - Browserstack exception object.

getBuilds

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

Gets the list of builds via build status and the count required

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Parameters:

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

limit - Limit results to the specified count.

Returns:

List of Build objects.

Throws:

BrowserStackException - Browserstack exception object.

getBuilds

public List<Build> getBuilds()
                      throws BrowserStackException

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Returns:

List of Build objects.

Throws:

BrowserStackException - Browserstack exception object.

getBuilds

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

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Parameters:

limit - Limit results to the specified count.

Returns:

List of Build objects.

Throws:

BrowserStackException - Browserstack exception object.

getBuilds

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

Gets the list of builds.

A build is an organizational structure for tests.

Specified by:

getBuilds in interface BrowserStackClientInterface

Parameters:

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

Returns:

List of Build objects.

Throws:

BrowserStackException - Browserstack exception object.

getBuild

public Build getBuild(String buildId)
               throws BuildNotFound,
                      BrowserStackException

Gets the build identified by the build identifier.

Specified by:

getBuild in interface BrowserStackClientInterface

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

List of Build objects.

Throws:

BuildNotFound - could not find build with given id

BrowserStackException - Browserstack exception object.

getBuildByName

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

Gets the build identified using the build name.

Specified by:

getBuildByName in interface BrowserStackClientInterface

Parameters:

buildName - Name of the build which will be used for searching

Returns:

Build object

Throws:

BuildNotFound - could not find build with given id

BrowserStackException - Browserstack exception object.

deleteBuild

public boolean deleteBuild(String buildId)
                    throws BrowserStackException

Delete the build identified by the build identifier.

Specified by:

deleteBuild in interface BrowserStackClientInterface

Parameters:

buildId - ID that uniquely identifies a build.

Returns:

true or false based on successful deletion of the build.

Throws:

BrowserStackException - Browserstack exception object.

getSessions

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

Retrieves the list of sessions existing under a specific build. If no limit is specified, all the sessions will be fetched from that build

Specified by:

getSessions in interface BrowserStackClientInterface

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

BrowserStackException - Browserstack exception object.

getSessions

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

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

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

BrowserStackException - Browserstack exception object.

getSessions

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

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

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

BrowserStackException - Browserstack exception object.

getSessions

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

Retrieves the list of sessions existing under a specific build.

Specified by:

getSessions in interface BrowserStackClientInterface

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

BrowserStackException - Browserstack exception object.

getSession

public Session getSession(String sessionId)
                   throws SessionNotFound,
                          BrowserStackException

Specified by:

getSession in interface BrowserStackClientInterface

Parameters:

sessionId - ID that uniquely identifies a session.

Returns:

Session objects containing test session information.

Throws:

SessionNotFound - could not find session with given id

BrowserStackException - Browserstack exception object.