org.onosproject.incubator.net.l2monitoring.cfm

Class DefaultMep

java.lang.Object

org.onosproject.incubator.net.l2monitoring.cfm.DefaultMep

All Implemented Interfaces:

Mep, NetworkResource

Direct Known Subclasses:

DefaultMepEntry

public class DefaultMep
extends java.lang.Object
implements Mep

The default implementation of Mep.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultMep.DefaultMepBuilder Builder for Mep.

Nested classes/interfaces inherited from interface org.onosproject.incubator.net.l2monitoring.cfm.Mep

Mep.FaultDefectType, Mep.FngAddress, Mep.FngAddressType, Mep.LowestFaultDefect, Mep.MepBuilder, Mep.MepDirection, Mep.Priority

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	administrativeState
protected boolean	cciEnabled
protected Mep.Priority	ccmLtmPriority
protected java.time.Duration	defectAbsentTime
protected java.time.Duration	defectPresentTime
protected DeviceId	deviceId
protected Mep.MepDirection	direction
protected Mep.FngAddress	fngAddress
protected Mep.LowestFaultDefect	lowestFaultPriorityDefect
protected MaIdShort	maId
protected MdId	mdId
protected MepId	mepId
protected PortNumber	port
protected VlanId	primaryVid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultMep(DefaultMep.DefaultMepBuilder mepBuilder)
protected	DefaultMep(DefaultMep mep, org.onosproject.incubator.net.l2monitoring.cfm.DefaultMep.AttributeName attrName, java.lang.Object attrValue)

Method Summary

Modifier and Type	Method and Description
boolean	administrativeState() Get the administrative state of the MEP.
static Mep.MepBuilder	builder(MepId mepId, DeviceId deviceId, PortNumber port, Mep.MepDirection direction, MdId mdId, MaIdShort maId)
java.lang.Boolean	cciEnabled() Get whether the MEP is or is not to generate CCMs.
Mep.Priority	ccmLtmPriority() Get the priority parameter for CCMs and LTMs transmitted by the MEP.
java.time.Duration	defectAbsentTime() Get the time that the Fault must be absent before it is reset.
java.time.Duration	defectPresentTime() Get the time that the Fault must be present before it is issued.
DeviceId	deviceId() Get the Device ID which the MEP is realized on.
Mep.MepDirection	direction() Get the MEP direction.
boolean	equals(java.lang.Object o)
Mep.FngAddress	fngAddress() Get the network address to which Fault Alarms are to be transmitted.
int	hashCode()
Mep.LowestFaultDefect	lowestFaultPriorityDefect() Get the lowest priority defect that is allowed to generate a Fault Alarm.
MaIdShort	maId() Get the Maintenance Association reference.
MdId	mdId() Get the Maintenance Domain reference.
MepId	mepId() Get the ID of the MEP.
PortNumber	port() Get the port to which the MEP is attached.
VlanId	primaryVid() Get the Primary VID of the MEP.
java.lang.String	toString()
Mep	withAdministrativeState(boolean adminState) Set the administrative state of the MEP.
Mep	withCciEnabled(boolean cciEnabled) Enable or disable the generation of CCMs by the MEP.
Mep	withCcmLtmPriority(Mep.Priority priority) Set the priority parameter for CCMs and LTMs transmitted by the MEP.
Mep	withDefectAbsentTime(java.time.Duration duration) Set the time that the Fault must be absent before it is reset.
Mep	withDefectPresentTime(java.time.Duration duration) Set the time that the Fault must be present before it is issued.
Mep	withFngAddress(Mep.FngAddress fngAddress) Set the network address to which Fault Alarms are to be transmitted.
Mep	withLowestFaultPriorityDefect(Mep.LowestFaultDefect lowestFdType) Set the lowest priority defect that is allowed to generate a Fault Alarm.
Mep	withPrimaryVid(VlanId primaryVid) Set the Primary VID of the MEP.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

mepId

protected final MepId mepId

deviceId

protected final DeviceId deviceId

port

protected final PortNumber port

direction

protected final Mep.MepDirection direction

mdId

protected final MdId mdId

maId

protected final MaIdShort maId

primaryVid

protected final VlanId primaryVid

administrativeState

protected final boolean administrativeState

cciEnabled

protected final boolean cciEnabled

ccmLtmPriority

protected final Mep.Priority ccmLtmPriority

fngAddress

protected final Mep.FngAddress fngAddress

lowestFaultPriorityDefect

protected final Mep.LowestFaultDefect lowestFaultPriorityDefect

defectPresentTime

protected final java.time.Duration defectPresentTime

defectAbsentTime

protected final java.time.Duration defectAbsentTime

Constructor Detail

DefaultMep

protected DefaultMep(DefaultMep.DefaultMepBuilder mepBuilder)

DefaultMep

protected DefaultMep(DefaultMep mep,
                     org.onosproject.incubator.net.l2monitoring.cfm.DefaultMep.AttributeName attrName,
                     java.lang.Object attrValue)

Method Detail

mepId

public MepId mepId()

Description copied from interface: Mep

Get the ID of the MEP.

Specified by:

mepId in interface Mep

Returns:

The MEPID is an integer in the range 1–8191

deviceId

public DeviceId deviceId()

Description copied from interface: Mep

Get the Device ID which the MEP is realized on.

Specified by:

deviceId in interface Mep

Returns:

The DeviceID to which this Mep is associated

port

public PortNumber port()

Description copied from interface: Mep

Get the port to which the MEP is attached.

Specified by:

port in interface Mep

Returns:

An port to which the MEP is attached

direction

public Mep.MepDirection direction()

Description copied from interface: Mep

Get the MEP direction.

Specified by:

direction in interface Mep

Returns:

A value indicating the direction in which the MEP faces on the interface

