org.onosproject.net.config.basics

Class BasicHostConfig

java.lang.Object

org.onosproject.net.config.Config<S>

org.onosproject.net.config.basics.AllowedEntityConfig<S>

org.onosproject.net.config.basics.BasicElementConfig<HostId>

org.onosproject.net.config.basics.BasicHostConfig

public final class BasicHostConfig
extends BasicElementConfig<HostId>

Basic configuration for network end-station hosts.

Nested Class Summary

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

Config.FieldPresence

Field Summary

Fields inherited from class org.onosproject.net.config.basics.BasicElementConfig

LATITUDE, LONGITUDE, NAME, OWNER, RACK_ADDRESS, ZERO_THRESHOLD

Fields inherited from class org.onosproject.net.config.basics.AllowedEntityConfig

ALLOWED

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

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

Constructor Summary

Constructors

Constructor and Description
BasicHostConfig()

Method Summary

Modifier and Type	Method and Description
Set<org.onlab.packet.IpAddress>	ipAddresses() Returns IP addresses of the host.
boolean	isValid() Indicates whether or not the backing JSON node contains valid data.
ConnectPoint	location() Returns location of the host.
BasicHostConfig	setIps(Set<org.onlab.packet.IpAddress> ipAddresses) Sets the IP addresses of the host.
BasicHostConfig	setLocation(String location) Sets the location of the host.

Methods inherited from class org.onosproject.net.config.basics.BasicElementConfig

geoCoordsSet, latitude, latitude, longitude, longitude, name, name, owner, owner, rackAddress, rackAddress

Methods inherited from class org.onosproject.net.config.basics.AllowedEntityConfig

isAllowed, isAllowed

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

apply, clear, get, get, get, get, get, get, getList, getList, 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

Constructor Detail

BasicHostConfig

public BasicHostConfig()

Method Detail

isValid

public boolean isValid()

Description copied from class: Config

Indicates whether or not the backing JSON node contains valid data.

Default implementation returns true. Subclasses are expected to override this with their own validation. Implementations are free to throw a RuntimeException if data is invalid.

Overrides:

isValid in class Config<HostId>

Returns:

true if the data is valid; false otherwise

location

public ConnectPoint location()

Returns location of the host.

Returns:

location of the host or null if not set

Throws:

IllegalArgumentException - if not specified with correct format

setLocation

public BasicHostConfig setLocation(String location)

Sets the location of the host.

Parameters:

location - location of the host or null to unset

Returns:

the config of the host

ipAddresses

public Set<org.onlab.packet.IpAddress> ipAddresses()

Returns IP addresses of the host.

Returns:

IP addresses of the host or null if not set

Throws:

IllegalArgumentException - if not specified with correct format

setIps

public BasicHostConfig setIps(Set<org.onlab.packet.IpAddress> ipAddresses)

Sets the IP addresses of the host.

Parameters:

ipAddresses - IP addresses of the host or null to unset

Returns:

the config of the host