io.sentry.android.event.helper

Class AndroidEventBuilderHelper

java.lang.Object

io.sentry.android.event.helper.AndroidEventBuilderHelper

All Implemented Interfaces:

EventBuilderHelper

public class AndroidEventBuilderHelper
extends Object
implements EventBuilderHelper

EventBuilderHelper that makes use of Android Context to populate some Event fields.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG Logger tag.

Constructor Summary

Constructors

Constructor and Description
AndroidEventBuilderHelper(android.content.Context ctx) Construct given the provided Android Context.

Method Summary

Methods

Modifier and Type	Method and Description
protected static String	getApplicationName(android.content.Context ctx) Get the human-facing Application name.
protected static Float	getBatteryLevel(android.content.Context ctx) Get the device's current battery level (as a percentage of total).
protected Map<String,Map<String,Object>>	getContexts()
protected static android.util.DisplayMetrics	getDisplayMetrics(android.content.Context ctx) Get the DisplayMetrics object for the current application.
protected static String	getFamily() Fake the device family by using the first word in the Build.MODEL.
protected static String	getKernelVersion() Get the device's current kernel version, as a string.
protected static android.app.ActivityManager.MemoryInfo	getMemInfo(android.content.Context ctx) Get MemoryInfo object representing the memory state of the application.
protected static String	getOrientation(android.content.Context ctx) Get the device's current screen orientation.
protected static android.content.pm.PackageInfo	getPackageInfo(android.content.Context ctx) Return the Application's PackageInfo if possible, or null.
protected static String[]	getProGuardUuids(android.content.Context ctx)
protected static Long	getTotalExternalStorage() Get the total amount of external storage, in bytes, or null if no external storage is mounted.
protected static Long	getTotalInternalStorage() Get the total amount of internal storage, in bytes.
protected static Long	getUnusedExternalStorage() Get the unused amount of external storage, in bytes, or null if no external storage is mounted.
protected static Long	getUnusedInternalStorage() Get the unused amount of internal storage, in bytes.
void	helpBuildingEvent(EventBuilder eventBuilder)
protected static Boolean	isCharging(android.content.Context ctx) Checks whether or not the device is currently plugged in and charging, or null if unknown.
protected static boolean	isConnected(android.content.Context ctx) Check whether the application has internet access at a point in time.
protected static Boolean	isEmulator() Check whether the application is running in an emulator.
protected static boolean	isExternalStorageMounted()
protected static Boolean	isRooted() Attempt to discover if this device is currently rooted.
protected static String	stringifyDate(Date date) Formats the given Date object into an ISO8601 String.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final String TAG

Logger tag.

Constructor Detail

AndroidEventBuilderHelper

public AndroidEventBuilderHelper(android.content.Context ctx)

Construct given the provided Android Context.

Parameters:

ctx - Android application context.

Method Detail

helpBuildingEvent

public void helpBuildingEvent(EventBuilder eventBuilder)

Specified by:

helpBuildingEvent in interface EventBuilderHelper

getContexts

protected Map<String,Map<String,Object>> getContexts()

getProGuardUuids

protected static String[] getProGuardUuids(android.content.Context ctx)

getPackageInfo

protected static android.content.pm.PackageInfo getPackageInfo(android.content.Context ctx)

Return the Application's PackageInfo if possible, or null.

Parameters:

ctx - Android application context

Returns:

the Application's PackageInfo if possible, or null

getFamily

protected static String getFamily()

Fake the device family by using the first word in the Build.MODEL. Works well in most cases... "Nexus 6P" -> "Nexus", "Galaxy S7" -> "Galaxy".

Returns:

family name of the device, as best we can tell

isEmulator

protected static Boolean isEmulator()

Check whether the application is running in an emulator. http://stackoverflow.com/a/21505193

Returns:

true if the application is running in an emulator, false otherwise

getMemInfo

protected static android.app.ActivityManager.MemoryInfo getMemInfo(android.content.Context ctx)

Get MemoryInfo object representing the memory state of the application.

Parameters:

ctx - Android application context

Returns:

MemoryInfo object representing the memory state of the application

getOrientation

protected static String getOrientation(android.content.Context ctx)

Get the device's current screen orientation.

Parameters:

ctx - Android application context

Returns:

the device's current screen orientation, or null if unknown

getBatteryLevel

protected static Float getBatteryLevel(android.content.Context ctx)

Get the device's current battery level (as a percentage of total).

Parameters:

ctx - Android application context

Returns:

the device's current battery level (as a percentage of total), or null if unknown

isCharging

protected static Boolean isCharging(android.content.Context ctx)

Checks whether or not the device is currently plugged in and charging, or null if unknown.

Parameters:

ctx - Android application context

Returns:

whether or not the device is currently plugged in and charging, or null if unknown

getKernelVersion

protected static String getKernelVersion()

Get the device's current kernel version, as a string. Attempts to read /proc/version, and falls back to the 'os.version' System Property.

Returns:

the device's current kernel version, as a string

isRooted

protected static Boolean isRooted()

Attempt to discover if this device is currently rooted. From: https://stackoverflow.com/questions/1101380/determine-if-running-on-a-rooted-device

Returns:

true if heuristics show the device is probably rooted, otherwise false

isExternalStorageMounted

protected static boolean isExternalStorageMounted()

getUnusedInternalStorage

protected static Long getUnusedInternalStorage()

Get the unused amount of internal storage, in bytes.

Returns:

the unused amount of internal storage, in bytes

getTotalInternalStorage

protected static Long getTotalInternalStorage()

Get the total amount of internal storage, in bytes.

Returns:

the total amount of internal storage, in bytes

getUnusedExternalStorage

protected static Long getUnusedExternalStorage()

Get the unused amount of external storage, in bytes, or null if no external storage is mounted.

Returns:

the unused amount of external storage, in bytes, or null if no external storage is mounted

getTotalExternalStorage

protected static Long getTotalExternalStorage()

Get the total amount of external storage, in bytes, or null if no external storage is mounted.

Returns:

the total amount of external storage, in bytes, or null if no external storage is mounted

getDisplayMetrics

protected static android.util.DisplayMetrics getDisplayMetrics(android.content.Context ctx)

Get the DisplayMetrics object for the current application.

Parameters:

ctx - Android application context

Returns:

the DisplayMetrics object for the current application

stringifyDate

protected static String stringifyDate(Date date)

Formats the given Date object into an ISO8601 String. Note that SimpleDateFormat isn't thread safe, and so we build one every time.

Parameters:

date - Date to format as ISO8601

Returns:

String representing the provided Date in ISO8601 format

getApplicationName

protected static String getApplicationName(android.content.Context ctx)

Get the human-facing Application name.

Parameters:

ctx - Android application context

Returns:

Application name

isConnected

protected static boolean isConnected(android.content.Context ctx)

Check whether the application has internet access at a point in time.

Parameters:

ctx - Android application context

Returns:

true if the application has internet access