Package io.openems.edge.core.host

Class NetworkInterface<A>

java.lang.Object

io.openems.edge.core.host.NetworkInterface<A>

public class NetworkInterface<A>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Inet4AddressWithSubnetmask	DEFAULT_ETH0_ADDRESS	This default address is always added to eth0.

Constructor Summary

Constructors

Constructor	Description
NetworkInterface(String name, ConfigurationProperty<Boolean> dhcp, ConfigurationProperty<Boolean> linkLocalAddressing, ConfigurationProperty<Inet4Address> gateway, ConfigurationProperty<Inet4Address> dns, ConfigurationProperty<Set<Inet4AddressWithSubnetmask>> addresses, A attachment)

Method Summary

Modifier and Type	Method	Description
static NetworkInterface<?>	from(String name, com.google.gson.JsonObject j)	Parses a JsonObject to a NetworkInterface object.
ConfigurationProperty<Set<Inet4AddressWithSubnetmask>>	getAddresses()	Gets the addresses configured in the network.
ConfigurationProperty<Set<Inet4AddressWithSubnetmask>>	getAddressesIncludingDefaults()	Gets the configured addresses including the default addresses if any.
A	getAttachment()	Gets the network interface attachment.
ConfigurationProperty<Boolean>	getDhcp()	Gets the network interface DHCP option.
ConfigurationProperty<Inet4Address>	getDns()	Gets the network interface DNS server.
ConfigurationProperty<Inet4Address>	getGateway()	Gets the network interface Gateway.
ConfigurationProperty<Boolean>	getLinkLocalAddressing()	Gets the network interface LinkLocalAddressing option.
String	getName()	Gets the network interface name.
com.google.gson.JsonObject	toJson()	Exports this NetworkInterface configuration as JSON.
boolean	updateFrom(NetworkInterface<?> change)	Updates the interface from a NetworkInterfaceChange object.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_ETH0_ADDRESS

public static final Inet4AddressWithSubnetmask DEFAULT_ETH0_ADDRESS

This default address is always added to eth0.

Constructor Details

NetworkInterface

public NetworkInterface(String name,
 ConfigurationProperty<Boolean> dhcp,
 ConfigurationProperty<Boolean> linkLocalAddressing,
 ConfigurationProperty<Inet4Address> gateway,
 ConfigurationProperty<Inet4Address> dns,
 ConfigurationProperty<Set<Inet4AddressWithSubnetmask>> addresses,
 A attachment)
                 throws OpenemsException

Throws:

OpenemsException

Method Details

from

public static NetworkInterface<?> from(String name,
 com.google.gson.JsonObject j)
                                throws OpenemsError.OpenemsNamedException

Parses a JsonObject to a NetworkInterface object.

Parameters:

name - the name of the network interface, e.g. "eth0"

j - the JsonObject

Returns:

the new NetworkInterface

Throws:

OpenemsError.OpenemsNamedException - on error

getName

public String getName()

Gets the network interface name.

Returns:

the name

getDhcp

public ConfigurationProperty<Boolean> getDhcp()

Gets the network interface DHCP option.

Returns:

the DHCP option; true for enabled; false for disabled

getLinkLocalAddressing

public ConfigurationProperty<Boolean> getLinkLocalAddressing()

Gets the network interface LinkLocalAddressing option.

Returns:

the LinkLocalAddressing option; true for enabled; false for disabled

getGateway

public ConfigurationProperty<Inet4Address> getGateway()

Gets the network interface Gateway.

Returns:

the Gateway

getAddresses

public ConfigurationProperty<Set<Inet4AddressWithSubnetmask>> getAddresses()

Gets the addresses configured in the network.

Returns:

the addresses mapped with label.

getDns

public ConfigurationProperty<Inet4Address> getDns()

Gets the network interface DNS server.

Returns:

the DNS server

getAttachment

public A getAttachment()

Gets the network interface attachment.

An arbitrary attachment to this NetworkInterface. Can be used to store e.g. a configuration file path.

Returns:

the attachment

getAddressesIncludingDefaults

public ConfigurationProperty<Set<Inet4AddressWithSubnetmask>> getAddressesIncludingDefaults()

Gets the configured addresses including the default addresses if any.

Returns:

all addresses

toJson

public com.google.gson.JsonObject toJson()

Exports this NetworkInterface configuration as JSON.

 {
   "dhcp": boolean,
   "linkLocalAddressing": boolean,
   "gateway": string,
   "dns": string,
   "addresses": [{ 
     "label": string, 
     "address": string, 
     "subnetmask": string 
   }]
 }
 

Returns:

configuration as JSON

Throws:

OpenemsError.OpenemsNamedException - on error.

updateFrom

public boolean updateFrom(NetworkInterface<?> change)

Updates the interface from a NetworkInterfaceChange object.

Parameters:

change - the object containing the changes

Returns:

true if values changed