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

Interface CfmMdService

public interface CfmMdService

For the management of Maintenance Domains and Maintenance Associations.

Method Summary

Modifier and Type	Method and Description
boolean	createMaintenanceAssociation(MdId mdName, MaintenanceAssociation ma) Create or replace a Maintenance Domain of a specific Maintenance Domain.
boolean	createMaintenanceDomain(MaintenanceDomain md) Create or replace a Maintenance Domain.
boolean	deleteMaintenanceAssociation(MdId mdName, MaIdShort maName) Delete a specific Maintenance Association of a specific Maintenance Domain.
boolean	deleteMaintenanceDomain(MdId mdName) Delete a specific Maintenance Domain by its identifier.
java.util.Collection<MaintenanceAssociation>	getAllMaintenanceAssociation(MdId mdName) Get all of the Maintenance Associations for a Maintenance Domain.
java.util.Collection<MaintenanceDomain>	getAllMaintenanceDomain() Get a list of all of the Maintenance Domains on the system.
java.util.Optional<MaintenanceAssociation>	getMaintenanceAssociation(MdId mdName, MaIdShort maName) Get a specific Maintenance Association of a specific Maintenance Domain.
java.util.Optional<MaintenanceDomain>	getMaintenanceDomain(MdId mdName) Get a specific Maintenance Domain by its identifier.

Method Detail

getAllMaintenanceDomain

java.util.Collection<MaintenanceDomain> getAllMaintenanceDomain()

Get a list of all of the Maintenance Domains on the system.

Returns:

A collection Maintenance domains from the Distributed MD Store.

getMaintenanceDomain

java.util.Optional<MaintenanceDomain> getMaintenanceDomain(MdId mdName)

Get a specific Maintenance Domain by its identifier.

Parameters:

mdName - An identifier for the Maintenance Domain

Returns:

A Maintenance Domain from the Distributed MD Store. Empty if not found.

deleteMaintenanceDomain

boolean deleteMaintenanceDomain(MdId mdName)
                         throws CfmConfigException

Delete a specific Maintenance Domain by its identifier.

Parameters:

mdName - An identifier for the Maintenance Domain to be deleted

Returns:

True if the MD was found and deleted

Throws:

CfmConfigException - If there were any Meps dependent on the MD or its MAs

createMaintenanceDomain

boolean createMaintenanceDomain(MaintenanceDomain md)
                         throws CfmConfigException

Create or replace a Maintenance Domain.

Parameters:

md - The Maintenance Domain to create or replace

Returns:

true if an MD of this name already existed

Throws:

CfmConfigException - If it is a replacement and there were any Meps dependent on the MD or its MAs

getAllMaintenanceAssociation

java.util.Collection<MaintenanceAssociation> getAllMaintenanceAssociation(MdId mdName)

Get all of the Maintenance Associations for a Maintenance Domain.

Parameters:

mdName - The identifier of the Maintenance Domain

Returns:

A collection of Maintenance Associations

getMaintenanceAssociation

java.util.Optional<MaintenanceAssociation> getMaintenanceAssociation(MdId mdName,
                                                                     MaIdShort maName)

Get a specific Maintenance Association of a specific Maintenance Domain.

Parameters:

mdName - The identifier of the Maintenance Domain

maName - The identifier of the Maintenance Association

Returns:

A Maintenance Association from the Distributed MD Store. Empty if not found.

Throws:

java.lang.IllegalArgumentException - if MD is not found

deleteMaintenanceAssociation

boolean deleteMaintenanceAssociation(MdId mdName,
                                     MaIdShort maName)
                              throws CfmConfigException

Delete a specific Maintenance Association of a specific Maintenance Domain.

Parameters:

mdName - The identifier of the Maintenance Domain

maName - The identifier of the Maintenance Association

Returns:

true if deleted

Throws:

CfmConfigException - If there were any Meps dependent on the MD or its MAs

java.lang.IllegalArgumentException - if MD is not found

createMaintenanceAssociation

boolean createMaintenanceAssociation(MdId mdName,
                                     MaintenanceAssociation ma)
                              throws CfmConfigException

Create or replace a Maintenance Domain of a specific Maintenance Domain.

Parameters:

mdName - The identifier of the Maintenance Domain

ma - A Maintenance Association

Returns:

true if an MA of this name already existed in the MD

Throws:

CfmConfigException - If it is a replacement and there were any Meps dependent on the MD or its MAs

java.lang.IllegalArgumentException - if MD is not found