Package org.onosproject.net.behaviour.protection

Class ProtectionConfig

java.lang.Object

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

org.onosproject.net.config.BaseConfig<DeviceId>

org.onosproject.net.behaviour.protection.ProtectionConfig

All Implemented Interfaces:

CodecContext

public class ProtectionConfig
extends BaseConfig<DeviceId>

Config object for protection end-point.

Contains equivalent of ProtectedTransportEndpointDescription.

Nested Class Summary

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

Config.FieldPresence

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONFIG_KEY	"protection" : a netcfg ConfigKey for ProtectionConfig.

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

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

Constructor Summary

Constructors

Constructor	Description
ProtectionConfig()	Create a ProtectionConfig.
ProtectionConfig(DeviceId did)	Create a ProtectionConfig for specified Device.

Method Summary

Modifier and Type	Method	Description
ProtectedTransportEndpointDescription	asDescription()	Returns equivalent of this Config as ProtectedTransportEndpointDescription.
java.lang.String	fingerprint()	Returns fingerprint to identify this protected transport entity.
ProtectionConfig	fingerprint(java.lang.String fingerprint)	Sets the fingerprint to identify this protected transport entity.
boolean	isValid()	Indicates whether or not the backing JSON node contains valid data.
java.util.List<TransportEndpointDescription>	paths()	Returns List of underlying transport entity endpoints in priority order.
ProtectionConfig	paths(java.util.List<TransportEndpointDescription> paths)	Sets the List of underlying transport entity endpoints in priority order.
DeviceId	peer()	Returns DeviceId of remote peer of this endpoint.
ProtectionConfig	peer(DeviceId peer)	Sets the DeviceId of remote peer of this endpoint.
java.lang.String	toString()

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

codec, decode, getService, mapper

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, isValidLength, key, node, setList, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, setOrClear, subject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.codec.CodecContext

decode, encode

Field Detail

CONFIG_KEY

public static final java.lang.String CONFIG_KEY

"protection" : a netcfg ConfigKey for ProtectionConfig.

See Also:

Constant Field Values

Constructor Detail

ProtectionConfig

public ProtectionConfig()

Create a ProtectionConfig.

Note: created instance needs to be initialized by #init(..) before using.

ProtectionConfig

public ProtectionConfig(DeviceId did)

Create a ProtectionConfig for specified Device.

Note: created instance is not bound to NetworkConfigService, cannot use Config.apply(). Must be passed to the service using NetworkConfigService#applyConfig

Parameters:

did - DeviceId

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<DeviceId>

Returns:

true if the data is valid; false otherwise

paths

public java.util.List<TransportEndpointDescription> paths()

Returns List of underlying transport entity endpoints in priority order.

Returns:

the transport entity endpoint descriptions

paths

public ProtectionConfig paths(java.util.List<TransportEndpointDescription> paths)

Sets the List of underlying transport entity endpoints in priority order.

Parameters:

paths - the transport entity endpoint descriptions

Returns:

self

peer

public DeviceId peer()

Returns DeviceId of remote peer of this endpoint.

Returns:

the peer

peer

public ProtectionConfig peer(DeviceId peer)

Sets the DeviceId of remote peer of this endpoint.

Parameters:

peer - DeviceId

Returns:

self

fingerprint

public java.lang.String fingerprint()

Returns fingerprint to identify this protected transport entity.

Returns:

the fingerprint

fingerprint

public ProtectionConfig fingerprint(java.lang.String fingerprint)

Sets the fingerprint to identify this protected transport entity.

Parameters:

fingerprint - the fingerprint

Returns:

self

asDescription

public ProtectedTransportEndpointDescription asDescription()

Returns equivalent of this Config as ProtectedTransportEndpointDescription.

Returns:

ProtectedTransportEndpointDescription

toString

public java.lang.String toString()

Overrides:

toString in class Config<DeviceId>