org.arquillian.droidium.container.api

Interface AndroidDevice

public interface AndroidDevice

Representation of Android Device

Author:

Karel Piwko, Stefan Miklosovic

Method Summary

Methods

Modifier and Type	Method and Description
void	createPortForwarding(int localPort, int remotePort) Creates a port forwarding between a local and a remote port.
void	executeShellCommand(String command) Executes a shell command on the device.
void	executeShellCommand(String command, AndroidDeviceOutputReciever reciever) Executes a shell command on the device
ActivityManagerProvider	getActivityManagerProvider()
String	getAvdName() Returns name of Android Virtual Device.
String	getConsolePort()
int	getDroneGuestPort() Guest port is port on the Android device side
int	getDroneHostPort() Host is your local computer.
Map<String,String>	getProperties() Returns a map of properties available for the device.
String	getProperty(String name) Returns a value of property with given name
Screenshot	getScreenshot() Gets a screenshot of underlying Android device.
String	getSerialNumber() Returns serial number of device.
void	installPackage(File packageFilePath, boolean reinstall, String... extraArgs) Installs an Android application on device.
boolean	isEmulator() Checks if the device is an emulator
boolean	isOffline() Checks if the device is offline.
boolean	isOnline() Checks if the device is online
boolean	isPackageInstalled(String packageName) Checks if an APK package of name packageName is installed or not.
void	removePortForwarding(int localPort, int remotePort) Removes a port forwarding between a local and a remote port.
void	setActivityManagerProvider(ActivityManagerProvider activityManagerProvider)
void	setDroneGuestPort(int droneGuestPort) Guest port is port on the Android device side
void	setDroneHostPort(int droneHostPort) Host is your local computer
void	uninstallPackage(String packageName) Uninstalls an package from the device.

Method Detail

getSerialNumber

String getSerialNumber()

Returns serial number of device.

Returns:

Serial number

getAvdName

String getAvdName()

Returns name of Android Virtual Device.

Returns:

Either a virtual device name or null if device is not an emulator

getProperties

Map<String,String> getProperties()

Returns a map of properties available for the device. These properties are cached.

Returns:

A properties map

getProperty

String getProperty(String name)
                   throws IOException,
                          AndroidExecutionException

Returns a value of property with given name

Parameters:

name - A key

Returns:

Value of property or null if not present

Throws:

IOException

AndroidExecutionException

isOnline

boolean isOnline()

Checks if the device is online

Returns:

true if device is online, false otherwise

isEmulator

boolean isEmulator()

Checks if the device is an emulator

Returns:

true if device is an emulator, false otherwise

isOffline

boolean isOffline()

Checks if the device is offline.

Returns:

true if device is offline, false otherwise

executeShellCommand

void executeShellCommand(String command)
                         throws AndroidExecutionException

Executes a shell command on the device. Silently discards command output.

Parameters:

command - The command to be executed

Throws:

AndroidExecutionException

executeShellCommand

void executeShellCommand(String command,
                       AndroidDeviceOutputReciever reciever)
                         throws AndroidExecutionException

Executes a shell command on the device

Parameters:

command - The command to be executed

reciever - A processor to process command output

Throws:

AndroidExecutionException

createPortForwarding

void createPortForwarding(int localPort,
                        int remotePort)
                          throws AndroidExecutionException

Creates a port forwarding between a local and a remote port.

Parameters:

localPort - the local port to forward

remotePort - the remote port.

Throws:

AndroidExecutionException

removePortForwarding

void removePortForwarding(int localPort,
                        int remotePort)
                          throws AndroidExecutionException

Removes a port forwarding between a local and a remote port.

Parameters:

localPort - the local port to forward

remotePort - the remote port.

Throws:

AndroidExecutionException

installPackage

void installPackage(File packageFilePath,
                  boolean reinstall,
                  String... extraArgs)
                    throws AndroidExecutionException

Installs an Android application on device. This is a helper method that combines the syncPackageToDevice, installRemotePackage, and removePackage steps

Parameters:

packageFilePath - the absolute file system path to file on local host to install

reinstall - set to trueif re-install of app should be performed

extraArgs - optional extra arguments to pass. See 'adb shell pm install --help' for available options.

Throws:

AndroidExecutionException

uninstallPackage

void uninstallPackage(String packageName)
                      throws AndroidExecutionException

Uninstalls an package from the device.

Parameters:

packageName - the Android application package name to uninstall

Throws:

AndroidExecutionException

isPackageInstalled

boolean isPackageInstalled(String packageName)
                           throws AndroidExecutionException

Checks if an APK package of name packageName is installed or not.

Parameters:

packageName - name of the installed package

Returns:

true if a package of packageName is installed, false otherwise

Throws:

AndroidExecutionException

getConsolePort

String getConsolePort()

Returns:

console port of the emulator - the number after "emulator" string in the serial number string of the emulator obtained by adb devices -l command.

getDroneHostPort

int getDroneHostPort()

Host is your local computer.

Returns:

host port for extensions like Droidium native or web plugin

getDroneGuestPort

int getDroneGuestPort()

Guest port is port on the Android device side

Returns:

guest port for extensions like Droidium native or web plugin

setDroneHostPort

void setDroneHostPort(int droneHostPort)

Host is your local computer

Parameters:

droneHostPort - for extensions like Droidium native or web plugin

setDroneGuestPort

void setDroneGuestPort(int droneGuestPort)

Guest port is port on the Android device side

Parameters:

droneGuestPort - for extensions like Droidium native or web plugin

getScreenshot

Screenshot getScreenshot()

Gets a screenshot of underlying Android device.

Returns:

raw screenshot for further processing

setActivityManagerProvider

void setActivityManagerProvider(ActivityManagerProvider activityManagerProvider)

Parameters:

activityManagerProvider -

getActivityManagerProvider

ActivityManagerProvider getActivityManagerProvider()

Returns:

gets activity manager provider for this Android device