Package com.browserstack.local

Class Local

java.lang.Object

com.browserstack.local.Local

public class Local
extends Object

Creates and manages a secure tunnel connection to BrowserStack.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Local.LocalProcess

Constructor Summary

Constructors

Constructor	Description
Local()

Method Summary

Modifier and Type	Method	Description
boolean	isRunning()	Checks if Local instance is running
protected Local.LocalProcess	runCommand(List<String> command)	Executes the supplied command on the shell.
void	start(Map<String,String> options)	Starts Local instance with options
void	stop()	Stops the Local instance
void	stop(Map<String,String> options)	Stops the Local instance specified by the given identifier

Methods inherited from class java.lang.Object

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

Constructor Details

Local

public Local()

Method Details

start

public void start(Map<String,String> options)
           throws Exception

Starts Local instance with options

Parameters:

options - Options for the Local instance

Throws:

Exception

stop

public void stop()
          throws Exception

Stops the Local instance

Throws:

InterruptedException

Exception

stop

public void stop(Map<String,String> options)
          throws Exception

Stops the Local instance specified by the given identifier

Parameters:

options - Options supplied for the Local instance

Throws:

Exception

isRunning

public boolean isRunning()
                  throws Exception

Checks if Local instance is running

Returns:

true if Local instance is running, else false

Throws:

Exception

runCommand

protected Local.LocalProcess runCommand(List<String> command)
                                 throws IOException

Executes the supplied command on the shell.

Parameters:

command - Command to be executed on the shell.

Returns:

Local.LocalProcess for managing the launched process.

Throws:

IOException