mdId

public MdId mdId()

Description copied from interface: Mep

Get the Maintenance Domain reference.

Specified by:

mdId in interface Mep

Returns:

The name of the containing Maintenance Domain

maId

public MaIdShort maId()

Description copied from interface: Mep

Get the Maintenance Association reference.

Specified by:

maId in interface Mep

Returns:

The name of the containing Maintenance Association

primaryVid

public VlanId primaryVid()

Description copied from interface: Mep

Get the Primary VID of the MEP. The value 0 indicates that either the Primary VID is that of the MEP's MA or that the MEP's MA is associated with no VID.

Specified by:

primaryVid in interface Mep

Returns:

An integer in the range 0-4094

withPrimaryVid

public Mep withPrimaryVid(VlanId primaryVid)

Description copied from interface: Mep

Set the Primary VID of the MEP.

Specified by:

withPrimaryVid in interface Mep

Parameters:

primaryVid - An integer between 0 and 4094

Returns:

A new MEP with this value set

administrativeState

public boolean administrativeState()

Description copied from interface: Mep

Get the administrative state of the MEP.

Specified by:

administrativeState in interface Mep

Returns:

The administrative state of the MEP

withAdministrativeState

public Mep withAdministrativeState(boolean adminState)

Description copied from interface: Mep

Set the administrative state of the MEP.

Specified by:

withAdministrativeState in interface Mep

Parameters:

adminState - The administrative state of the MEP

Returns:

A new MEP with this value set

cciEnabled

public java.lang.Boolean cciEnabled()

Description copied from interface: Mep

Get whether the MEP is or is not to generate CCMs. CCMs are Continuity Check Messages

Specified by:

cciEnabled in interface Mep

Returns:

boolean value indicating whether the MEP is or is not to generate CCMs

withCciEnabled

public Mep withCciEnabled(boolean cciEnabled)

Description copied from interface: Mep

Enable or disable the generation of CCMs by the MEP.

Specified by:

withCciEnabled in interface Mep

Parameters:

cciEnabled - boolean value dictating whether CCMs are sent or not

Returns:

A new MEP with this value set

ccmLtmPriority

public Mep.Priority ccmLtmPriority()

Description copied from interface: Mep

Get the priority parameter for CCMs and LTMs transmitted by the MEP.

Specified by:

ccmLtmPriority in interface Mep

Returns:

The priority parameter for CCMs and LTMs transmitted by the MEP

withCcmLtmPriority

public Mep withCcmLtmPriority(Mep.Priority priority)

Description copied from interface: Mep

Set the priority parameter for CCMs and LTMs transmitted by the MEP.

Specified by:

withCcmLtmPriority in interface Mep

Parameters:

priority - An integer value between 0 and 7 inclusive

Returns:

A new MEP with this value set

withFngAddress

public Mep withFngAddress(Mep.FngAddress fngAddress)

Description copied from interface: Mep

Set the network address to which Fault Alarms are to be transmitted. If “not specified,” the address used is that from the Maintenance Association managed object

Specified by:

withFngAddress in interface Mep

Parameters:

fngAddress - Address type or indicator that address is not specified or alarms are not to be transmitted

Returns:

A new MEP with this value set

fngAddress

public Mep.FngAddress fngAddress()

Description copied from interface: Mep

Get the network address to which Fault Alarms are to be transmitted.

Specified by:

fngAddress in interface Mep

Returns:

The IP address to which Fault Alarms are to be transmitted

lowestFaultPriorityDefect

public Mep.LowestFaultDefect lowestFaultPriorityDefect()

Description copied from interface: Mep

Get the lowest priority defect that is allowed to generate a Fault Alarm.

Specified by:

lowestFaultPriorityDefect in interface Mep

Returns:

The lowest priority defect that is allowed to generate a Fault Alarm

withLowestFaultPriorityDefect

public Mep withLowestFaultPriorityDefect(Mep.LowestFaultDefect lowestFdType)

Description copied from interface: Mep

Set the lowest priority defect that is allowed to generate a Fault Alarm.

Specified by:

withLowestFaultPriorityDefect in interface Mep

Parameters:

lowestFdType - The lowest priority defect that is allowed to generate a Fault Alarm

Returns:

A new MEP with this value set

defectPresentTime

public java.time.Duration defectPresentTime()

Description copied from interface: Mep

Get the time that the Fault must be present before it is issued.

Specified by:

defectPresentTime in interface Mep

Returns:

The time that the Fault must be present before it is issued

withDefectPresentTime

public Mep withDefectPresentTime(java.time.Duration duration)

Description copied from interface: Mep

Set the time that the Fault must be present before it is issued. The default is 2500ms (2.5 seconds) if not specified

Specified by:

withDefectPresentTime in interface Mep

Parameters:

duration - The time that the Fault must be present before it is issued

Returns:

A new MEP with this value set

defectAbsentTime

public java.time.Duration defectAbsentTime()

Description copied from interface: Mep

Get the time that the Fault must be absent before it is reset.

Specified by:

defectAbsentTime in interface Mep

Returns:

The time that the Fault must be absent before it is reset

withDefectAbsentTime

public Mep withDefectAbsentTime(java.time.Duration duration)

Description copied from interface: Mep

Set the time that the Fault must be absent before it is reset. The default is 10000ms (10 seconds) if not specified

Specified by:

withDefectAbsentTime in interface Mep

Parameters:

duration - The time that the Fault must be absent before it is reset

Returns:

A new MEP with this value set

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static Mep.MepBuilder builder(MepId mepId,
                                     DeviceId deviceId,
                                     PortNumber port,
                                     Mep.MepDirection direction,
                                     MdId mdId,
                                     MaIdShort maId)
                              throws CfmConfigException

Throws:

CfmConfigException