org.onosproject.incubator.net.l2monitoring.soam

Interface SoamService

All Known Subinterfaces:

SoamDmProgrammable

public interface SoamService

Methods callable on MEPs to implement SOAM functionality. Most of the methods have been derived from the MEF 38 and MEF 39 standards

Method Summary

Modifier and Type	Method and Description
void	abortDm(MdId mdName, MaIdShort maName, MepId mepId) Stop all Delay Measurements on a particular MEP.
void	abortDm(MdId mdName, MaIdShort maName, MepId mepId, SoamId dmId) Stop a particular named Delay Measurement on a particular MEP.
void	abortLm(MdId mdName, MaIdShort maName, MepId mepId) Stop all Loss Measurements on a particular MEP.
void	abortLm(MdId mdName, MaIdShort maName, MepId mepId, SoamId lmId) Stop a particular named Loss Measurement on a particular MEP.
void	abortTestSignal(MdId mdName, MaIdShort maName, MepId mepId) Abort a Test Signal operation on a particular MEP.
void	clearDelayHistoryStats(MdId mdName, MaIdShort maName, MepId mepId) Clear the history stats on all Delay Measurements on a particular MEP.
void	clearDelayHistoryStats(MdId mdName, MaIdShort maName, MepId mepId, SoamId dmId) Clear the history stats on a named Delay Measurement on a particular MEP.
void	clearLossHistoryStats(MdId mdName, MaIdShort maName, MepId mepId) Clear the history stats on all Loss Measurements on a particular MEP.
void	clearLossHistoryStats(MdId mdName, MaIdShort maName, MepId mepId, SoamId lmId) Clear the history stats on a named Loss Measurement on a particular MEP.
java.util.Optional<SoamId>	createDm(MdId mdName, MaIdShort maName, MepId mepId, DelayMeasurementCreate dm) Create a Delay Measurement on a particular MEP.
java.util.Optional<SoamId>	createLm(MdId mdName, MaIdShort maName, MepId mepId, LossMeasurementCreate lm) Create a Loss Measurement on a particular MEP.
void	createTestSignal(MdId mdName, MaIdShort maName, MepId mepId, MepTsCreate tsCreate) Create a Test Signal operation on a particular MEP.
java.util.Collection<DelayMeasurementEntry>	getAllDms(MdId mdName, MaIdShort maName, MepId mepId) Get all of the Delay Measurements on a particular MEP.
java.util.Collection<LossMeasurementEntry>	getAllLms(MdId mdName, MaIdShort maName, MepId mepId) Get all of the Loss Measurements on a particular MEP.
DelayMeasurementEntry	getDm(MdId mdName, MaIdShort maName, MepId mepId, SoamId dmId) Get a named Delay Measurements on a particular MEP.
DelayMeasurementStatCurrent	getDmCurrentStat(MdId mdName, MaIdShort maName, MepId mepId, SoamId dmId) Get only the current stats of a named Delay Measurements on a particular MEP.
java.util.Collection<DelayMeasurementStatHistory>	getDmHistoricalStats(MdId mdName, MaIdShort maName, MepId mepId, SoamId dmId) Get only the history stats of a named Delay Measurements on a particular MEP.
LossMeasurementEntry	getLm(MdId mdName, MaIdShort maName, MepId mepId, SoamId lmId) Get a named Loss Measurements on a particular MEP.
LossMeasurementStatCurrent	getLmCurrentStat(MdId mdName, MaIdShort maName, MepId mepId, SoamId lmId) Get only the current stats of a named Loss Measurements on a particular MEP.
java.util.Collection<LossMeasurementStatCurrent>	getLmHistoricalStats(MdId mdName, MaIdShort maName, MepId mepId, SoamId lmId) Get only the history stats of a named Loss Measurements on a particular MEP.

Method Detail

getAllDms

java.util.Collection<DelayMeasurementEntry> getAllDms(MdId mdName,
                                                      MaIdShort maName,
                                                      MepId mepId)
                                               throws CfmConfigException,
                                                      SoamConfigException

Get all of the Delay Measurements on a particular MEP.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Returns:

A collection of Delay Measurements and their children

Throws:

CfmConfigException - If there's a problem with Cfm attributes

SoamConfigException - If there's a problem with Soam attributes

getDm

DelayMeasurementEntry getDm(MdId mdName,
                            MaIdShort maName,
                            MepId mepId,
                            SoamId dmId)
                     throws CfmConfigException,
                            SoamConfigException

