Mep (ONOS Java API (1.12.0))

All Superinterfaces:

NetworkResource

All Known Subinterfaces:

MepEntry

All Known Implementing Classes:

DefaultMep, DefaultMepEntry
```
public interface Mep
extends NetworkResource
```
A model of the Maintenance Association Endpoint. See IEE 802.1Q Section 12.14.7.1.3 for reference

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Mep.FaultDefectType` Supported Fault Defect Types.
`static class`	`Mep.FngAddress` A simple class to join an FngAddressType and an IpAddress.
`static class`	`Mep.FngAddressType` Supported FNG Address Types.
`static class`	`Mep.LowestFaultDefect` Options for setting the lowest fault defect.
`static interface`	`Mep.MepBuilder` Builder for `Mep`.
`static class`	`Mep.MepDirection` Enumerated options for MEP Directions.
`static class`	`Mep.Priority` An enumerated set of values to represent Priority.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`administrativeState()` Get the administrative state of the MEP.
`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.
`Mep.FngAddress`	`fngAddress()` Get the network address to which Fault Alarms are to be transmitted.
`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.
`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 address)` 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.

- Method Detail
  - mepId
```
MepId mepId()
```
    Get the ID of the MEP.
    
    Returns:
    
    The MEPID is an integer in the range 1–8191
  - deviceId
```
DeviceId deviceId()
```
    Get the Device ID which the MEP is realized on.
    
    Returns:
    
    The DeviceID to which this Mep is associated
  - port
```
PortNumber port()
```
    Get the port to which the MEP is attached.
    
    Returns:
    
    An port to which the MEP is attached
  - direction
```
Mep.MepDirection direction()
```
    Get the MEP direction.
    
    Returns:
    
    A value indicating the direction in which the MEP faces on the interface
  - mdId
```
MdId mdId()
```
    Get the Maintenance Domain reference.
    
    Returns:
    
    The name of the containing Maintenance Domain
  - maId
```
MaIdShort maId()
```
    Get the Maintenance Association reference.
    
    Returns:
    
    The name of the containing Maintenance Association
  - primaryVid
```
VlanId primaryVid()
```
    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.
    
    Returns:
    
    An integer in the range 0-4094
  - withPrimaryVid
```
Mep withPrimaryVid(VlanId primaryVid)
```
    Set the Primary VID of the MEP.
    
    Parameters:
    
    primaryVid - An integer between 0 and 4094
    
    Returns:
    
    A new MEP with this value set
  - administrativeState
```
boolean administrativeState()
```
    Get the administrative state of the MEP.
    
    Returns:
    
    The administrative state of the MEP
  - withAdministrativeState
```
Mep withAdministrativeState(boolean adminState)
```
    Set the administrative state of the MEP.
    
    Parameters:
    
    adminState - The administrative state of the MEP
    
    Returns:
    
    A new MEP with this value set
  - cciEnabled
```
java.lang.Boolean cciEnabled()
```
    Get whether the MEP is or is not to generate CCMs. CCMs are Continuity Check Messages
    
    Returns:
    
    boolean value indicating whether the MEP is or is not to generate CCMs
  - withCciEnabled
```
Mep withCciEnabled(boolean cciEnabled)
```
    Enable or disable the generation of CCMs by the MEP.
    
    Parameters:
    
    cciEnabled - boolean value dictating whether CCMs are sent or not
    
    Returns:
    
    A new MEP with this value set
  - ccmLtmPriority
```
Mep.Priority ccmLtmPriority()
```
    Get the priority parameter for CCMs and LTMs transmitted by the MEP.
    
    Returns:
    
    The priority parameter for CCMs and LTMs transmitted by the MEP
  - withCcmLtmPriority
```
Mep withCcmLtmPriority(Mep.Priority priority)
```
    Set the priority parameter for CCMs and LTMs transmitted by the MEP.
    
    Parameters:
    
    priority - An integer value between 0 and 7 inclusive
    
    Returns:
    
    A new MEP with this value set
  - fngAddress
```
Mep.FngAddress fngAddress()
```
    Get the network address to which Fault Alarms are to be transmitted.
    
    Returns:
    
    The IP address to which Fault Alarms are to be transmitted
  - withFngAddress
```
Mep withFngAddress(Mep.FngAddress address)
```
    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
    
    Parameters:
    
    address - Address type or indicator that address is not specified or alarms are not to be transmitted
    
    Returns:
    
    A new MEP with this value set
  - lowestFaultPriorityDefect
```
Mep.LowestFaultDefect lowestFaultPriorityDefect()
```
    Get the lowest priority defect that is allowed to generate a Fault Alarm.
    
    Returns:
    
    The lowest priority defect that is allowed to generate a Fault Alarm
  - withLowestFaultPriorityDefect
```
Mep withLowestFaultPriorityDefect(Mep.LowestFaultDefect lowestFdType)
```
    Set the lowest priority defect that is allowed to generate a Fault Alarm.
    
    Parameters:
    
    lowestFdType - The lowest priority defect that is allowed to generate a Fault Alarm
    
    Returns:
    
    A new MEP with this value set
  - defectPresentTime
```
java.time.Duration defectPresentTime()
```
    Get the time that the Fault must be present before it is issued.
    
    Returns:
    
    The time that the Fault must be present before it is issued
  - withDefectPresentTime
```
Mep withDefectPresentTime(java.time.Duration duration)
```
    Set the time that the Fault must be present before it is issued. The default is 2500ms (2.5 seconds) if not specified
    
    Parameters:
    
    duration - The time that the Fault must be present before it is issued
    
    Returns:
    
    A new MEP with this value set
  - defectAbsentTime
```
java.time.Duration defectAbsentTime()
```
    Get the time that the Fault must be absent before it is reset.
    
    Returns:
    
    The time that the Fault must be absent before it is reset
  - withDefectAbsentTime
```
Mep withDefectAbsentTime(java.time.Duration duration)
```
    Set the time that the Fault must be absent before it is reset. The default is 10000ms (10 seconds) if not specified
    
    Parameters:
    
    duration - The time that the Fault must be absent before it is reset
    
    Returns:
    
    A new MEP with this value set

Interface Mep

Nested Class Summary

Method Summary

Method Detail

mepId

deviceId

port

direction

mdId

maId

primaryVid

withPrimaryVid

administrativeState

withAdministrativeState

cciEnabled

withCciEnabled

ccmLtmPriority

withCcmLtmPriority

fngAddress

withFngAddress

lowestFaultPriorityDefect

withLowestFaultPriorityDefect

defectPresentTime

withDefectPresentTime

defectAbsentTime

withDefectAbsentTime