com.atakmap.android.video

Class ConnectionEntry

java.lang.Object

com.atakmap.android.video.ConnectionEntry

All Implemented Interfaces:

java.io.Serializable

public class ConnectionEntry
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectionEntry.Protocol
static class	ConnectionEntry.Source

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTRA_CONNECTION_ENTRY
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
ConnectionEntry() Produces a completely undefined ConnectionEntry, a minimum set of values would need to be set before this can even be used.
ConnectionEntry(java.io.File f) Construct a connection entry based on the file provided.
ConnectionEntry(java.lang.String alias, java.lang.String uri) Creates a connection entry based on a provided uri.
ConnectionEntry(java.lang.String alias, java.lang.String address, int port, int roverPort, java.lang.String path, ConnectionEntry.Protocol protocol, int networkTimeout, int bufferTime, int rtspReliable, java.lang.String passphrase, ConnectionEntry.Source source) Construct a connection entry that describes all of the fields that could potentially be stored to describe a video source.
ConnectionEntry(java.lang.String alias, java.lang.String address, java.lang.String macAddress, int port, int roverPort, java.lang.String path, ConnectionEntry.Protocol protocol, int networkTimeout, int bufferTime, int rtspReliable, ConnectionEntry.Source source) Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable
ConnectionEntry(java.lang.String alias, java.lang.String address, java.lang.String macAddress, int port, int roverPort, java.lang.String path, ConnectionEntry.Protocol protocol, int networkTimeout, int bufferTime, int rtspReliable, java.lang.String passphrase, ConnectionEntry.Source source) Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable

Method Summary

Modifier and Type	Method and Description
ConnectionEntry	copy() Construct a copy of the Connection Entry for using by the alternative video player and also for use by the media processor so that the connection entry - if modified does not get messed up.
void	copy(ConnectionEntry from) Constructs an exact copy of the ConnectionEntry and even contains the same uid.
void	dispose() Called once this entry is removed from the manager and not to be used from this point on
boolean	equals(java.lang.Object o)
java.lang.String	getAddress() Get the address associated with the alias.
java.lang.String	getAddress(boolean forDisplay) Get the address associated with the alias.
java.lang.String	getAlias() The alias assigned to this connection entry.
int	getBufferTime() Get the time used to buffer an incoming stream.
java.util.List<ConnectionEntry>	getChildren() Get children entries (only applies to DIRECTORY entries)
boolean	getIgnoreEmbeddedKLV() If the connection entry contains embedded klv, ignore it if the flag is true.
java.io.File	getLocalFile()
java.lang.String	getMacAddress() Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable
int	getNetworkTimeout() Get the network timeout associated with the connection entry.
java.lang.String	getParentUID() Get the parent directory entry
java.lang.String	getPassphrase() Returns non-empty string if one is to be used to access the video source.
java.lang.String	getPath() The path for the video connection entry
int	getPort() The port for the video connection entry
java.lang.String	getPreferredInterfaceAddress() Gets the preferred ip address for the interface to use.
ConnectionEntry.Protocol	getProtocol() The protocol associated with the connection entry
int	getRoverPort() Get the port for any sideband metadata - this would be KLV encoded metadata not carried in the same udp stream as the video.
int	getRtspReliable() Returns 1 if rtsp should be force negotiated as reliable (TCP).
ConnectionEntry.Source	getSource() Gets the source of the Connection Entry (Local or External) used to make sure that it is not persisted incorrectly if it came from the removable card.
java.lang.String	getUID() Get the UID for the alias.
static java.lang.String	getURL(ConnectionEntry ce) Provide the legacy call to getURL which will show all of the sensitive bits and pieces.
static java.lang.String	getURL(ConnectionEntry ce, boolean forDisplay) Given a connection entry, produces a well formed URL.
static java.lang.String[]	getUserPassIp(java.lang.String address) Parses out a username and password combination from the provided address or url
int	hashCode()
boolean	isRemote() Convenience method for checking if a connection entry is remote based on its protocol
boolean	isTemporary() Is the video alias considered temporary.
void	setAddress(java.lang.String address) Sets the address associated with the alias.
void	setAlias(java.lang.String alias) Sets the alias for the connection entry.
void	setBufferTime(int bufferTime) Set the time used to buffer an incoming stream
void	setChildren(java.util.List<ConnectionEntry> children) Set list of children entries (only applies to DIRECTORY entries)
void	setIgnoreEmbeddedKLV(boolean state) If the video stream contains metadata, set this flag to hint to the player to ignore any klv processing.
void	setLocalFile(java.io.File file) Set the associated local file for this entry
void	setMacAddress(java.lang.String macAddress) Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable
void	setNetworkTimeout(int networkTimeout) Set the network timeout associated with the connection entry.
void	setPassphrase(java.lang.String pass) Set to non-empty string if a passphrase is used to access the video
void	setPath(java.lang.String path) Set the path for the connection entry
void	setPort(int port) The port for the video connection entry
void	setPreferredInterfaceAddress(java.lang.String preferredInterfaceAddress) Sets the preferred ip address for the interface to use.
void	setProtocol(ConnectionEntry.Protocol protocol) Sets the protocol associated with the connection entry
void	setRoverPort(int port) Set the port for any sideband metadata - this would be KLV encoded metadata not carried in the same udp stream as the video.
void	setRtspReliable(int rtspReliable) Set 1 if rtsp should be force negotiated as reliable (TCP).
void	setSource(ConnectionEntry.Source source) Sets the source of the connection entry.
void	setTemporary(boolean temp) Set whether this video alias is temporary and should not be persisted
void	setUID(java.lang.String uid) Set the UID for the alias.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

