com.atakmap.android.location

Class LocationMapComponent

java.lang.Object

com.atakmap.android.maps.AbstractMapComponent

com.atakmap.android.location.LocationMapComponent

All Implemented Interfaces:

android.content.SharedPreferences.OnSharedPreferenceChangeListener, android.hardware.SensorEventListener, android.location.GpsStatus.Listener, android.location.GpsStatus.NmeaListener, android.location.LocationListener, MapComponent

public class LocationMapComponent
extends AbstractMapComponent
implements android.hardware.SensorEventListener, android.location.GpsStatus.NmeaListener, android.location.LocationListener, android.content.SharedPreferences.OnSharedPreferenceChangeListener, android.location.GpsStatus.Listener

Provides a location Marker and various device information.

Provided Global Map Data:

• String deviceType - from preferences (default: "a-f-G-U-C-I")
• String deviceCallsign - from preferences (default: "ATAK")
• String devicePhoneNumber - requires android.permission.READ_PHONE_STATE
• GeoPoint fineLocation - requires android.permission.ACCESS_FINE_LOCATION and enabled in preferences
• double fineLocationBearing - requires android.permission.ACCESS_FINE_LOCATION and enabled in preferences
• double fineLocationSpeed - requires android.permission.ACCESS_FINE_LOCATION and enabled in preferences
• double deviceAzimuth - modifications to deviceAzimuth outside of LocationMapComponent will not be used by LocationMapComponent since this is just for read only purposes. This bundle variable mirrors the local field mapDataDeviceAzimuth.

Nested Class Summary

Nested classes/interfaces inherited from class com.atakmap.android.maps.AbstractMapComponent

AbstractMapComponent.OnAllComponentsCreatedCallback

Field Summary

Fields

