org.eclipse.kura.net

Interface NetworkAdminService

@ProviderType
public interface NetworkAdminService

Service API for getting and setting network interface configurations.

Method Summary

Modifier and Type	Method and Description
void	disableInterface(java.lang.String interfaceName) Disables the specified interface.
void	enableInterface(java.lang.String interfaceName, boolean dhcp) Enables the specified interface.
java.util.List<DhcpLease>	getDhcpLeases() Deprecated. since 2.6. Use getDhcpLeases(String ifaceName) instead.
java.util.List<DhcpLease>	getDhcpLeases(java.lang.String ifaceName) Obtains the DHCP Lease values assigned by a DHCP server running on a given network interface
java.util.List<NetConfig>	getFirewallConfiguration() Gets the firewall configuration of the system as currently specified
java.util.List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>>	getNetworkInterfaceConfigs() Deprecated. since 2.4. Use getNetworkInterfaceConfigs(boolean recompute) instead.
java.util.List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>>	getNetworkInterfaceConfigs(boolean recompute) Returns a list of all of the configurations associated with all of the interfaces on the system and their current values.
java.util.List<NetConfig>	getNetworkInterfaceConfigs(java.lang.String interfaceName) Deprecated. since 2.4. Use getNetworkInterfaceConfigs(tring interfaceName, boolean recompute) instead.
java.util.List<NetConfig>	getNetworkInterfaceConfigs(java.lang.String interfaceName, boolean recompute) Returns the configuration information for the specified NetworkInterface name.
java.lang.String	getWifiCountryCode() Obtains information for WiFi Country code.
java.util.List<WifiChannel>	getWifiFrequencies(java.lang.String ifaceName) Obtains information for WiFi Frequencies.
java.util.List<WifiHotspotInfo>	getWifiHotspotList(java.lang.String ifaceName) Obtains information for WiFi hotspots in range.
boolean	isWifiDFS(java.lang.String ifaceName) Information on Dynamic Frequencies Selection
boolean	isWifiIEEE80211AC(java.lang.String ifaceName) Information on WiFi 802.11ac
void	manageDhcpClient(java.lang.String interfaceName, boolean enable) Used to control DHCP clients on specified interfaces.
void	manageDhcpServer(java.lang.String interfaceName, boolean enable) Used to control DHCP servers on specified interfaces.
void	manageFirewall(java.lang.String gatewayIface) Updates the Firewall configuration based on current environmental conditions.
void	renewDhcpLease(java.lang.String interfaceName) Releases current IP address and acquires a new lease for the provided interface.
void	setFirewallNatConfiguration(java.util.List<FirewallNatConfig> natConfigs) Deprecated. Since 2.4
void	setFirewallOpenPortConfiguration(java.util.List<FirewallOpenPortConfigIP<? extends IPAddress>> firewallConfiguration) Deprecated. Since 2.4
void	setFirewallPortForwardingConfiguration(java.util.List<FirewallPortForwardConfigIP<? extends IPAddress>> firewallConfiguration) Deprecated. Since 2.4
void	updateEthernetInterfaceConfig(java.lang.String interfaceName, boolean autoConnect, int mtu, java.util.List<NetConfig> netConfigs) Deprecated. Since 2.4. Use the ConfigurationService to update the configuration of an Ethernet interface.
void	updateModemInterfaceConfig(java.lang.String interfaceName, java.lang.String serialNum, java.lang.String modemId, int pppNumber, boolean autoConnect, int mtu, java.util.List<NetConfig> netConfigs) Deprecated. Since 2.4. Use the ConfigurationService to update the configuration of a Modem interface.
void	updateWifiInterfaceConfig(java.lang.String interfaceName, boolean autoConnect, WifiAccessPoint accessPoint, java.util.List<NetConfig> netConfigs) Deprecated. Since 2.4. Use the ConfigurationService to update the configuration of a Wifi interface.
boolean	verifyWifiCredentials(java.lang.String ifaceName, WifiConfig wifiConfig, int tout) Verifies WiFi credentials by trying to establish connection with access point.

Method Detail

getNetworkInterfaceConfigs

@Deprecated
java.util.List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>> getNetworkInterfaceConfigs()
                                                                                                                  throws KuraException

Deprecated. since 2.4. Use getNetworkInterfaceConfigs(boolean recompute) instead.

Returns a list of all of the configurations associated with all of the interfaces on the system.

Returns:

list of NetInterfaceConfigs on the system

Throws:

KuraException

getNetworkInterfaceConfigs

@Deprecated
java.util.List<NetConfig> getNetworkInterfaceConfigs(java.lang.String interfaceName)
                                                          throws KuraException

Deprecated. since 2.4. Use getNetworkInterfaceConfigs(tring interfaceName, boolean recompute) instead.

