com.android.builder.testing.api

Class DeviceConnector

java.lang.Object

com.android.builder.testing.api.DeviceConnector

All Implemented Interfaces:

com.android.ddmlib.IShellEnabledDevice

@Beta
public abstract class DeviceConnector
extends java.lang.Object
implements com.android.ddmlib.IShellEnabledDevice

A connector to a device to install/uninstall APKs, and run shell command.

Constructor Summary

Constructors

Constructor and Description
DeviceConnector()

Method Summary

Modifier and Type	Method and Description
abstract void	connect(int timeOut, com.android.utils.ILogger logger) Establishes the connection with the device.
abstract void	disconnect(int timeOut, com.android.utils.ILogger logger) Disconnects from the device.
abstract java.util.List<java.lang.String>	getAbis() The device supported ABIs.
abstract java.lang.String	getApiCodeName() Returns the API codename for the device, or null if it's a release device.
abstract int	getApiLevel() Returns the API level of the device, or 0 if it could not be queried.
abstract int	getDensity() Returns the screen density bucket for the device.
abstract DeviceConfig	getDeviceConfig()
abstract int	getHeight()
abstract java.lang.String	getLanguage() Returns the user's language.
abstract java.util.Set<java.lang.String>	getLanguageSplits() Returns the language strings for 21+ config splits.
abstract java.lang.String	getNullableProperty(java.lang.String propertyName)
abstract java.lang.String	getProperty(java.lang.String propertyName)
abstract java.lang.String	getRegion() Returns the user's region.
abstract java.lang.String	getSerialNumber() Returns the serial number of the device.
abstract com.android.ddmlib.IDevice.DeviceState	getState() Returns the IDevice.DeviceState for the device, or null if if cannot determined.
abstract int	getWidth()
abstract void	installPackage(java.io.File apkFile, java.util.Collection<java.lang.String> options, int timeout, com.android.utils.ILogger logger) Installs the given APK on the device.
abstract void	installPackages(java.util.List<java.io.File> apkFiles, java.util.Collection<java.lang.String> options, int timeoutInMs, com.android.utils.ILogger logger) Installs the given APK files on the device.
abstract void	pullFile(java.lang.String remote, java.lang.String local) Pulls a single file.
abstract void	uninstallPackage(java.lang.String packageName, int timeout, com.android.utils.ILogger logger) Uninstall the given package name from the device

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.android.ddmlib.IShellEnabledDevice

executeShellCommand, executeShellCommand, getName, getSystemProperty

Constructor Detail

DeviceConnector

public DeviceConnector()

Method Detail

connect

public abstract void connect(int timeOut,
                             com.android.utils.ILogger logger)
                      throws com.android.ddmlib.TimeoutException

Establishes the connection with the device. Called before any other actions.

Parameters:

timeOut - the time out.

Throws:

com.android.ddmlib.TimeoutException

disconnect

public abstract void disconnect(int timeOut,
                                com.android.utils.ILogger logger)
                         throws com.android.ddmlib.TimeoutException

Disconnects from the device. No other action is called afterwards.

Parameters:

timeOut - the time out.

Throws:

com.android.ddmlib.TimeoutException

installPackage

public abstract void installPackage(@NonNull
                                    java.io.File apkFile,
                                    @NonNull
                                    java.util.Collection<java.lang.String> options,
                                    int timeout,
                                    com.android.utils.ILogger logger)
                             throws DeviceException

Installs the given APK on the device.

Parameters:

apkFile - the APK file to install.

timeout - the time out.

logger - the logger to use to log debug, warnings and errors.

Throws:

DeviceException

installPackages

public abstract void installPackages(@NonNull
                                     java.util.List<java.io.File> apkFiles,
                                     @NonNull
                                     java.util.Collection<java.lang.String> options,
                                     int timeoutInMs,
                                     com.android.utils.ILogger logger)
                              throws DeviceException

Installs the given APK files on the device. It requires a device with API level 21+ otherwise a DeviceException will be thrown.

Parameters:

apkFiles - the APK files to install.

options - the install options.

timeoutInMs - the time out in milliseconds.

logger - the logger to use to log debug, warnings and errors.

Throws:

DeviceException

uninstallPackage

public abstract void uninstallPackage(@NonNull
                                      java.lang.String packageName,
                                      int timeout,
                                      com.android.utils.ILogger logger)
                               throws DeviceException

Uninstall the given package name from the device

Parameters:

packageName - the package name

timeout - the time out

Throws:

DeviceException

pullFile

public abstract void pullFile(java.lang.String remote,
                              java.lang.String local)
                       throws java.io.IOException

Pulls a single file.

Parameters:

remote - the full path to the remote file

local - The local destination.

Throws:

java.io.IOException - in case of an IO exception.

getSerialNumber

@NonNull
public abstract java.lang.String getSerialNumber()

Returns the serial number of the device.

getApiLevel

public abstract int getApiLevel()

Returns the API level of the device, or 0 if it could not be queried.

Returns:

the api level

getApiCodeName

@Nullable
public abstract java.lang.String getApiCodeName()

Returns the API codename for the device, or null if it's a release device.

Returns:

the API codename

getState

@Nullable
public abstract com.android.ddmlib.IDevice.DeviceState getState()

Returns the IDevice.DeviceState for the device, or null if if cannot determined.

Returns:

the device state.

getAbis

@NonNull
public abstract java.util.List<java.lang.String> getAbis()

The device supported ABIs. This is in preferred order.

Returns:

the list of supported ABIs

getDensity

public abstract int getDensity()

Returns the screen density bucket for the device.

Returns:

the density.

getHeight

public abstract int getHeight()

getWidth

public abstract int getWidth()

getLanguage

@Nullable
public abstract java.lang.String getLanguage()

Returns the user's language.

Returns:

the user's language or null if it's unknown.

getLanguageSplits

@Nullable
public abstract java.util.Set<java.lang.String> getLanguageSplits()
                                                                     throws com.android.ddmlib.TimeoutException,
                                                                            com.android.ddmlib.AdbCommandRejectedException,
                                                                            com.android.ddmlib.ShellCommandUnresponsiveException,
                                                                            java.io.IOException

Returns the language strings for 21+ config splits.

Returns:

the list of languages or null if the device is <21

Throws:

com.android.ddmlib.TimeoutException

com.android.ddmlib.AdbCommandRejectedException

com.android.ddmlib.ShellCommandUnresponsiveException

java.io.IOException

getRegion

@Nullable
public abstract java.lang.String getRegion()

Returns the user's region.

Returns:

the user's region or null if it's unknown

getProperty

@NonNull
public abstract java.lang.String getProperty(@NonNull
                                                      java.lang.String propertyName)

getNullableProperty

@Nullable
public abstract java.lang.String getNullableProperty(@NonNull
                                                               java.lang.String propertyName)

getDeviceConfig

@NonNull
public abstract DeviceConfig getDeviceConfig()
                                               throws DeviceException

Throws:

DeviceException