com.atakmap.comms

Class NetworkDeviceManager.NetworkDevice

java.lang.Object

com.atakmap.comms.NetworkDeviceManager.NetworkDevice

Enclosing class:

NetworkDeviceManager

public static class NetworkDeviceManager.NetworkDevice
extends java.lang.Object

The network device is described by its macaddress, label, type and the preferred network configuration,

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkDeviceManager.NetworkDevice.Configuration
static class	NetworkDeviceManager.NetworkDevice.Type Type of network devices, used within the system to allow for radio or network specific traffic to be designated on a network by network case.

Field Summary

Fields

Modifier and Type	Field and Description
NetworkDeviceManager.NetworkDevice.Configuration	configuration
java.lang.String	label
java.lang.String	macaddr
java.lang.String	prefAddress
boolean	prefCreateDefaultRoute
java.lang.String	prefGateway
java.lang.String	prefNetmask
NetworkDeviceManager.NetworkDevice.Type[]	type

Constructor Summary

Constructors

Constructor and Description
NetworkDevice(java.lang.String macaddr, java.lang.String label, NetworkDeviceManager.NetworkDevice.Type[] type, NetworkDeviceManager.NetworkDevice.Configuration configuration) Construct a DHCP configured or UNCONFIGURABLE network device, address, netmask, and gateway of the constructed object will be null.
NetworkDevice(java.lang.String macaddr, java.lang.String label, NetworkDeviceManager.NetworkDevice.Type[] type, NetworkDeviceManager.NetworkDevice.Configuration configuration, java.lang.String prefAddress, java.lang.String prefNetmask, java.lang.String prefGateway, boolean prefCreateDefaultRoute) Construct a STATIC configured network device.

Method Summary

Modifier and Type	Method and Description
java.net.NetworkInterface	getCleanInterface() In a very narrow instance the network interface provided will fail during a joinGroup().
java.net.NetworkInterface	getInterface() Get the network interface of the device described in the network map file.
boolean	isSupported(NetworkDeviceManager.NetworkDevice.Type t) Test to see if the type is supported.
java.lang.String	toString() Provides a human readable string representation of the network device.

Methods inherited from class java.lang.Object

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

Field Detail

macaddr

public final java.lang.String macaddr

label

public final java.lang.String label

configuration

public final NetworkDeviceManager.NetworkDevice.Configuration configuration

prefAddress

public final java.lang.String prefAddress

prefNetmask

public final java.lang.String prefNetmask

prefGateway

public final java.lang.String prefGateway

prefCreateDefaultRoute

public final boolean prefCreateDefaultRoute

type

public final NetworkDeviceManager.NetworkDevice.Type[] type

Constructor Detail

NetworkDevice

public NetworkDevice(java.lang.String macaddr,
                     java.lang.String label,
                     NetworkDeviceManager.NetworkDevice.Type[] type,
                     NetworkDeviceManager.NetworkDevice.Configuration configuration)

Construct a DHCP configured or UNCONFIGURABLE network device, address, netmask, and gateway of the constructed object will be null. These are desired values and not the values of the actual configured device. If the configuration is set to static, no configuration will be performed.

Parameters:

macaddr - is in the format XX:XX:XX:XX:XX:XX

label - freetext not including commas

type -

configuration -

NetworkDevice

public NetworkDevice(java.lang.String macaddr,
                     java.lang.String label,
                     NetworkDeviceManager.NetworkDevice.Type[] type,
                     NetworkDeviceManager.NetworkDevice.Configuration configuration,
                     java.lang.String prefAddress,
                     java.lang.String prefNetmask,
                     java.lang.String prefGateway,
                     boolean prefCreateDefaultRoute)

Construct a STATIC configured network device. These are desired values and not the values of the actual configured device. To view the actual values, use getInterface and examine the actual values in that structure.

Parameters:

macaddr - is in the format XX:XX:XX:XX:XX:XX

label - freetext not including commas, if commas are contained in the label they are replaced with periods.

type - an array of all of the types of traffic that can be stupported by this network device.

configuration -

prefAddress - is a valid preferred IPv4 address, null implies DHCP (netmask and gateway will be ignored)

prefNetmask - is a valid preferred netmask address, null implies DHCP

prefGateway - is a valid preferred IPv4 address, null implies DHCP

prefCreateDefaultRoute - is whether to create a default route for this network device

Method Detail

getInterface

public java.net.NetworkInterface getInterface()

Get the network interface of the device described in the network map file. The configuration of the actual interface should only be obtained from the NetworkInterface and not from the preferred values.

Returns:

the interface that describes the specific interface as defined by the network map. The network interface may have a name such as eth0, eth1, eth2, wlan0, ppp0, rmnet0, etc to use, or null if the interface is not present. The interface should be examined for the actual configuration of the device.

getCleanInterface

public java.net.NetworkInterface getCleanInterface()

In a very narrow instance the network interface provided will fail during a joinGroup(). In this case it is MANDATORY that you request a clean interface.

isSupported

public boolean isSupported(NetworkDeviceManager.NetworkDevice.Type t)

Test to see if the type is supported.

Parameters:

t - the type

Returns:

true if the type is supported, false if not.

toString

public java.lang.String toString()

Provides a human readable string representation of the network device.

Overrides:

toString in class java.lang.Object