EXTRA_CONNECTION_ENTRY

public static final java.lang.String EXTRA_CONNECTION_ENTRY

See Also:

Constant Field Values

Constructor Detail

ConnectionEntry

public ConnectionEntry(java.lang.String alias,
                       java.lang.String address,
                       int port,
                       int roverPort,
                       java.lang.String path,
                       ConnectionEntry.Protocol protocol,
                       int networkTimeout,
                       int bufferTime,
                       int rtspReliable,
                       java.lang.String passphrase,
                       ConnectionEntry.Source source)

Construct a connection entry that describes all of the fields that could potentially be stored to describe a video source.

Parameters:

alias - a human readable alias for the video stream.

address - the IPv4 address for the video stream.

port - the port used for the specified video stream.

roverPort - UDP sideband metadata traffic from a L3 Com Video Downlink Receiver, provide the additional rover port, -1 if there is no data.

path - for rtsp and http, provide the path to use when connecting to the stream.

protocol - the protocol for the video stream.

networkTimeout - as specified in milliseconds (should be 5000).

bufferTime - as specified in milliseconds (should be -1 unless required).

passphrase - passphrase to access the source (empty string if not needed)

source - the source of the saved data, either LOCAL_STORAGE or EXTERNAL (by default should be LOCAL_STORAGE).

ConnectionEntry

@Deprecated
public ConnectionEntry(java.lang.String alias,
                                   java.lang.String address,
                                   java.lang.String macAddress,
                                   int port,
                                   int roverPort,
                                   java.lang.String path,
                                   ConnectionEntry.Protocol protocol,
                                   int networkTimeout,
                                   int bufferTime,
                                   int rtspReliable,
                                   java.lang.String passphrase,
                                   ConnectionEntry.Source source)

Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable

Construct a connection entry that describes all of the fields that could potentially be stored to describe a video source.

Parameters:

alias - a human readable alias for the video stream.

address - the IPv4 address for the video stream.

macAddress - optional MAC address in the form XX:XX:XX:XX:XX:XX identifying the specific interface where the traffic should be from. This is only applied to MULTICAST UDP traffic and only applied if the MAC address provided resolves to an interface that is configured and is up. The MAC address can additionally be null, which will mean that the system default will be used instead of a particular interface for the multicast video.

port - the port used for the specified video stream.

roverPort - UDP sideband metadata traffic from a L3 Com Video Downlink Receiver, provide the additional rover port, -1 if there is no data.

path - for rtsp and http, provide the path to use when connecting to the stream.

protocol - the protocol for the video stream.

networkTimeout - as specified in milliseconds (should be 5000).

bufferTime - as specified in milliseconds (should be -1 unless required).

passphrase - passphrase to access the source (empty string if not needed)

source - the source of the saved data, either LOCAL_STORAGE or EXTERNAL (by default should be LOCAL_STORAGE).

ConnectionEntry

@Deprecated
public ConnectionEntry(java.lang.String alias,
                                   java.lang.String address,
                                   java.lang.String macAddress,
                                   int port,
                                   int roverPort,
                                   java.lang.String path,
                                   ConnectionEntry.Protocol protocol,
                                   int networkTimeout,
                                   int bufferTime,
                                   int rtspReliable,
                                   ConnectionEntry.Source source)

Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable

Construct a connection entry that describes all of the fields that could potentially be stored to describe a video source.

Parameters:

alias - a human readable alias for the video stream.

address - the IPv4 address for the video stream.

