org.eclipse.kura.net.dhcp

Interface DhcpServerConfig

All Superinterfaces:

NetConfig

All Known Subinterfaces:

DhcpServerConfig4, DhcpServerConfig6

All Known Implementing Classes:

DhcpServerConfigIP, DhcpServerConfigIP4, DhcpServerConfigIP6

@ProviderType
public interface DhcpServerConfig
extends NetConfig

Marker interface for all DHCP server configuration classes

Method Summary

Modifier and Type	Method and Description
int	getDefaultLeaseTime() Returns the default lease time offered by the DHCP server
java.util.List<? extends IPAddress>	getDnsServers() Returns the DNS servers associated with this DhcpServerConfig that will be passed to DHCP clients
java.lang.String	getInterfaceName() Returns the interface name associated with this DhcpServerConfig
int	getMaximumLeaseTime() Returns the maximum lease time offered by the DHCP server
short	getPrefix() Returns the network prefix length for this DHCP server's address range This is also known as the subnet mask in the context of IPv4 addresses.
IPAddress	getRangeEnd() Returns the ending DHCP server InetAddress to provide to DHCP clients.
IPAddress	getRangeStart() Returns the starting DHCP server InetAddress to provide to DHCP clients.
IPAddress	getRouterAddress() Returns the router IP address associated with this DhcpServerConfig
IPAddress	getSubnet() Returns the subnet associated with this DhcpServerConfig
IPAddress	getSubnetMask() Returns the subnet mask associated with this DhcpServerConfig
boolean	isEnabled() Returns the boolean status associated with this DhcpServerConfig
boolean	isPassDns() Returns whether or not DHCP clients should get DNS services.

Methods inherited from interface org.eclipse.kura.net.NetConfig

isValid

Method Detail

getInterfaceName

java.lang.String getInterfaceName()

Returns the interface name associated with this DhcpServerConfig

Returns:

a String representing the interface name

isEnabled

boolean isEnabled()

Returns the boolean status associated with this DhcpServerConfig

Returns:

a boolean representing the status

getSubnet

IPAddress getSubnet()

Returns the subnet associated with this DhcpServerConfig

Returns:

a IPAddress representing the subnet

getRouterAddress

IPAddress getRouterAddress()

Returns the router IP address associated with this DhcpServerConfig

Returns:

a IPAddress representing the router IP address

getSubnetMask

IPAddress getSubnetMask()

Returns the subnet mask associated with this DhcpServerConfig

Returns:

a IPAddress representing the subnet mask

getDefaultLeaseTime

int getDefaultLeaseTime()

Returns the default lease time offered by the DHCP server

Returns:

the default lease time (in seconds) offered by the DHCP server

getMaximumLeaseTime

int getMaximumLeaseTime()

Returns the maximum lease time offered by the DHCP server

Returns:

the maximum lease time (in seconds) offered by the DHCP server

getPrefix

short getPrefix()

Returns the network prefix length for this DHCP server's address range This is also known as the subnet mask in the context of IPv4 addresses. Typical IPv4 values would be 8 (255.0.0.0), 16 (255.255.0.0) or 24 (255.255.255.0). Typical IPv6 values would be 128 (::1/128) or 10 (fe80::203:baff:fe27:1243/10)

Returns:

a short representing the prefix length for the subnet of the DHCP server address range.

getRangeStart

IPAddress getRangeStart()

Returns the starting DHCP server InetAddress to provide to DHCP clients.

Returns:

the starting address to provide to DHCP clients

getRangeEnd

IPAddress getRangeEnd()

Returns the ending DHCP server InetAddress to provide to DHCP clients.

Returns:

the ending address to provide to DHCP clients

isPassDns

boolean isPassDns()

Returns whether or not DHCP clients should get DNS services.

Returns:

a boolean representing whether or not DHCP clients should receive DNS services.

getDnsServers

java.util.List<? extends IPAddress> getDnsServers()

Returns the DNS servers associated with this DhcpServerConfig that will be passed to DHCP clients

Returns:

a List of IPAddresses that represent the DNS servers