Get a named Delay Measurements on a particular MEP. While devices are not required to have named delay measurement objects so do. The getAllDms() method may have produced a list of DM Ids that can be used here to retrieve one DM at a time

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

dmId - The id of the Delay Measurement

Returns:

A collection of Delay Measurements and their children

Throws:

CfmConfigException - If there's a problem with Cfm attributes

SoamConfigException - If there's a problem with Soam attributes

getDmCurrentStat

DelayMeasurementStatCurrent getDmCurrentStat(MdId mdName,
                                             MaIdShort maName,
                                             MepId mepId,
                                             SoamId dmId)
                                      throws CfmConfigException,
                                             SoamConfigException

Get only the current stats of a named Delay Measurements on a particular MEP. It may be useful to retrieve the current stats on their own to retrieve values between Delay Measurement intervals

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

dmId - The id of the Delay Measurement

Returns:

A collection of Delay Measurements and their children

Throws:

CfmConfigException - If there's a problem with Cfm attributes

SoamConfigException - If there's a problem with Soam attributes

getDmHistoricalStats

java.util.Collection<DelayMeasurementStatHistory> getDmHistoricalStats(MdId mdName,
                                                                       MaIdShort maName,
                                                                       MepId mepId,
                                                                       SoamId dmId)
                                                                throws CfmConfigException,
                                                                       SoamConfigException

Get only the history stats of a named Delay Measurements on a particular MEP. It may be useful to retrieve the history stats on their own to retrieve values before they have been overwritten

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

dmId - The id of the Delay Measurement

Returns:

A collection of Delay Measurements and their children

Throws:

CfmConfigException - If there's a problem with Cfm attributes

SoamConfigException - If there's a problem with Soam attributes

createDm

java.util.Optional<SoamId> createDm(MdId mdName,
                                    MaIdShort maName,
                                    MepId mepId,
                                    DelayMeasurementCreate dm)
                             throws CfmConfigException,
                                    SoamConfigException

Create a Delay Measurement on a particular MEP. MEF 39 defines a delay measurement as an ephemeral object and does not require the supporting device to persist it. It runs as an action until stopped with the corresponding abort action below.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

dm - The parameters of the Delay Measurement

Returns:

The id of the newly created DM if available

Throws:

CfmConfigException - If there's a problem with Cfm attributes

SoamConfigException - If there's a problem with Soam attributes

abortDm

void abortDm(MdId mdName,
             MaIdShort maName,
             MepId mepId)
      throws CfmConfigException

Stop all Delay Measurements on a particular MEP. This stops the Delay Measurement activity started through the createDm action above. It is up to the individual device how to implement it. It does not necessarily mean delete the DM.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Throws:

CfmConfigException - When the command cannot be completed

abortDm

void abortDm(MdId mdName,
             MaIdShort maName,
             MepId mepId,
             SoamId dmId)
      throws CfmConfigException

Stop a particular named Delay Measurement on a particular MEP. This stops the Delay Measurement activity started through the createDm action above. It is up to the individual device how to implement it. It does not necessarily mean delete the DM.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

dmId - The id of the DM

Throws:

CfmConfigException - When the command cannot be completed

clearDelayHistoryStats

void clearDelayHistoryStats(MdId mdName,
                            MaIdShort maName,
                            MepId mepId)
                     throws CfmConfigException

Clear the history stats on all Delay Measurements on a particular MEP. This removes any historical stats stored on a device for one MEP It does NOT require that the Delay Measurement test is aborted.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Throws:

CfmConfigException - When the command cannot be completed

clearDelayHistoryStats

void clearDelayHistoryStats(MdId mdName,
                            MaIdShort maName,
                            MepId mepId,
                            SoamId dmId)
                     throws CfmConfigException

Clear the history stats on a named Delay Measurement on a particular MEP. This removes any historical stats stored on a device for one DM on one MEP It does NOT require that the Delay Measurement test is aborted.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

dmId - The id of the DM

Throws:

CfmConfigException - When the command cannot be completed

getAllLms

java.util.Collection<LossMeasurementEntry> getAllLms(MdId mdName,
                                                     MaIdShort maName,
                                                     MepId mepId)
                                              throws CfmConfigException,
                                                     SoamConfigException

Get all of the Loss Measurements on a particular MEP.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Returns:

A collection of Loss Measurements and their children

Throws:

CfmConfigException - When the command cannot be completed

SoamConfigException - When the command cannot be completed

getLm

LossMeasurementEntry getLm(MdId mdName,
                           MaIdShort maName,
                           MepId mepId,
                           SoamId lmId)
                    throws CfmConfigException,
                           SoamConfigException