macAddress - optional MAC address in the form XX:XX:XX:XX:XX:XX identifying the specific interface where the traffic should be from. This is only applied to MULTICAST UDP traffic and only applied if the MAC address provided resolves to an interface that is configured and is up. The MAC address can additionally be null, which will mean that the system default will be used instead of a particular interface for the multicast video.

port - the port used for the specified video stream.

roverPort - UDP sideband metadata traffic from a L3 Com Video Downlink Receiver, provide the additional rover port, -1 if there is no data.

path - for rtsp and http, provide the path to use when connecting to the stream.

protocol - the protocol for the video stream.

networkTimeout - as specified in milliseconds (should be 5000).

bufferTime - as specified in milliseconds (should be -1 unless required).

source - the source of the saved data, either LOCAL_STORAGE or EXTERNAL (by default should be LOCAL_STORAGE).

ConnectionEntry

public ConnectionEntry(java.io.File f)

Construct a connection entry based on the file provided.

Parameters:

f - the file

ConnectionEntry

public ConnectionEntry(java.lang.String alias,
                       java.lang.String uri)

Creates a connection entry based on a provided uri.

Parameters:

alias - the alias that is presented to the user that describes the connection entry

uri - the uri to turn into a connection entry.

ConnectionEntry

public ConnectionEntry()

Produces a completely undefined ConnectionEntry, a minimum set of values would need to be set before this can even be used. When capable use the full constructor for the connection entry.

Method Detail

copy

public ConnectionEntry copy()

Construct a copy of the Connection Entry for using by the alternative video player and also for use by the media processor so that the connection entry - if modified does not get messed up. This copy will have a different unique identifier.

Returns:

a valid copy of the connection entry with a different unique identifier.

copy

public void copy(ConnectionEntry from)

Constructs an exact copy of the ConnectionEntry and even contains the same uid.

Parameters:

from - the connection entry to copy the details from.

getIgnoreEmbeddedKLV

public boolean getIgnoreEmbeddedKLV()

If the connection entry contains embedded klv, ignore it if the flag is true.

Returns:

ignore embedded klv if the flag is true.

setIgnoreEmbeddedKLV

public void setIgnoreEmbeddedKLV(boolean state)

If the video stream contains metadata, set this flag to hint to the player to ignore any klv processing.

Parameters:

state -

getRoverPort

public int getRoverPort()

Get the port for any sideband metadata - this would be KLV encoded metadata not carried in the same udp stream as the video.

Returns:

the port that contains the klv

setRoverPort

public void setRoverPort(int port)

Set the port for any sideband metadata - this would be KLV encoded metadata not carried in the same udp stream as the video.

Parameters:

port - the port that contains the klv

getAlias

public java.lang.String getAlias()

The alias assigned to this connection entry.

Returns:

the alias otherwise the empty string.

setAlias

public void setAlias(java.lang.String alias)

Sets the alias for the connection entry.

Parameters:

alias - the alias to set, if null is passed in a call to getAlias will return the empty string.

getUID

public java.lang.String getUID()

Get the UID for the alias. It is recommended but not required that this be a universally unique identifer from the class UUID.

Returns:

the UID for the alias.

setUID

public void setUID(java.lang.String uid)

Set the UID for the alias. It is recommended but not required that this be a universally unique identifer from the class UUID.

Parameters:

uid - the unique identifier

getAddress

public java.lang.String getAddress()

Get the address associated with the alias.

Returns:

the address for the Connection Entry.

getAddress

public java.lang.String getAddress(boolean forDisplay)

Get the address associated with the alias.

Returns:

the address for the Connection Entry.

setAddress

public void setAddress(java.lang.String address)

Sets the address associated with the alias.

Parameters:

address - the address for the Connection Entry.

getMacAddress

@Deprecated
public java.lang.String getMacAddress()

Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable

Returns the hinted MAC Address for the interface receiving the video. A valid return value is in the format XX:XX:XX:XX:XX:XX and may describe an interface that exists or does not exist. Invalid data can also be returned and it is assumed that the data should be ignored.

Returns:

The hinted mac address.

setMacAddress

@Deprecated
public void setMacAddress(java.lang.String macAddress)

Deprecated. as of Android 11 using the machine address is strictly prohibited and unobtainable

Sets the mac address that is preferred for video udp.

Parameters:

macAddress - for multicast udp video streams, an optional MAC address can be supplied to support video streams from a specific interface. For any other input, the video source is assumed to come from the default interface.

setPreferredInterfaceAddress

public void setPreferredInterfaceAddress(java.lang.String preferredInterfaceAddress)

Sets the preferred ip address for the interface to use. This is not the ip address associated with the video. Null if using the system level preference for the video traffic. This is specific for multicast video traffic coming in from a single radio.

