com.atakmap.comms

Class CommsMapComponent

java.lang.Object

com.atakmap.android.maps.AbstractMapComponent

com.atakmap.comms.CommsMapComponent

All Implemented Interfaces:

android.content.SharedPreferences.OnSharedPreferenceChangeListener, MapComponent, CrashListener

public class CommsMapComponent
extends AbstractMapComponent
implements android.content.SharedPreferences.OnSharedPreferenceChangeListener, CrashListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CommsMapComponent.DirectCotProcessor Interface for AbstractInput & AbstractStreaming to directly process an event rather than using a CotDispatcher If set, this is used prior rather than dispatching
static class	CommsMapComponent.ImportResult Status of an import, either one of SUCCESS - no problems FAILURE - problems not importable.
class	CommsMapComponent.MasterFileIO
class	CommsMapComponent.MasterMPIO
static interface	CommsMapComponent.PreSendProcessor Interface for a single plugin to post process a CotEvent provided a list of uids.

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

AbstractMapComponent.OnAllComponentsCreatedCallback

Nested classes/interfaces inherited from interface com.atakmap.app.CrashListener

CrashListener.CrashLogSection

Constructor Summary

Constructors

Constructor and Description
CommsMapComponent()

Method Summary

Modifier and Type	Method and Description
void	addInput(java.lang.String uniqueKey, android.os.Bundle portBundle, int port, java.lang.String mcastAddress)
void	addInputsChangedListener(CotServiceRemote.InputsChangedListener listener)
void	addOnCotEventListener(CotServiceRemote.CotEventListener cel) Registers an additional CoT event listener to be used if the CoT Event is completely unknown by the system.
void	addOutput(java.lang.String uniqueKey, android.os.Bundle portBundle, int port, java.lang.String mcastAddress)
void	addOutputsChangedListener(CotServiceRemote.OutputsChangedListener listener)
void	addStreaming(java.lang.String uniqueKey, android.os.Bundle portBundle, boolean missingParams, java.lang.String hostname, int port, byte[] clientCert, byte[] caCert, java.lang.String certPassword, java.lang.String caCertPassword, java.lang.String authUser, java.lang.String authPass)
void	addTcpInput(java.lang.String uniqueKey, android.os.Bundle portBundle, int port)
void	contactAdded(Contact c)
void	contactRemoved(Contact c)
void	cotMessageReceived(java.lang.String message, java.lang.String rxEndpointId) Invoked when a CoT Message has been received.
CloudClient	createCloudClient(CloudIO io, CloudIOProtocol proto, java.lang.String host, int port, java.lang.String basePath, java.lang.String user, java.lang.String password)
CloudClient	createCloudClient(CloudIO io, CloudIOProtocol proto, java.lang.String host, int port, java.lang.String basePath, java.lang.String user, java.lang.String password, byte[] caCerts, java.lang.String s)
Contact	createKnownEndpointContact(java.lang.String name, java.lang.String ipAddr, int port)
void	destroyCloudClient(CloudClient client)
java.lang.String	generateCSR(java.util.Map<java.lang.String,java.lang.String> dnEntries, java.lang.String privateKey, java.lang.String password)
java.lang.String	generateKey(java.lang.String password)
java.lang.String	generateKeystore(java.lang.String certPem, java.util.List<java.lang.String> caPem, java.lang.String privateKeyPem, java.lang.String password, java.lang.String friendlyName)
android.os.Bundle	getAllPortsBundle() Retrieve a listing of all the networks inputs/outputs/streaming connections as an uber bundle.
CotService	getCotService()
static CommsMapComponent	getInstance()
void	interfaceDown(NetInterface iface)
void	interfaceError(NetInterface iface, NetInterfaceErrorCode errCode)
void	interfaceUp(NetInterface iface)
CrashListener.CrashLogSection	onCrash() Take action upon crash, optionally return section for inclusion in crash log
void	onCreate(android.content.Context context, android.content.Intent intent, MapView view) Called when the component is first created
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	onPause(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onPause state transition.
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	onSharedPreferenceChanged(android.content.SharedPreferences prefs, 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	onStop(android.content.Context context, MapView view) Default implementation for an abstract map component which does not respond to the onStop state transition.
void	registerCommsLogger(CommsLogger logger) Registers a communication logger with the communication map component.
void	registerDirectProcessor(CommsMapComponent.DirectCotProcessor dp) Used internally by ATAK to set up the direct processing workflow for CotEvent messages.
void	registerFileIOProvider(FileIOProvider provider) Registers a FileIOProvider with Commo
void	registerPreSendProcessor(CommsMapComponent.PreSendProcessor psp) Allows a enternal plugin to provide a capability to have one last look at a CotEvent and uid list used.
void	removeInput(java.lang.String uniqueKey)
void	removeInputsChangedListener(CotServiceRemote.InputsChangedListener listener)
void	removeOnCotEventListener(CotServiceRemote.CotEventListener cel) Unregisters the previously registered additional CoT event listener.
void	removeOutput(java.lang.String uniqueKey)
void	removeOutputsChangedListener(CotServiceRemote.OutputsChangedListener listener)
CotPortListActivity.CotPort	removeStreaming(java.lang.String uniqueKey)
void	sendCoTFailure(java.lang.String host, int port, java.lang.String errorReason)
void	sendCoTInternally(CotEvent cotEvent, android.os.Bundle extras)
void	sendCoTToEndpoint(CotEvent e, java.lang.String endpoint)
void	sendCoTToServersByMission(java.lang.String uniqueIfaceKey, java.lang.String mission, CotEvent e) Send the specified CotEvent to all configured and connected TAK servers.
void	sendCoTToServersOnly(java.lang.String uniqueIfaceKey, CotEvent e) Send the specified CotEvent to all configured and connected TAK servers.
void	sendMissionPackage(java.lang.String[] contactUuids, java.io.File file, java.lang.String remoteFileName, java.lang.String transferName, MPSendListener listener)
void	sendMissionPackage(java.lang.String uniqueServerIfaceKey, java.io.File file, java.lang.String transferFilename, MPSendListener listener)
boolean	setMissionPackageEnabled(boolean enabled, int localPort, int secureLocalPort)
void	setMissionPackageHttpPort(int missionPackageHttpPort)
void	setMissionPackageHttpsPort(int missionPackageHttpsPort)
void	setMissionPackageReceiveInitiator(MPReceiveInitiator rxInit)
void	setPPPIncluded(boolean included) Enabled PPP as a tunnel for use with the trellisware wireless connector.
void	setPreferStreamEndpoint(boolean preferStream) Set the preferred endpoint for responding to calls to be streaming over mesh.
void	setServerVersion(java.lang.String connectString, ServerVersion version)
void	syncFileTransfer(CommsFileTransferListener listener, boolean forUpload, java.net.URI uri, byte[] caCert, java.lang.String caCertPassword, java.lang.String username, java.lang.String password, java.io.File localFile)
void	triggerIfaceRescan() Used by plugins to trigger a rescan ahead of the wait period.
void	unregisterCommsLogger(CommsLogger logger) Allows a communication logger to be removed from the communication map component.
void	unregisterFileIOProvider(FileIOProvider provider) Unregisters a FileIOProvider from Commo

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

addOverlay, onConfigurationChanged, onCreateOptionsMenu, onDestroy, onOptionsItemSelected, onOptionsMenuClosed, onPrepareOptionsMenu, registerReceiver, removeOverlay, setOnAllComponentsCreatedCallback, unregisterReceiver

Methods inherited from class java.lang.Object

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

Constructor Detail

CommsMapComponent

public CommsMapComponent()

Method Detail

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

registerFileIOProvider

public void registerFileIOProvider(FileIOProvider provider)

Registers a FileIOProvider with Commo

Parameters:

provider - The provider to register

unregisterFileIOProvider

public void unregisterFileIOProvider(FileIOProvider provider)

Unregisters a FileIOProvider from Commo

Parameters:

provider - The provider to unregister

registerCommsLogger

public void registerCommsLogger(CommsLogger logger)

Registers a communication logger with the communication map component. Please note that doing could potentially have serious performance ramifications on the rest of ATAK and this should only be done for the purposes of gathering metric or information gathering. The callback should be shortlived since it will cause a delay in the rest of the processing chain.

Parameters:

logger - the implementation of the comms logger.

unregisterCommsLogger

public void unregisterCommsLogger(CommsLogger logger)

Allows a communication logger to be removed from the communication map component.

onCrash

public CrashListener.CrashLogSection onCrash()

Description copied from interface: CrashListener

Take action upon crash, optionally return section for inclusion in crash log

Specified by:

onCrash in interface CrashListener

Returns:

the crash log section associated with the crash event.

setPreferStreamEndpoint

public void setPreferStreamEndpoint(boolean preferStream)

Set the preferred endpoint for responding to calls to be streaming over mesh.

triggerIfaceRescan

public void triggerIfaceRescan()

Used by plugins to trigger a rescan ahead of the wait period.

onSharedPreferenceChanged

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

Specified by:

onSharedPreferenceChanged in interface android.content.SharedPreferences.OnSharedPreferenceChangeListener

getInstance

public static CommsMapComponent getInstance()

getCotService

public CotService getCotService()

addInputsChangedListener

public void addInputsChangedListener(CotServiceRemote.InputsChangedListener listener)

removeInputsChangedListener

public void removeInputsChangedListener(CotServiceRemote.InputsChangedListener listener)

addOutputsChangedListener

public void addOutputsChangedListener(CotServiceRemote.OutputsChangedListener listener)

removeOutputsChangedListener

public void removeOutputsChangedListener(CotServiceRemote.OutputsChangedListener listener)

getAllPortsBundle

public android.os.Bundle getAllPortsBundle()

Retrieve a listing of all the networks inputs/outputs/streaming connections as an uber bundle. The returned bundle is going to contain a parcelableArray of streams, outputs, and inputs.

  Bundle b = getAllPortsBundle();
  Bundle[] streams = b.getParcelableArray("streams", null);
  Bundle[] outputs = b.getParcelableArray("outputs", null);
  Bundle[] inputs = b.getParcelableArray("inputs", null);
  
 where an output bundle contains the following
    CotPort.DESCRIPTION_KEY
    CotPort.ENABLED_KEY
    CotPort.CONNECTED_KEY
    CotPort.CONNECT_STRING_KEY
  

addOnCotEventListener

public void addOnCotEventListener(CotServiceRemote.CotEventListener cel)

Registers an additional CoT event listener to be used if the CoT Event is completely unknown by the system. Note that a base type of the CoTEvent might be supported by the system and not the subtype. In this case the system will still process the CoTEvent and the supplied CoTEventListener will not be called.

Parameters:

cel - the cot event listener

removeOnCotEventListener

public void removeOnCotEventListener(CotServiceRemote.CotEventListener cel)

Unregisters the previously registered additional CoT event listener.

Parameters:

cel - the cot event listener

onDestroyImpl

public 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

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

onStop

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

Description copied from class: AbstractMapComponent

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

Specified by:

onStop in interface MapComponent

Overrides:

onStop in class AbstractMapComponent

Parameters:

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

view - the main MapView

onPause

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

Description copied from class: AbstractMapComponent

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

Specified by:

onPause in interface MapComponent

Overrides:

onPause 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

registerDirectProcessor

public void registerDirectProcessor(CommsMapComponent.DirectCotProcessor dp)

Used internally by ATAK to set up the direct processing workflow for CotEvent messages. Do not use for external development application. Any external calls to this method will silently fail.

Parameters:

dp - implementation of the DirectCotProcessor which is CotMapAdapter only.

registerPreSendProcessor

public void registerPreSendProcessor(CommsMapComponent.PreSendProcessor psp)

Allows a enternal plugin to provide a capability to have one last look at a CotEvent and uid list used.

Parameters:

psp - the Presend Processor triggered right before the message is sent down into the sending libraries.

setPPPIncluded

public void setPPPIncluded(boolean included)

Enabled PPP as a tunnel for use with the trellisware wireless connector. When called, it will trigger a rescan of the interfaces with ppp[0..4] included or excluded.

Parameters:

included - true if ppp[0..4] should be enabled or false if it should be disabled.

addInput

public void addInput(java.lang.String uniqueKey,
                     android.os.Bundle portBundle,
                     int port,
                     java.lang.String mcastAddress)

addTcpInput

public void addTcpInput(java.lang.String uniqueKey,
                        android.os.Bundle portBundle,
                        int port)

removeInput

public void removeInput(java.lang.String uniqueKey)

addOutput

public void addOutput(java.lang.String uniqueKey,
                      android.os.Bundle portBundle,
                      int port,
                      java.lang.String mcastAddress)

removeOutput

public void removeOutput(java.lang.String uniqueKey)

addStreaming

public void addStreaming(java.lang.String uniqueKey,
                         android.os.Bundle portBundle,
                         boolean missingParams,
                         java.lang.String hostname,
                         int port,
                         byte[] clientCert,
                         byte[] caCert,
                         java.lang.String certPassword,
                         java.lang.String caCertPassword,
                         java.lang.String authUser,
                         java.lang.String authPass)

removeStreaming

public CotPortListActivity.CotPort removeStreaming(java.lang.String uniqueKey)

sendCoTToEndpoint

public void sendCoTToEndpoint(CotEvent e,
                              java.lang.String endpoint)

sendCoTToServersByMission

public void sendCoTToServersByMission(java.lang.String uniqueIfaceKey,
                                      java.lang.String mission,
                                      CotEvent e)

Send the specified CotEvent to all configured and connected TAK servers. They will be routed to the specified mission on those servers. Destination/routing information will be added during the send and should not be specified in the CotEvent itself.

Parameters:

uniqueIfaceKey - the unique key identifier specifying a configured streaming interface, or null to send to all active streaming interfaces

mission - the mission identifier used to route the message

e - valid CotEvent to send

sendCoTToServersOnly

public void sendCoTToServersOnly(java.lang.String uniqueIfaceKey,
                                 CotEvent e)

Send the specified CotEvent to all configured and connected TAK servers. They will be routed to the "server only contact", being processed only by the server itself and not send to any other clients. Destination/routing information will be added during the send and should not be specified in the CotEvent itself.

Parameters:

uniqueIfaceKey - the unique key identifier specifying a configured streaming interface, or null to send to all active streaming interfaces

e - valid CotEvent to send

sendCoTFailure

public void sendCoTFailure(java.lang.String host,
                           int port,
                           java.lang.String errorReason)

cotMessageReceived

public void cotMessageReceived(java.lang.String message,
                               java.lang.String rxEndpointId)

Invoked when a CoT Message has been received. The message is provided without modification. Some basic validity checking is done prior to passing it off to listeners, but it is limited and should not be relied upon for anything specific.

Parameters:

message - the CoT message that was received

rxEndpointId - identifier of NetworkInterface upon which the message was received, if known, or null if not known

sendCoTInternally

public void sendCoTInternally(CotEvent cotEvent,
                              android.os.Bundle extras)

syncFileTransfer

public void syncFileTransfer(CommsFileTransferListener listener,
                             boolean forUpload,
                             java.net.URI uri,
                             byte[] caCert,
                             java.lang.String caCertPassword,
                             java.lang.String username,
                             java.lang.String password,
                             java.io.File localFile)
                      throws CommoException,
                             java.io.IOException,
                             java.lang.InterruptedException

Throws:

CommoException

java.io.IOException

java.lang.InterruptedException

setMissionPackageReceiveInitiator

public void setMissionPackageReceiveInitiator(MPReceiveInitiator rxInit)

setMissionPackageEnabled

public boolean setMissionPackageEnabled(boolean enabled,
                                        int localPort,
                                        int secureLocalPort)

sendMissionPackage

public void sendMissionPackage(java.lang.String[] contactUuids,
                               java.io.File file,
                               java.lang.String remoteFileName,
                               java.lang.String transferName,
                               MPSendListener listener)
                        throws java.net.UnknownServiceException,
                               CommoException

Throws:

java.net.UnknownServiceException

CommoException

sendMissionPackage

public void sendMissionPackage(java.lang.String uniqueServerIfaceKey,
                               java.io.File file,
                               java.lang.String transferFilename,
                               MPSendListener listener)
                        throws java.net.UnknownServiceException,
                               CommoException

Throws:

java.net.UnknownServiceException

CommoException

createKnownEndpointContact

public Contact createKnownEndpointContact(java.lang.String name,
                                          java.lang.String ipAddr,
                                          int port)

contactAdded

public void contactAdded(Contact c)

contactRemoved

public void contactRemoved(Contact c)

interfaceDown

public void interfaceDown(NetInterface iface)

interfaceUp

public void interfaceUp(NetInterface iface)

interfaceError

public void interfaceError(NetInterface iface,
                           NetInterfaceErrorCode errCode)

setServerVersion

public void setServerVersion(java.lang.String connectString,
                             ServerVersion version)

generateKey

public java.lang.String generateKey(java.lang.String password)

generateKeystore

public java.lang.String generateKeystore(java.lang.String certPem,
                                         java.util.List<java.lang.String> caPem,
                                         java.lang.String privateKeyPem,
                                         java.lang.String password,
                                         java.lang.String friendlyName)

generateCSR

public java.lang.String generateCSR(java.util.Map<java.lang.String,java.lang.String> dnEntries,
                                    java.lang.String privateKey,
                                    java.lang.String password)

createCloudClient

public CloudClient createCloudClient(CloudIO io,
                                     CloudIOProtocol proto,
                                     java.lang.String host,
                                     int port,
                                     java.lang.String basePath,
                                     java.lang.String user,
                                     java.lang.String password)

createCloudClient

public CloudClient createCloudClient(CloudIO io,
                                     CloudIOProtocol proto,
                                     java.lang.String host,
                                     int port,
                                     java.lang.String basePath,
                                     java.lang.String user,
                                     java.lang.String password,
                                     byte[] caCerts,
                                     java.lang.String s)

destroyCloudClient

public void destroyCloudClient(CloudClient client)

setMissionPackageHttpsPort

public void setMissionPackageHttpsPort(int missionPackageHttpsPort)

setMissionPackageHttpPort

public void setMissionPackageHttpPort(int missionPackageHttpPort)