org.onosproject.dhcp.impl

Class DhcpConfig

java.lang.Object

org.onosproject.net.config.Config<org.onosproject.core.ApplicationId>

org.onosproject.dhcp.impl.DhcpConfig

public class DhcpConfig
extends org.onosproject.net.config.Config<org.onosproject.core.ApplicationId>

DHCP Config class.

Nested Class Summary

Nested classes/interfaces inherited from class org.onosproject.net.config.Config

org.onosproject.net.config.Config.FieldPresence

Field Summary

Fields

Modifier and Type	Field and Description
static String	BROADCAST_ADDRESS
static int	DEFAULT
static String	DEFAULT_TIMEOUT
static String	DOMAIN_SERVER
static String	END_IP
static String	LEASE_TIME
static String	MY_IP
static String	MY_MAC
static String	REBIND_TIME
static String	RENEW_TIME
static String	ROUTER_ADDRESS
static String	START_IP
static String	SUBNET_MASK
static String	TIMER_DELAY
static String	TTL

Fields inherited from class org.onosproject.net.config.Config

array, delegate, key, mapper, node, object, subject

Constructor Summary

Constructors

Constructor and Description
DhcpConfig()

Method Summary

Modifier and Type	Method and Description
org.onlab.packet.Ip4Address	broadcastAddress() Returns the broadcast address.
org.onosproject.net.config.basics.BasicElementConfig	broadcastAddress(String broadcast) Sets the broadcast address.
int	defaultTimeout() Returns the default timeout for pending assignments.
org.onosproject.net.config.basics.BasicElementConfig	defaultTimeout(int defaultTimeout) Sets the default timeout for pending assignments.
org.onlab.packet.Ip4Address	domainServer() Returns the Domain Server Address.
org.onosproject.net.config.basics.BasicElementConfig	domainServer(String domain) Sets the Domain Server Address.
org.onlab.packet.Ip4Address	endIp() Returns the end IP for the available IP Range.
org.onosproject.net.config.basics.BasicElementConfig	endIp(String endIp) Sets the end IP for the available IP Range.
org.onlab.packet.Ip4Address	ip() Returns the dhcp server ip.
org.onosproject.net.config.basics.BasicElementConfig	ip(String ip) Sets the dhcp server ip.
boolean	isValid()
int	leaseTime() Returns the Lease Time offered by the DHCP Server.
org.onosproject.net.config.basics.BasicElementConfig	leaseTime(int lease) Sets the Lease Time offered by the DHCP Server.
org.onlab.packet.MacAddress	mac() Returns the dhcp server mac.
org.onosproject.net.config.basics.BasicElementConfig	mac(String mac) Sets the dhcp server mac.
int	rebindTime() Returns the Rebind Time offered by the DHCP Server.
org.onosproject.net.config.basics.BasicElementConfig	rebindTime(int rebind) Sets the Rebind Time offered by the DHCP Server.
int	renewTime() Returns the Renew Time offered by the DHCP Server.
org.onosproject.net.config.basics.BasicElementConfig	renewTime(int renew) Sets the Renew Time offered by the DHCP Server.
org.onlab.packet.Ip4Address	routerAddress() Returns the Router Address.
org.onosproject.net.config.basics.BasicElementConfig	routerAddress(String router) Sets the Router Address.
org.onlab.packet.Ip4Address	startIp() Returns the start IP for the available IP Range.
org.onosproject.net.config.basics.BasicElementConfig	startIp(String startIp) Sets the start IP for the available IP Range.
org.onlab.packet.Ip4Address	subnetMask() Returns the subnet mask.
org.onosproject.net.config.basics.BasicElementConfig	subnetMask(String subnet) Sets the subnet mask.
int	timerDelay() Returns the delay in minutes after which the dhcp server will purge expired entries.
org.onosproject.net.config.basics.BasicElementConfig	timerDelay(int delay) Sets the delay after which the dhcp server will purge expired entries.
int	ttl() Returns the Time To Live for the reply packets.
org.onosproject.net.config.basics.BasicElementConfig	ttl(int ttl) Sets the Time To Live for the reply packets.

Methods inherited from class org.onosproject.net.config.Config

apply, clear, get, get, get, get, get, get, getList, getList, hasField, hasField, hasFields, hasFields, hasOnlyFields, hasOnlyFields, init, isBoolean, isBoolean, isConnectPoint, isConnectPoint, isDecimal, isDecimal, isIntegralNumber, isIntegralNumber, isIpAddress, isIpAddress, isIpPrefix, isIpPrefix, isMacAddress, isMacAddress, isNumber, isNumber, isString, isString, isTpPort, isTpPort, key, node, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, subject

Methods inherited from class java.lang.Object

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

Field Detail

MY_IP

public static final String MY_IP

See Also:

Constant Field Values

MY_MAC

public static final String MY_MAC

See Also:

Constant Field Values

SUBNET_MASK

public static final String SUBNET_MASK

See Also:

Constant Field Values

BROADCAST_ADDRESS

public static final String BROADCAST_ADDRESS

See Also:

Constant Field Values

ROUTER_ADDRESS

public static final String ROUTER_ADDRESS

See Also:

Constant Field Values

DOMAIN_SERVER

public static final String DOMAIN_SERVER

See Also:

Constant Field Values

TTL

public static final String TTL

See Also:

Constant Field Values

LEASE_TIME

public static final String LEASE_TIME

See Also:

Constant Field Values

RENEW_TIME

public static final String RENEW_TIME

