com.atakmap.android.missionpackage.file

Class MissionPackageConfiguration

java.lang.Object

com.atakmap.android.missionpackage.file.MissionPackageConfiguration

All Implemented Interfaces:

android.os.Parcelable

Direct Known Subclasses:

MissionPackageContent

public class MissionPackageConfiguration
extends java.lang.Object
implements android.os.Parcelable

Parameters describing the Mission Package. Only a single parameter of a given name is allowed Required: name - Name or label for this Mission Package uid- Unique ID (UUID) for this Mission Package Note, optional parameters may be included for extensibility remarks - comments about the package

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MissionPackageConfiguration.ImportInstructions Enum driven by packages instructions for onReceiveDelete & onReceiveImport

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<NameValuePair>	_parameters
static android.os.Parcelable.Creator<MissionPackageConfiguration>	CREATOR
static java.lang.String	PARAMETER_DeleteWithPackage Any content with this parameter set to "true" will be deleted from the map/filesystem once the Mission Package is deleted i.e.
static java.lang.String	PARAMETER_NAME
static java.lang.String	PARAMETER_OnReceiveAction A custom intent may be sent on the receiving device once the Mission Package has been extracted.
static java.lang.String	PARAMETER_OnReceiveDelete Omit or false to have Mission Package persist on receiver, If true, the Mission Package .zip will be automatically deleted after extraction on the receiver.
static java.lang.String	PARAMETER_OnReceiveImport Omit or true to have Mission Package imported on receiver, If true, the Mission Package .zip will be automatically imported based on content inspection of zipped files/data.
static java.lang.String	PARAMETER_REMARKS
static java.lang.String	PARAMETER_UID

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	MissionPackageConfiguration()
	MissionPackageConfiguration(MissionPackageConfiguration copy)
protected	MissionPackageConfiguration(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
void	clear()
int	describeContents()
boolean	equals(MissionPackageConfiguration rhsc)
boolean	equals(java.lang.Object o)
MissionPackageConfiguration.ImportInstructions	getImportInstructions() Get the import instructions
NameValuePair	getParameter(java.lang.String name)
java.util.List<NameValuePair>	getParameters()
<T> T	getParameterValue(java.lang.String name) Get a parameter's value and auto-cast to the provided return type
int	hashCode()
boolean	hasParameter(java.lang.String name)
boolean	isValid()
void	removeParameter(java.lang.String name)
void	setImportInstructions(boolean bImport, boolean bDelete, java.lang.String onReceiveAction) Set the import instructions (to be processed by receiver of package)
void	setParameter(NameValuePair parameter)
void	setParameter(java.lang.String name, java.lang.String value)
java.lang.String	toString()
void	writeToParcel(android.os.Parcel parcel, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETER_NAME

public static final java.lang.String PARAMETER_NAME

See Also:

Constant Field Values

PARAMETER_UID

public static final java.lang.String PARAMETER_UID

See Also:

Constant Field Values

PARAMETER_REMARKS

public static final java.lang.String PARAMETER_REMARKS

See Also:

Constant Field Values

PARAMETER_OnReceiveDelete

public static final java.lang.String PARAMETER_OnReceiveDelete

Omit or false to have Mission Package persist on receiver, If true, the Mission Package .zip will be automatically deleted after extraction on the receiver. Note, this is not currently processed for locally imported packages, rather only for packages received over the network (e.g. sent by another ATAK user)

See Also:

Constant Field Values

PARAMETER_OnReceiveImport

public static final java.lang.String PARAMETER_OnReceiveImport

Omit or true to have Mission Package imported on receiver, If true, the Mission Package .zip will be automatically imported based on content inspection of zipped files/data. If false data will be extracted but not imported. Note, this is not currently processed for locally imported packages, rather only for packages received over the network (e.g. sent by another ATAK user)

See Also:

Constant Field Values

PARAMETER_DeleteWithPackage

public static final java.lang.String PARAMETER_DeleteWithPackage

Any content with this parameter set to "true" will be deleted from the map/filesystem once the Mission Package is deleted i.e. Remove temporary marker created specifically for Mission Package export

See Also:

Constant Field Values

PARAMETER_OnReceiveAction

public static final java.lang.String PARAMETER_OnReceiveAction

A custom intent may be sent on the receiving device once the Mission Package has been extracted. The entire Manifest is sent as an extra in the intent, including any custom parameters contained in the Manifest Configuration. Note, PARAMETER_OnReceiveDelete and PARAMETER_OnReceiveImport are processed prior to generating the intent

See Also:

Constant Field Values

_parameters

protected java.util.List<NameValuePair> _parameters

CREATOR

public static final android.os.Parcelable.Creator<MissionPackageConfiguration> CREATOR

Constructor Detail

MissionPackageConfiguration

public MissionPackageConfiguration()

MissionPackageConfiguration

public MissionPackageConfiguration(MissionPackageConfiguration copy)

MissionPackageConfiguration

protected MissionPackageConfiguration(android.os.Parcel in)

Method Detail

isValid

public boolean isValid()

clear

public void clear()

getImportInstructions

public MissionPackageConfiguration.ImportInstructions getImportInstructions()

Get the import instructions

Returns:

setImportInstructions

public void setImportInstructions(boolean bImport,
                                  boolean bDelete,
                                  java.lang.String onReceiveAction)

Set the import instructions (to be processed by receiver of package)

Parameters:

bImport - true to run extract files against Import Manager

bDelete - true to delete .zip after extraction

onReceiveAction - Intent action to broadcast on receiver after extraction/deletion

hasParameter

public boolean hasParameter(java.lang.String name)

getParameter

public NameValuePair getParameter(java.lang.String name)

getParameterValue

public <T> T getParameterValue(java.lang.String name)

Get a parameter's value and auto-cast to the provided return type

Type Parameters:

T - Return type

Parameters:

name - Parameter name

Returns:

Parameter value or null if not found

getParameters

public java.util.List<NameValuePair> getParameters()

setParameter

public void setParameter(NameValuePair parameter)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

removeParameter

public void removeParameter(java.lang.String name)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(MissionPackageConfiguration rhsc)

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel parcel,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object