Returns the configuration information for the specified NetworkInterface name. The returned NetConfig captured how the interface was configured; the returned list will have a NetConfig4 instance for IPv4 and an NetConfig6 instance for IPv6. This should not be confused with the currently active NetInterfaceAddress associated with the NetInterface.

Parameters:

interfaceName -

Returns:

list of NetConfig for this interface.

Throws:

KuraException

updateEthernetInterfaceConfig

@Deprecated
void updateEthernetInterfaceConfig(java.lang.String interfaceName,
                                               boolean autoConnect,
                                               int mtu,
                                               java.util.List<NetConfig> netConfigs)
                                        throws KuraException

Deprecated. Since 2.4. Use the ConfigurationService to update the configuration of an Ethernet interface.

Updates the configuration of the specified EthernetInterface.

Parameters:

interfaceName - - name of the Ethernet interface

autoConnect - - specifies the auto-connect value for the interface

mtu - - required MTU for the interface, -1 to keep the automatic default

Throws:

KuraException

updateWifiInterfaceConfig

@Deprecated
void updateWifiInterfaceConfig(java.lang.String interfaceName,
                                           boolean autoConnect,
                                           WifiAccessPoint accessPoint,
                                           java.util.List<NetConfig> netConfigs)
                                    throws KuraException

Deprecated. Since 2.4. Use the ConfigurationService to update the configuration of a Wifi interface.

Updates the configuration of the specified WifiInterface.

Parameters:

interfaceName - - name of the wifi interface

autoConnect - - specifies the auto-connect value for the interface

Throws:

KuraException

updateModemInterfaceConfig

@Deprecated
void updateModemInterfaceConfig(java.lang.String interfaceName,
                                            java.lang.String serialNum,
                                            java.lang.String modemId,
                                            int pppNumber,
                                            boolean autoConnect,
                                            int mtu,
                                            java.util.List<NetConfig> netConfigs)
                                     throws KuraException

Deprecated. Since 2.4. Use the ConfigurationService to update the configuration of a Modem interface.

Updates the configuration of the specified ModemInterface.

Parameters:

interfaceName - - name of the Modem interface

serialNum - - the modem's serial number

modemId - - user string to identify the modem

pppNumber - - ppp number to use for this interface

autoConnect - - specifies the auto-connect value for the interface

mtu - - required MTU for the interface, -1 to keep the automatic default

netConfigs - - list of NetConfigs for this interface

Throws:

KuraException

enableInterface

void enableInterface(java.lang.String interfaceName,
                     boolean dhcp)
              throws KuraException

Enables the specified interface.

Parameters:

interfaceName - - name of the interface to be enabled.

Throws:

KuraException

disableInterface

void disableInterface(java.lang.String interfaceName)
               throws KuraException

Disables the specified interface.

Parameters:

interfaceName - - name of the interface to be disabled.

Throws:

KuraException

manageDhcpClient

void manageDhcpClient(java.lang.String interfaceName,
                      boolean enable)
               throws KuraException

Used to control DHCP clients on specified interfaces.

Parameters:

interfaceName - The interface of the DHCP server to modify the state

enable - Whether to enable or disable the DHCP client

Throws:

KuraException

manageDhcpServer

void manageDhcpServer(java.lang.String interfaceName,
                      boolean enable)
               throws KuraException

Used to control DHCP servers on specified interfaces.

Parameters:

interfaceName - The interface of the DHCP server to modify the state

enable - Whether to enable or disable the DHCP server

Throws:

KuraException

renewDhcpLease

void renewDhcpLease(java.lang.String interfaceName)
             throws KuraException

Releases current IP address and acquires a new lease for the provided interface.

Parameters:

interfaceName - The interface on which to renew the lease

Throws:

KuraException

getFirewallConfiguration

java.util.List<NetConfig> getFirewallConfiguration()
                                            throws KuraException

Gets the firewall configuration of the system as currently specified

Returns:

A list of NetConfigs representing the firewall configuration

Throws:

KuraException

setFirewallOpenPortConfiguration

@Deprecated
void setFirewallOpenPortConfiguration(java.util.List<FirewallOpenPortConfigIP<? extends IPAddress>> firewallConfiguration)
                                           throws KuraException

Deprecated. Since 2.4

Sets the 'open port' portion of the firewall configuration

Parameters:

firewallConfiguration - A list of FirewallOpenPortConfigIP Objects representing the configuration to set

Throws:

KuraException

setFirewallPortForwardingConfiguration

@Deprecated
void setFirewallPortForwardingConfiguration(java.util.List<FirewallPortForwardConfigIP<? extends IPAddress>> firewallConfiguration)
                                                 throws KuraException

Deprecated. Since 2.4

Sets the 'port forwarding' portion of the firewall configuration

