io.appium.java_client.service.local

Class AppiumDriverLocalService

java.lang.Object

org.openqa.selenium.remote.service.DriverService

io.appium.java_client.service.local.AppiumDriverLocalService

public final class AppiumDriverLocalService
extends org.openqa.selenium.remote.service.DriverService

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.remote.service.DriverService

org.openqa.selenium.remote.service.DriverService.Builder<DS extends org.openqa.selenium.remote.service.DriverService,B extends org.openqa.selenium.remote.service.DriverService.Builder<?,?>>

Method Summary

Modifier and Type	Method and Description
void	addOutPutStream(java.io.OutputStream outputStream) Adds other output stream which should accept server output data.
void	addOutPutStreams(java.util.List<java.io.OutputStream> outputStreams) Adds other output streams which should accept server output data.
static AppiumDriverLocalService	buildDefaultService()
static AppiumDriverLocalService	buildService(AppiumServiceBuilder builder)
boolean	clearOutPutStreams() Remove all existing server output streams.
java.lang.String	getStdOut() Logs as string.
java.net.URL	getUrl() Base URL.
boolean	isRunning()
void	start() Starts the defined appium server.
void	stop() Stops this service is it is currently running.

Methods inherited from class org.openqa.selenium.remote.service.DriverService

checkExecutable, findExecutable, getOutputStream, getUrl, hasShutdownEndpoint, sendOutputTo, waitUntilAvailable

Methods inherited from class java.lang.Object

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

Method Detail

buildDefaultService

public static AppiumDriverLocalService buildDefaultService()

buildService

public static AppiumDriverLocalService buildService(AppiumServiceBuilder builder)

getUrl

public java.net.URL getUrl()

Base URL.

Overrides:

getUrl in class org.openqa.selenium.remote.service.DriverService

Returns:

The base URL for the managed appium server.

isRunning

public boolean isRunning()

Overrides:

isRunning in class org.openqa.selenium.remote.service.DriverService

start

public void start()
           throws AppiumServerHasNotBeenStartedLocallyException

Starts the defined appium server.

Overrides:

start in class org.openqa.selenium.remote.service.DriverService

Throws:

AppiumServerHasNotBeenStartedLocallyException - If an error occurs while spawning the child process.

See Also:

stop()

stop

public void stop()

Stops this service is it is currently running. This method will attempt to block until the server has been fully shutdown.

Overrides:

stop in class org.openqa.selenium.remote.service.DriverService

See Also:

start()

getStdOut

@Nullable
public java.lang.String getStdOut()

Logs as string.

Returns:

String logs if the server has been run. null is returned otherwise.

addOutPutStream

public void addOutPutStream(java.io.OutputStream outputStream)

Adds other output stream which should accept server output data.

Parameters:

outputStream - is an instance of OutputStream that is ready to accept server output

addOutPutStreams

public void addOutPutStreams(java.util.List<java.io.OutputStream> outputStreams)

Adds other output streams which should accept server output data.

Parameters:

outputStreams - is a list of additional OutputStream that are ready to accept server output

clearOutPutStreams

public boolean clearOutPutStreams()

Remove all existing server output streams.

Returns:

true if at least one output stream has been cleared