getPreferredInterfaceAddress

public java.lang.String getPreferredInterfaceAddress()

Gets the preferred ip address for the interface to use.

Returns:

the ip address for the interface to use for the video traffic. This is primarily for multicast video traffic.

getPort

public int getPort()

The port for the video connection entry

Returns:

the port for the entry

setPort

public void setPort(int port)

The port for the video connection entry

Parameters:

port - the port for the entry

getPath

public java.lang.String getPath()

The path for the video connection entry

Returns:

the path for the entry

setPath

public void setPath(java.lang.String path)

Set the path for the connection entry

Parameters:

path - the path

getProtocol

public ConnectionEntry.Protocol getProtocol()

The protocol associated with the connection entry

Returns:

the protocol described by the connection entry.

setProtocol

public void setProtocol(ConnectionEntry.Protocol protocol)

Sets the protocol associated with the connection entry

Parameters:

protocol - the protocol for the connection entry.

getNetworkTimeout

public int getNetworkTimeout()

Get the network timeout associated with the connection entry.

Returns:

the network timeout in milliseconds

setNetworkTimeout

public void setNetworkTimeout(int networkTimeout)

Set the network timeout associated with the connection entry.

Parameters:

networkTimeout - the network timeout in milliseconds

getBufferTime

public int getBufferTime()

Get the time used to buffer an incoming stream.

Returns:

the time used to buffer an incoming stream.

setBufferTime

public void setBufferTime(int bufferTime)

Set the time used to buffer an incoming stream

Parameters:

bufferTime - the time in milliseconds to buffer

getRtspReliable

public int getRtspReliable()

Returns 1 if rtsp should be force negotiated as reliable (TCP).

Returns:

1 if the rtsp stream negotiation should be TCP

setRtspReliable

public void setRtspReliable(int rtspReliable)

Set 1 if rtsp should be force negotiated as reliable (TCP).

Parameters:

rtspReliable - setting it to 1 will force RTSP to attempt to negotiate a TCP stream

setPassphrase

public void setPassphrase(java.lang.String pass)

Set to non-empty string if a passphrase is used to access the video

Parameters:

pass - passphrase to access the video or empty string if not needed

getPassphrase

public java.lang.String getPassphrase()

Returns non-empty string if one is to be used to access the video source.

Returns:

passphrase for the source if used, else empty string

getSource

public ConnectionEntry.Source getSource()

Gets the source of the Connection Entry (Local or External) used to make sure that it is not persisted incorrectly if it came from the removable card.

Returns:

the source of the entry

setSource

public void setSource(ConnectionEntry.Source source)

Sets the source of the connection entry. This is used primarily when reading the connection entry as it was persisted.

Parameters:

source - the source.

isRemote

public boolean isRemote()

Convenience method for checking if a connection entry is remote based on its protocol

Returns:

True if remote connection entry

setChildren

public void setChildren(java.util.List<ConnectionEntry> children)

Set list of children entries (only applies to DIRECTORY entries)

Parameters:

children - List of connection entries

getChildren

public java.util.List<ConnectionEntry> getChildren()

Get children entries (only applies to DIRECTORY entries)

Returns:

List of children entries or null if N/A

getParentUID

public java.lang.String getParentUID()

Get the parent directory entry

Returns:

Parent entry or null if none

dispose

public void dispose()

Called once this entry is removed from the manager and not to be used from this point on

setLocalFile

public void setLocalFile(java.io.File file)

Set the associated local file for this entry

Parameters:

file - Local file

getLocalFile

public java.io.File getLocalFile()

setTemporary

public void setTemporary(boolean temp)

Set whether this video alias is temporary and should not be persisted

Parameters:

temp - Temporary

isTemporary

public boolean isTemporary()

Is the video alias considered temporary.

Returns:

if the video alias is considered temporary

getURL

public static java.lang.String getURL(ConnectionEntry ce)

Provide the legacy call to getURL which will show all of the sensitive bits and pieces.

getURL

public static java.lang.String getURL(ConnectionEntry ce,
                                      boolean forDisplay)

Given a connection entry, produces a well formed URL.

Parameters:

forDisplay - true if URL will be displayed or logged or used in some way other than an actual connection to the media. This results in sensitive parts of the URL being obscured.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getUserPassIp

public static java.lang.String[] getUserPassIp(java.lang.String address)

Parses out a username and password combination from the provided address or url

Parameters:

address - the address of url

Returns:

an array of length 3, with the username being in position 0, password being in position 1 and the address or rest of the url being in position 2.