Parameters:

firewallConfiguration - A list of FirewallPortForwardConfigIP Objects representing the configuration to set

Throws:

KuraException

setFirewallNatConfiguration

@Deprecated
void setFirewallNatConfiguration(java.util.List<FirewallNatConfig> natConfigs)
                                      throws KuraException

Deprecated. Since 2.4

Sets the 'ip forwarding' portion of the firewall configuration

Parameters:

natConfigs - A list of FirewallNatConfig Objects representing the configuration to set

Throws:

KuraException

manageFirewall

void manageFirewall(java.lang.String gatewayIface)
             throws KuraException

Updates the Firewall configuration based on current environmental conditions. This is used to update the firewall in events where NAT rules need to change based on a new WAN interface coming up or going down. This ensures all downstream clients utilizing NAT on the gateway can and will maintain active Internet connections through the gateway.

Parameters:

gatewayIface - The new gateway interface that is now active as the WAN interface

Throws:

KuraException

getWifiHotspotList

java.util.List<WifiHotspotInfo> getWifiHotspotList(java.lang.String ifaceName)
                                            throws KuraException

Obtains information for WiFi hotspots in range.

Parameters:

ifaceName - - name of WiFi interface

Returns:

list of hotspot information.

Throws:

KuraException

Since:

1.2

verifyWifiCredentials

boolean verifyWifiCredentials(java.lang.String ifaceName,
                              WifiConfig wifiConfig,
                              int tout)

Verifies WiFi credentials by trying to establish connection with access point.

Parameters:

ifaceName - - name of WiFi interface

wifiConfig - WiFi configuration

tout - - timeout (in seconds)

Returns:

status - true if credentials are correct, false otherwise

getWifiFrequencies

java.util.List<WifiChannel> getWifiFrequencies(java.lang.String ifaceName)
                                        throws KuraException

Obtains information for WiFi Frequencies.

Parameters:

ifaceName - - name of WiFi interface

Returns:

list of channels and frequencies.

Throws:

KuraException

Since:

2.2

getWifiCountryCode

java.lang.String getWifiCountryCode()
                             throws KuraException

Obtains information for WiFi Country code.

Returns:

Name of the Country Code or 00 if unknown.

Throws:

KuraException

Since:

2.2

isWifiDFS

boolean isWifiDFS(java.lang.String ifaceName)
           throws KuraException

Information on Dynamic Frequencies Selection

Parameters:

ifaceName - - name of WiFi interface

Returns:

True if Dynamic Frequencies Selection is supported, false otherwise

Throws:

KuraException

Since:

2.3

isWifiIEEE80211AC

boolean isWifiIEEE80211AC(java.lang.String ifaceName)
                   throws KuraException

Information on WiFi 802.11ac

Parameters:

ifaceName - - name of WiFi interface

Returns:

True if WiFi 802.11ac is supported, false otherwise.

Throws:

KuraException

Since:

2.3

getDhcpLeases

@Deprecated
java.util.List<DhcpLease> getDhcpLeases()
                                             throws KuraException

Deprecated. since 2.6. Use getDhcpLeases(String ifaceName) instead.

Obtains the DHCP Lease values

Returns:

list of ipAddresses, macAddresses, hostnames;

Throws:

KuraException

Since:

2.3

getDhcpLeases

java.util.List<DhcpLease> getDhcpLeases(java.lang.String ifaceName)
                                 throws KuraException

Obtains the DHCP Lease values assigned by a DHCP server running on a given network interface

Parameters:

ifaceName - the name of the network interface

Returns:

list of ipAddresses, macAddresses, hostnames;

Throws:

KuraException

Since:

2.6

getNetworkInterfaceConfigs

java.util.List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>> getNetworkInterfaceConfigs(boolean recompute)
                                                                                                      throws KuraException

Returns a list of all of the configurations associated with all of the interfaces on the system and their current values.

Parameters:

recompute: - if true the configuration and current values are recomputed. Otherwise, a cached value is returned

Returns:

list of NetInterfaceConfigs on the system

Throws:

KuraException

Since:

2.4

getNetworkInterfaceConfigs

java.util.List<NetConfig> getNetworkInterfaceConfigs(java.lang.String interfaceName,
                                                     boolean recompute)
                                              throws KuraException

Returns the configuration information for the specified NetworkInterface name. The returned NetConfig captured how the interface was configured; the returned list will have a NetConfig4 instance for IPv4 and an NetConfig6 instance for IPv6. This should not be confused with the currently active NetInterfaceAddress associated with the NetInterface.

Parameters:

interfaceName: - the name of the network interface

recompute: - if true the configuration are recomputed. Otherwise, a cached value is returned

Returns:

list of NetConfig for this interface.

Throws:

KuraException

Since:

2.4