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<NetConfig>	getFirewallConfiguration() Gets the firewall configuration of the system as currently specified
java.util.List<? extends NetInterfaceConfig<? extends NetInterfaceAddressConfig>>	getNetworkInterfaceConfigs() Returns a list of all of the configurations associated with all of the interfaces on the system.
java.util.List<NetConfig>	getNetworkInterfaceConfigs(java.lang.String interfaceName) Returns the configuration information for the specified NetworkInterface name.
java.util.List<WifiHotspotInfo>	getWifiHotspotList(java.lang.String ifaceName) Obtains information for WiFi hotspots in range.
java.util.Map<java.lang.String,WifiHotspotInfo>	getWifiHotspots(java.lang.String ifaceName) Deprecated.
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.
boolean	rollbackDefaultConfiguration() Deprecated.
boolean	rollbackDefaultFirewallConfiguration() Deprecated.
void	setFirewallNatConfiguration(java.util.List<FirewallNatConfig> natConfigs)
void	setFirewallOpenPortConfiguration(java.util.List<FirewallOpenPortConfigIP<? extends IPAddress>> firewallConfiguration) Sets the 'open port' portion of the firewall configuration
void	setFirewallPortForwardingConfiguration(java.util.List<FirewallPortForwardConfigIP<? extends IPAddress>> firewallConfiguration) Sets the 'port forwarding' portion of the firewall configuration
void	updateEthernetInterfaceConfig(java.lang.String interfaceName, boolean autoConnect, int mtu, java.util.List<NetConfig> netConfigs) Updates the configuration of the specified EthernetInterface.
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) Updates the configuration of the specified ModemInterface.
void	updateWifiInterfaceConfig(java.lang.String interfaceName, boolean autoConnect, WifiAccessPoint accessPoint, java.util.List<NetConfig> netConfigs) Updates the configuration of the specified WifiInterface.
boolean	verifyWifiCredentials(java.lang.String ifaceName, WifiConfig wifiConfig, int tout) Verifies WiFi credentials by trying to establish connection with access point.

Method Detail

getNetworkInterfaceConfigs

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

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

java.util.List<NetConfig> getNetworkInterfaceConfigs(java.lang.String interfaceName)
                                              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 -

Returns:

list of NetConfig for this interface.

Throws:

KuraException

updateEthernetInterfaceConfig

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

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

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

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

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

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

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

Sets the 'open port' portion of the firewall configuration

Parameters:

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

Throws:

KuraException

setFirewallPortForwardingConfiguration

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

Sets the 'port forwarding' portion of the firewall configuration

Parameters:

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

Throws:

KuraException

setFirewallNatConfiguration

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

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

getWifiHotspots

@Deprecated
java.util.Map<java.lang.String,WifiHotspotInfo> getWifiHotspots(java.lang.String ifaceName)
                                                                     throws KuraException

Deprecated.

Obtains information for WiFi hotspots in range.

Parameters:

ifaceName - - name of WiFi interface

Returns:

map of SSIDs with respective hotspot information.

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

rollbackDefaultConfiguration

@Deprecated
boolean rollbackDefaultConfiguration()
                                          throws KuraException

Deprecated.

Rolls back to default network configuration.

Returns:

status

Throws:

KuraException

rollbackDefaultFirewallConfiguration

@Deprecated
boolean rollbackDefaultFirewallConfiguration()
                                                  throws KuraException

Deprecated.

Rolls back to default firewall configuration.

Returns:

status

Throws:

KuraException