Get a named Loss Measurements on a particular MEP. While devices are not required to have named Loss measurement objects some do. The getAllLms() method may have produced a list of LM Ids that can be used here to retrieve one LM at a time

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

lmId - The id of the Loss Measurement

Returns:

A collection of Loss Measurements and their children

Throws:

CfmConfigException - When the command cannot be completed

SoamConfigException - When the command cannot be completed

getLmCurrentStat

LossMeasurementStatCurrent getLmCurrentStat(MdId mdName,
                                            MaIdShort maName,
                                            MepId mepId,
                                            SoamId lmId)

Get only the current stats of a named Loss Measurements on a particular MEP. It may be useful to retrieve the current stats on their own to retrieve values between Loss Measurement intervals

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

lmId - The id of the Loss Measurement

Returns:

A collection of Loss Measurements and their children

getLmHistoricalStats

java.util.Collection<LossMeasurementStatCurrent> getLmHistoricalStats(MdId mdName,
                                                                      MaIdShort maName,
                                                                      MepId mepId,
                                                                      SoamId lmId)

Get only the history stats of a named Loss Measurements on a particular MEP. It may be useful to retrieve the history stats on their own to retrieve values before they have been overwritten

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

lmId - The id of the Loss Measurement

Returns:

A collection of Loss Measurements and their children

createLm

java.util.Optional<SoamId> createLm(MdId mdName,
                                    MaIdShort maName,
                                    MepId mepId,
                                    LossMeasurementCreate lm)
                             throws CfmConfigException,
                                    SoamConfigException

Create a Loss Measurement on a particular MEP. MEF 39 defines a Loss measurement as an ephemeral object and does not require the supporting device to persist it. It runs as an action until stopped with the corresponding abort action below.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

lm - The parameters of the Loss Measurement

Returns:

The id of the newly created LM if available

Throws:

CfmConfigException - When the command cannot be completed

SoamConfigException - When the command cannot be completed

abortLm

void abortLm(MdId mdName,
             MaIdShort maName,
             MepId mepId)
      throws CfmConfigException

Stop all Loss Measurements on a particular MEP. This stops the Loss Measurement activity started through the createLm action above. It is up to the individual device how to implement it. It does not necessarily mean delete the LM.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Throws:

CfmConfigException - When the command cannot be completed

abortLm

void abortLm(MdId mdName,
             MaIdShort maName,
             MepId mepId,
             SoamId lmId)
      throws CfmConfigException

Stop a particular named Loss Measurement on a particular MEP. This stops the Loss Measurement activity started through the createLm action above. It is up to the individual device how to implement it. It does not necessarily mean delete the LM.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

lmId - The id of the LM

Throws:

CfmConfigException - When the command cannot be completed

clearLossHistoryStats

void clearLossHistoryStats(MdId mdName,
                           MaIdShort maName,
                           MepId mepId)
                    throws CfmConfigException

Clear the history stats on all Loss Measurements on a particular MEP. This removes any historical stats stored on a device for one MEP It does NOT require that the Loss Measurement test is aborted.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Throws:

CfmConfigException - When the command cannot be completed

clearLossHistoryStats

void clearLossHistoryStats(MdId mdName,
                           MaIdShort maName,
                           MepId mepId,
                           SoamId lmId)
                    throws CfmConfigException

Clear the history stats on a named Loss Measurement on a particular MEP. This removes any historical stats stored on a device for one LM on one MEP It does NOT require that the Loss Measurement test is aborted.

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

lmId - The id of the LM

Throws:

CfmConfigException - When the command cannot be completed

createTestSignal

void createTestSignal(MdId mdName,
                      MaIdShort maName,
                      MepId mepId,
                      MepTsCreate tsCreate)
               throws CfmConfigException

Create a Test Signal operation on a particular MEP. MEF39 defines the Test Signal as an ephemeral operation that is not required to be persisted by a device. Only one Test Signal is active on a MEP at a time

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

tsCreate - The parameters the Test Signal is created with

Throws:

CfmConfigException - When the command cannot be completed

abortTestSignal

void abortTestSignal(MdId mdName,
                     MaIdShort maName,
                     MepId mepId)
              throws CfmConfigException

Abort a Test Signal operation on a particular MEP. Abort a Test Signal operation on a Mep

Parameters:

mdName - The Maintenance Domain of the MEP

maName - The Maintenance Association of the MEP

mepId - The id of the MEP itself

Throws:

CfmConfigException - When the command cannot be completed