org.onosproject.net.optical.config

Class OpticalPortConfig

java.lang.Object

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

org.onosproject.net.optical.config.OpticalPortConfig

public final class OpticalPortConfig
extends org.onosproject.net.config.Config<org.onosproject.net.ConnectPoint>

Configurations for an optical port on a device.

Example:

 "ports": {
   "(device Id)/(port number)": {
     "optical": {
              "type": "OCH",
              "speed": 0,
              "port": 10
              ...
     }
   }
 }
 

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	CONFIG_KEY Configuration key for OpticalPortConfig.
static String	NAME
static String	PORT
static String	SPEED
static String	STATIC_LAMBDA
static String	STATIC_PORT
static String	TYPE

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

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

Constructor Summary

Constructors

Constructor and Description
OpticalPortConfig()

Method Summary

Modifier and Type	Method and Description
boolean	isValid()
String	name() Returns the port name associated with this port configuration.
String	numberName() Returns a stringified representation of the port number, configured in some port types without an alphanumeric name as the port name.
OpticalPortConfig	portName(String name) Sets the port name, or updates it if already set.
OpticalPortConfig	portNumberName(Long name) Sets the port name from port number, or updates it if already set.
OpticalPortConfig	portType(org.onosproject.net.Port.Type type) Sets the port type, or updates it if it's already set.
Optional<Integer>	speed() Returns the port speed configured for this port.
OpticalPortConfig	speed(Integer bw) Sets the port speed, or updates it if already set.
Optional<Long>	staticLambda() Returns the output lambda configured for this port.
OpticalPortConfig	staticLambda(Long index) Sets the output lambda index, or updates it if already set.
String	staticPort() Returns the string-representation of name of the output port.
OpticalPortConfig	staticPort(String name) Sets the output port name, or updates it if already set.
org.onosproject.net.Port.Type	type() Returns the Enum value representing the type of port.

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

CONFIG_KEY

public static final String CONFIG_KEY

Configuration key for OpticalPortConfig.

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

PORT

public static final String PORT

See Also:

Constant Field Values

STATIC_PORT

public static final String STATIC_PORT

See Also:

Constant Field Values

STATIC_LAMBDA

public static final String STATIC_LAMBDA

See Also:

Constant Field Values

SPEED

public static final String SPEED

See Also:

Constant Field Values

Constructor Detail

OpticalPortConfig

public OpticalPortConfig()

Method Detail

isValid

public boolean isValid()

Overrides:

isValid in class org.onosproject.net.config.Config<org.onosproject.net.ConnectPoint>

type

public org.onosproject.net.Port.Type type()

Returns the Enum value representing the type of port.

Returns:

the port type, or null if invalid or unset

name

public String name()

Returns the port name associated with this port configuration. The Name is an alphanumeric string.

Returns:

the name of this port, else, an empty string

numberName

public String numberName()

Returns a stringified representation of the port number, configured in some port types without an alphanumeric name as the port name.

Returns:

A string representation of the port number

staticPort

public String staticPort()

Returns the string-representation of name of the output port. This is usually an OMS port for an OCH input ports, or an OCH port for ODU input ports.

Returns:

the name of this port, else, an empty string

staticLambda

public Optional<Long> staticLambda()

Returns the output lambda configured for this port. The lambda value is expressed as a frequency value. If the port type doesn't have a notion of lambdas, this returns an empty Optional.

Returns:

an Optional that may contain a frequency value.

speed

public Optional<Integer> speed()

Returns the port speed configured for this port. If the port doesn't have a notion of speed, this returns an empty Optional.

Returns:

a port speed value whose default is 0.

portType

public OpticalPortConfig portType(org.onosproject.net.Port.Type type)

Sets the port type, or updates it if it's already set. A null argument removes this field.

Parameters:

type - the port type

Returns:

this OpticalPortConfig instance

portName

public OpticalPortConfig portName(String name)

Sets the port name, or updates it if already set. A null argument removes this field.

Parameters:

name - the port's name

Returns:

this OpticalPortConfig instance

portNumberName

public OpticalPortConfig portNumberName(Long name)

Sets the port name from port number, or updates it if already set. A null argument removes this field.

Parameters:

name - the port number, to be used as name

Returns:

this OpticalPortConfig instance

staticPort

public OpticalPortConfig staticPort(String name)

Sets the output port name, or updates it if already set. A null argument removes this field.

Parameters:

name - the output port's name

Returns:

this OpticalPortConfig instance

staticLambda

public OpticalPortConfig staticLambda(Long index)

Sets the output lambda index, or updates it if already set. A null argument removes this field.

Parameters:

index - the output lambda

Returns:

this OpticalPortConfig instance

speed

public OpticalPortConfig speed(Integer bw)

Sets the port speed, or updates it if already set. A null argument removes this field.

Parameters:

bw - the port bandwidth

Returns:

this OpticalPortConfig instance