org.eclipse.kura.net.status

Interface NetworkStatusService

@ProviderType
public interface NetworkStatusService

Service API for getting the network interfaces status.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getInterfaceIds() Return the identifiers of the network interfaces detected in the system.
java.util.Optional<NetworkInterfaceStatus>	getNetworkStatus(java.lang.String interfaceId) Return an optional NetworkInterfaceStatus of the given network interface selected by its id.
java.util.Optional<NetworkInterfaceStatus>	getNetworkStatus(java.lang.String interfaceId, boolean recompute) Return an optional NetworkInterfaceStatus of the given network interface selected by its id.For Ethernet and WiFi interfaces, the identifier is typically the interface name.

Method Detail

getNetworkStatus

java.util.Optional<NetworkInterfaceStatus> getNetworkStatus(java.lang.String interfaceId)
                                                     throws KuraException

Return an optional NetworkInterfaceStatus of the given network interface selected by its id. For Ethernet and WiFi interfaces, the identifier is typically the interface name. For the modems, instead, it is the usb or pci path. If the interface doesn't exist, an Empty value is returned.

Parameters:

interfaceId - the identifier of the network interface

Returns:

the NetworkInterfaceStatus

Throws:

KuraException - when an error occurs while retrieving the status of the given interface

getNetworkStatus

java.util.Optional<NetworkInterfaceStatus> getNetworkStatus(java.lang.String interfaceId,
                                                            boolean recompute)
                                                     throws KuraException

Return an optional NetworkInterfaceStatus of the given network interface selected by its id.For Ethernet and WiFi interfaces, the identifier is typically the interface name. For the modems, instead, it is the usb or pci path. If the interface doesn't exist, an Empty value is returned.

Parameters:

interfaceId - the identifier of the network interface

recompute - If set to true, the NetworkStatusService will perform some additional expensive operations (like AP scanning) to ensure the status returned by the method is up to date. If set to false, it will return the status as returned by the network configuration provider.

Returns:

the NetworkInterfaceStatus

Throws:

KuraException - when an error occurs while retrieving the status of the given interface

getInterfaceIds

java.util.List<java.lang.String> getInterfaceIds()
                                          throws KuraException

Return the identifiers of the network interfaces detected in the system. For Ethernet and WiFi interfaces, the identifier is typically the interface name. For the modems, instead, it is the usb or pci path.

Returns:

a list containing the network interface identifiers

Throws:

KuraException