Package org.onosproject.net.config.basics

Class McastConfig

java.lang.Object

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

org.onosproject.net.config.basics.McastConfig

@Beta
public class McastConfig
extends Config<ApplicationId>

Configuration for multicast.

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.Config

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

Constructor Summary

Constructors

Constructor	Description
McastConfig()

Method Summary

Modifier and Type	Method	Description
VlanId	egressInnerVlan()	Gets egress inner VLAN of multicast traffic.
VlanId	egressVlan()	Gets egress VLAN of multicast traffic.
VlanId	ingressVlan()	Gets ingress VLAN of multicast traffic.
boolean	isValid()	Indicates whether or not the backing JSON node contains valid data.
McastConfig	setEgressInnerVlan(VlanId vlanId)	Sets egress inner VLAN of multicast traffic.
McastConfig	setEgressVlan(VlanId vlanId)	Sets egress VLAN of multicast traffic.
McastConfig	setIngressVlan(VlanId vlanId)	Sets ingress VLAN of multicast traffic.

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

McastConfig

public McastConfig()

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

Returns:

true if the data is valid; false otherwise

ingressVlan

public VlanId ingressVlan()

Gets ingress VLAN of multicast traffic.

Returns:

Ingress VLAN ID

setIngressVlan

public McastConfig setIngressVlan(VlanId vlanId)

Sets ingress VLAN of multicast traffic.

Parameters:

vlanId - Ingress VLAN ID

Returns:

this McastConfig

egressVlan

public VlanId egressVlan()

Gets egress VLAN of multicast traffic.

Returns:

Egress VLAN ID

setEgressVlan

public McastConfig setEgressVlan(VlanId vlanId)

Sets egress VLAN of multicast traffic.

Parameters:

vlanId - Egress VLAN ID

Returns:

this McastConfig

egressInnerVlan

public VlanId egressInnerVlan()

Gets egress inner VLAN of multicast traffic.

Returns:

Egress inner VLAN ID

setEgressInnerVlan

public McastConfig setEgressInnerVlan(VlanId vlanId)

Sets egress inner VLAN of multicast traffic.

Parameters:

vlanId - Egress inner VLAN ID

Returns:

this McastConfig