See Also:

Constant Field Values

REBIND_TIME

public static final String REBIND_TIME

See Also:

Constant Field Values

TIMER_DELAY

public static final String TIMER_DELAY

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final String DEFAULT_TIMEOUT

See Also:

Constant Field Values

START_IP

public static final String START_IP

See Also:

Constant Field Values

END_IP

public static final String END_IP

See Also:

Constant Field Values

DEFAULT

public static final int DEFAULT

See Also:

Constant Field Values

Constructor Detail

DhcpConfig

public DhcpConfig()

Method Detail

isValid

public boolean isValid()

Overrides:

isValid in class org.onosproject.net.config.Config<org.onosproject.core.ApplicationId>

ip

public org.onlab.packet.Ip4Address ip()

Returns the dhcp server ip.

Returns:

ip address or null if not set

ip

public org.onosproject.net.config.basics.BasicElementConfig ip(String ip)

Sets the dhcp server ip.

Parameters:

ip - new ip address; null to clear

Returns:

self

mac

public org.onlab.packet.MacAddress mac()

Returns the dhcp server mac.

Returns:

server mac or null if not set

mac

public org.onosproject.net.config.basics.BasicElementConfig mac(String mac)

Sets the dhcp server mac.

Parameters:

mac - new mac address; null to clear

Returns:

self

subnetMask

public org.onlab.packet.Ip4Address subnetMask()

Returns the subnet mask.

Returns:

subnet mask or null if not set

subnetMask

public org.onosproject.net.config.basics.BasicElementConfig subnetMask(String subnet)

Sets the subnet mask.

Parameters:

subnet - new subnet mask; null to clear

Returns:

self

broadcastAddress

public org.onlab.packet.Ip4Address broadcastAddress()

Returns the broadcast address.

Returns:

broadcast address or null if not set

broadcastAddress

public org.onosproject.net.config.basics.BasicElementConfig broadcastAddress(String broadcast)

Sets the broadcast address.

Parameters:

broadcast - new broadcast address; null to clear

Returns:

self

ttl

public int ttl()

Returns the Time To Live for the reply packets.

Returns:

ttl or -1 if not set

ttl

public org.onosproject.net.config.basics.BasicElementConfig ttl(int ttl)

Sets the Time To Live for the reply packets.

Parameters:

ttl - new ttl; null to clear

Returns:

self

leaseTime

public int leaseTime()

Returns the Lease Time offered by the DHCP Server.

Returns:

lease time or -1 if not set

leaseTime

public org.onosproject.net.config.basics.BasicElementConfig leaseTime(int lease)

Sets the Lease Time offered by the DHCP Server.

Parameters:

lease - new lease time; null to clear

Returns:

self

renewTime

public int renewTime()

Returns the Renew Time offered by the DHCP Server.

Returns:

renew time or -1 if not set

renewTime

public org.onosproject.net.config.basics.BasicElementConfig renewTime(int renew)

Sets the Renew Time offered by the DHCP Server.

Parameters:

renew - new renew time; null to clear

Returns:

self

rebindTime

public int rebindTime()

Returns the Rebind Time offered by the DHCP Server.

Returns:

rebind time or -1 if not set

rebindTime

public org.onosproject.net.config.basics.BasicElementConfig rebindTime(int rebind)

Sets the Rebind Time offered by the DHCP Server.

Parameters:

rebind - new rebind time; null to clear

Returns:

self

routerAddress

public org.onlab.packet.Ip4Address routerAddress()

Returns the Router Address.

Returns:

router address or null if not set

routerAddress

public org.onosproject.net.config.basics.BasicElementConfig routerAddress(String router)

Sets the Router Address.

Parameters:

router - new router address; null to clear

Returns:

self

domainServer

public org.onlab.packet.Ip4Address domainServer()

Returns the Domain Server Address.

Returns:

domain server address or null if not set

domainServer

public org.onosproject.net.config.basics.BasicElementConfig domainServer(String domain)

Sets the Domain Server Address.

Parameters:

domain - new domain server address; null to clear

Returns:

self

timerDelay

public int timerDelay()

Returns the delay in minutes after which the dhcp server will purge expired entries.

Returns:

time delay or -1 if not set

timerDelay

public org.onosproject.net.config.basics.BasicElementConfig timerDelay(int delay)

Sets the delay after which the dhcp server will purge expired entries.

Parameters:

delay - new time delay; null to clear

Returns:

self

defaultTimeout

public int defaultTimeout()

Returns the default timeout for pending assignments.

Returns:

default timeout or -1 if not set

defaultTimeout

public org.onosproject.net.config.basics.BasicElementConfig defaultTimeout(int defaultTimeout)

Sets the default timeout for pending assignments.

Parameters:

defaultTimeout - new default timeout; null to clear

Returns:

self

startIp

public org.onlab.packet.Ip4Address startIp()

Returns the start IP for the available IP Range.

Returns:

start IP or null if not set

startIp

public org.onosproject.net.config.basics.BasicElementConfig startIp(String startIp)

Sets the start IP for the available IP Range.

Parameters:

startIp - new start IP; null to clear

Returns:

self

endIp

public org.onlab.packet.Ip4Address endIp()

Returns the end IP for the available IP Range.

Returns:

end IP or null if not set

endIp

public org.onosproject.net.config.basics.BasicElementConfig endIp(String endIp)

Sets the end IP for the available IP Range.

Parameters:

endIp - new end IP; null to clear

Returns:

self