Modifier and Type	Field and Description
static int	GPS_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
LocationMapComponent()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	_determineBestDeviceUID(android.content.Context context) On the first run, determines the best possible device uid and persists it for the lifetime of the saved preferences.
static java.lang.String	_determineDeviceUID(android.content.Context context) Determines the usable UID for the app.
static java.lang.String	_fetchTelephonyLine1Number(android.content.Context context) Obtains the telephone numvber associated with the device.
static java.lang.String	callsignGen(android.content.Context ctx) Produce a callsign based on a file that is included with the distribution ATAK that is selected using the an algorithm seeded with the best determined device uid.
static java.lang.String	fetchSerialNumber(android.content.Context context) Retrieves a TAK generated serial number based on the device.
static java.lang.String	fetchTelephonyDeviceId(android.content.Context context) Retrives a TAK accessible telephony identifier based on the device.
static java.lang.String	fetchWifiMacAddress(android.content.Context context) Retrives a TAK accessible wifi mac address based on the device.
static boolean	isValidTelephoneNumber(java.lang.String phone) Check empty or known invalid
void	onAccuracyChanged(android.hardware.Sensor sensor, int accuracy)
void	onConfigurationChanged(android.content.res.Configuration newConfig) Implementation of onConfigurationChanged used to handle configuration changes for each mapComponent.
void	onCreate(android.content.Context context, android.content.Intent intent, MapView view) Called when the component is first created
protected void	onDestroyImpl(android.content.Context context, MapView view) This method is invoked as a subset of the onDestroy call as part of the MapComponent lifecycle.
void	onGpsStatusChanged(int status)
void	onLocationChanged(android.location.Location loc)
void	onNmeaReceived(long timestamp, java.lang.String nmea)
void	onProviderDisabled(java.lang.String provider)
void	onProviderEnabled(java.lang.String provider)
void	onResume(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onResume state transition.
void	onSensorChanged(android.hardware.SensorEvent event)
void	onSharedPreferenceChanged(android.content.SharedPreferences sharedPreferences, java.lang.String key)
void	onStart(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onStart state transition.
void	onStatusChanged(java.lang.String provider, int status, android.os.Bundle extras)

Methods inherited from class com.atakmap.android.maps.AbstractMapComponent

addOverlay, onCreateOptionsMenu, onDestroy, onOptionsItemSelected, onOptionsMenuClosed, onPause, onPrepareOptionsMenu, onStop, registerReceiver, removeOverlay, setOnAllComponentsCreatedCallback, unregisterReceiver

Methods inherited from class java.lang.Object

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

Field Detail

GPS_TIMEOUT_MILLIS

public static final int GPS_TIMEOUT_MILLIS

See Also:

Constant Field Values

Constructor Detail

LocationMapComponent

public LocationMapComponent()

Method Detail

onAccuracyChanged

public void onAccuracyChanged(android.hardware.Sensor sensor,
                              int accuracy)

Specified by:

onAccuracyChanged in interface android.hardware.SensorEventListener

onSensorChanged

public void onSensorChanged(android.hardware.SensorEvent event)

Specified by:

onSensorChanged in interface android.hardware.SensorEventListener

onNmeaReceived

public void onNmeaReceived(long timestamp,
                           java.lang.String nmea)

Specified by:

onNmeaReceived in interface android.location.GpsStatus.NmeaListener

onGpsStatusChanged

public void onGpsStatusChanged(int status)

Specified by:

onGpsStatusChanged in interface android.location.GpsStatus.Listener

onLocationChanged

public void onLocationChanged(android.location.Location loc)

Specified by:

onLocationChanged in interface android.location.LocationListener

onProviderDisabled

public void onProviderDisabled(java.lang.String provider)

Specified by:

onProviderDisabled in interface android.location.LocationListener

onProviderEnabled

public void onProviderEnabled(java.lang.String provider)

Specified by:

onProviderEnabled in interface android.location.LocationListener

onStatusChanged

public void onStatusChanged(java.lang.String provider,
                            int status,
                            android.os.Bundle extras)

Specified by:

onStatusChanged in interface android.location.LocationListener

callsignGen

public static java.lang.String callsignGen(android.content.Context ctx)

Produce a callsign based on a file that is included with the distribution ATAK that is selected using the an algorithm seeded with the best determined device uid.

onCreate

public void onCreate(android.content.Context context,
                     android.content.Intent intent,
                     MapView view)

Description copied from interface: MapComponent

Called when the component is first created

Specified by:

onCreate in interface MapComponent

Parameters:

context - the context of the component (the MapActivity instance)

intent - the intent of the MapActivity

view - the main MapView

_determineDeviceUID

public static java.lang.String _determineDeviceUID(android.content.Context context)

Determines the usable UID for the app. This method is used to retrieve an appropriate fingerprint. As of 4.0, this will no longer attempt to use the IMEI as a a possible identifier

Parameters:

context - is the context for the app.

Returns:

null if the fingerprint could not be identified based on the device.

_determineBestDeviceUID

public static java.lang.String _determineBestDeviceUID(android.content.Context context)

On the first run, determines the best possible device uid and persists it for the lifetime of the saved preferences. This method is also used by the AtakCertificateDatabase.setDeviceId and AtakAuthenticationDatabase.setDeviceId. Any changes to this value will disrupt both device / tak server history as well as the loss of keys in the system. UID will contain 2 parts: Hard coded prefix: ANDROID- Device specific suffix: preferred in this order WiFi MAC Address Telephony Device ID Serial Number Random UUID

onDestroyImpl

protected void onDestroyImpl(android.content.Context context,
                             MapView view)

Description copied from class: AbstractMapComponent

This method is invoked as a subset of the onDestroy call as part of the MapComponent lifecycle.

Specified by:

onDestroyImpl in class AbstractMapComponent

onSharedPreferenceChanged

public void onSharedPreferenceChanged(android.content.SharedPreferences sharedPreferences,
                                      java.lang.String key)

Specified by:

onSharedPreferenceChanged in interface android.content.SharedPreferences.OnSharedPreferenceChangeListener

fetchSerialNumber

public static java.lang.String fetchSerialNumber(android.content.Context context)

Retrieves a TAK generated serial number based on the device. If the serial number is not available, null will be returned. Recent versions of Android rely on the ANDROID_ID as the app accessible serial number

Parameters:

context - the context to use

Returns:

the serial number or null

fetchTelephonyDeviceId

public static java.lang.String fetchTelephonyDeviceId(android.content.Context context)

Retrives a TAK accessible telephony identifier based on the device. If the telephony id is not available, then return it will return null.

Parameters:

context - the context to use

Returns:

the telephony identifier

fetchWifiMacAddress

public static java.lang.String fetchWifiMacAddress(android.content.Context context)

Retrives a TAK accessible wifi mac address based on the device. If the mac address is not available, then return it will return null.

Parameters:

context - the context to use

Returns:

the telephony identifier

_fetchTelephonyLine1Number

public static java.lang.String _fetchTelephonyLine1Number(android.content.Context context)

Obtains the telephone numvber associated with the device.

Parameters:

context - the context used to determine the telephone number.

Returns:

null if no telephone number is found, otherwise the telephone number of the device.

isValidTelephoneNumber

public static boolean isValidTelephoneNumber(java.lang.String phone)

Check empty or known invalid

Parameters:

phone - the phone number to check

Returns:

true if the phone number is not empty and does not contain a series of zeros.

onStart

public void onStart(android.content.Context context,
                    MapView view)

Description copied from class: AbstractMapComponent

Default implementation for an abstract map component which does not respond to the onStart state transition.

Specified by:

onStart in interface MapComponent

Overrides:

onStart in class AbstractMapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView

onResume

public void onResume(android.content.Context context,
                     MapView view)

Description copied from class: AbstractMapComponent

Default implementation for an abstract map component which does not respond to the onResume state transition.

Specified by:

onResume in interface MapComponent

Overrides:

onResume in class AbstractMapComponent

Parameters:

context - the context of the component (the MapActivity instance)

view - the main MapView

onConfigurationChanged

public void onConfigurationChanged(android.content.res.Configuration newConfig)

Description copied from interface: MapComponent

Implementation of onConfigurationChanged used to handle configuration changes for each mapComponent.

Specified by:

onConfigurationChanged in interface MapComponent

Overrides:

onConfigurationChanged in class AbstractMapComponent

Parameters:

newConfig - called when the configuration changed

See Also:

Activity.onConfigurationChanged(Configuration)