org.onosproject.incubator.net.l2monitoring.cfm.service

Interface CfmMepService

All Known Subinterfaces:

CfmMepProgrammable

public interface CfmMepService

For the management of Maintenance Association Endpoints. These are dependent on the Maintenance Domain service which maintains the Maintenance Domain and Maintenance Associations

Method Summary

Modifier and Type	Method and Description
void	abortLoopback(MdId mdName, MaIdShort maName, MepId mepId) Abort a Loopback session on the named Mep.
boolean	createMep(MdId mdName, MaIdShort maName, Mep mep) Create a named Mep on an MA.
boolean	deleteMep(MdId mdName, MaIdShort maName, MepId mepId) Delete a named Mep belonging to an MA.
java.util.Collection<MepEntry>	getAllMeps(MdId mdName, MaIdShort maName) Retrieve all MepEntry(s) belonging to an MA.
MepEntry	getMep(MdId mdName, MaIdShort maName, MepId mepId) Retrieve a named MepEntry belonging to an MA.
void	transmitLinktrace(MdId mdName, MaIdShort maName, MepId mepId, MepLtCreate ltCreate) Create a Linktrace session on the named Mep.
void	transmitLoopback(MdId mdName, MaIdShort maName, MepId mepId, MepLbCreate lbCreate) Create a Loopback session on the named Mep.

Method Detail

getAllMeps

java.util.Collection<MepEntry> getAllMeps(MdId mdName,
                                          MaIdShort maName)
                                   throws CfmConfigException

Retrieve all MepEntry(s) belonging to an MA.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

Returns:

A collection of MEP Entries

Throws:

CfmConfigException - If there a problem with the MD or MA

getMep

MepEntry getMep(MdId mdName,
                MaIdShort maName,
                MepId mepId)
         throws CfmConfigException

Retrieve a named MepEntry belonging to an MA.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

mepId - A Mep Id

Returns:

A MEP Entry or null if none found

Throws:

CfmConfigException - If there a problem with the MD, MA or MEP

deleteMep

boolean deleteMep(MdId mdName,
                  MaIdShort maName,
                  MepId mepId)
           throws CfmConfigException

Delete a named Mep belonging to an MA.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

mepId - A Mep Id

Returns:

true if the MEP was deleted successfully. false if it was not found

Throws:

CfmConfigException - If there a problem with the MD or MA

createMep

boolean createMep(MdId mdName,
                  MaIdShort maName,
                  Mep mep)
           throws CfmConfigException

Create a named Mep on an MA.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

mep - A Mep object

Returns:

False if it was created successfully. True if the object already exists.

Throws:

CfmConfigException - If there a problem with the MD, MA or MEP

transmitLoopback

void transmitLoopback(MdId mdName,
                      MaIdShort maName,
                      MepId mepId,
                      MepLbCreate lbCreate)
               throws CfmConfigException

Create a Loopback session on the named Mep.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

mepId - A Mep Id

lbCreate - The Loopback session details

Throws:

CfmConfigException - If there a problem with the MD, MA or MEP

abortLoopback

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

Abort a Loopback session on the named Mep.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

mepId - A Mep Id

Throws:

CfmConfigException - If there a problem with the MD, MA or MEP

transmitLinktrace

void transmitLinktrace(MdId mdName,
                       MaIdShort maName,
                       MepId mepId,
                       MepLtCreate ltCreate)
                throws CfmConfigException

Create a Linktrace session on the named Mep.

Parameters:

mdName - A Maintenance Domain

maName - A Maintetance Association in the MD

mepId - A Mep Id

ltCreate - The Linktrace session details

Throws:

CfmConfigException - If there a problem with the MD, MA or MEP