org.onosproject.incubator.net.l2monitoring.cfm

Interface MaintenanceDomain

All Superinterfaces:

NetworkResource

All Known Implementing Classes:

DefaultMaintenanceDomain

public interface MaintenanceDomain
extends NetworkResource

A model of the Maintenance Domain. See IEEE 802.1Q Section 12.14.5.1.3 CFM entities.
This is the root of the L2 Monitoring hierarchy
|-Maintenance-Domain*
|-MdId (MdIdCharStr or MdIdDomainName or MdIdMacUint or MdIdNone)
|-Maintenance-Association*
|-MaIdShort (MaIdCharStr or MaIdPrimaryVid or MaId2Octet or MaIdRfc2685VpnId or MaIdIccY1731)
|-Component*
|-Mep* (Maintenance-Association-EndPoint) and MepEntry*
| |-MepId
| |-MepLbEntry
| |-MepLtEntry
| | |-MepLtTransactionEntry*
| | |-MepLtReply*
| | |-SenderIdTlv
| |-DelayMeasurementCreate (SOAM)* and DelayMeasurementEntry
| | |-DmId
| | |-DelayMeasurementStatCurrent
| | |-DelayMeasurementStatHistory*
| |-LossMeasurementCreate (SOAM)* and LossMeasurementEntry
| | |-LmId
| | |-LossMeasurementStatCurrent
| | |-LossMeasurementStatHistory*
| |-RemoteMepEntry*
| | |-RemoteMepId
|-RemoteMepId*

*above indicates 0-many can be created -Create suffix means the Object is part of a request -Entry suffix means the Object is part of a reply

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MaintenanceDomain.MdBuilder Builder for MaintenanceDomain.
static class	MaintenanceDomain.MdLevel An enumerated set of values to represent MD Level.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<MaintenanceAssociation>	maintenanceAssociationList() Retrieve the MA list of the MD.
MdId	mdId() Retrieve the id of the Maintenance Domain.
MaintenanceDomain.MdLevel	mdLevel() Retrieve the level of the MD.
short	mdNumericId() Numeric identifier.
MaintenanceDomain	withMaintenanceAssociationList(java.util.Collection<MaintenanceAssociation> maintenanceAssociationList) Replace the MA list of the MD.

Method Detail

mdId

MdId mdId()

Retrieve the id of the Maintenance Domain.

Returns:

The id object

mdLevel

MaintenanceDomain.MdLevel mdLevel()

Retrieve the level of the MD.

Returns:

An enumerated value for the level

maintenanceAssociationList

java.util.Collection<MaintenanceAssociation> maintenanceAssociationList()

Retrieve the MA list of the MD.

Returns:

The collection of Maintenance Associations

withMaintenanceAssociationList

MaintenanceDomain withMaintenanceAssociationList(java.util.Collection<MaintenanceAssociation> maintenanceAssociationList)

Replace the MA list of the MD.

Parameters:

maintenanceAssociationList - A list of MAs to replace the existing one

Returns:

A new version of the MD with the given MA list

mdNumericId

short mdNumericId()

Numeric identifier. Some systems require to have a placeholder for a numeric identifier in addition to the MdId

Returns:

A short numeric id that's been assigned to the MD