org.onosproject.incubator.net.l2monitoring.soam

Class DefaultMeasurementCreateBase

java.lang.Object

org.onosproject.incubator.net.l2monitoring.soam.DefaultMeasurementCreateBase

All Implemented Interfaces:

MeasurementCreateBase

Direct Known Subclasses:

DefaultDelayMeasurementCreate, DefaultLmCreate

public abstract class DefaultMeasurementCreateBase
extends java.lang.Object
implements MeasurementCreateBase

Abstract implementation of MeasurementCreateBase.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DefaultMeasurementCreateBase.DefaultMeasCreateBaseBuilder Abstract Builder class for building.

Nested classes/interfaces inherited from interface org.onosproject.incubator.net.l2monitoring.soam.MeasurementCreateBase

MeasurementCreateBase.MeasCreateBaseBuilder, MeasurementCreateBase.SessionType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alignMeasurementIntervals
protected java.time.Duration	alignMeasurementOffset
protected DelayMeasurementCreate.DataPattern	dataPattern
protected java.lang.Short	frameSize
protected java.time.Duration	measurementInterval
protected java.time.Duration	messagePeriod
protected java.lang.Short	numberIntervalsStored
protected Mep.Priority	priority
protected MepId	remoteMepId
protected MeasurementCreateBase.SessionType	sessionType
protected StartTime	startTime
protected StopTime	stopTime
protected boolean	testTlvIncluded
protected DelayMeasurementCreate.TestTlvPattern	testTlvPattern
protected DelayMeasurementCreate.Version	version

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultMeasurementCreateBase(DefaultMeasurementCreateBase.DefaultMeasCreateBaseBuilder builder)

Method Summary

Modifier and Type	Method and Description
boolean	alignMeasurementIntervals() Whether the measurement intervals for the Loss Measurement session are aligned with a zero offset to real time.
java.time.Duration	alignMeasurementOffset() The offset in minutes from the time of day value.
DelayMeasurementCreate.DataPattern	dataPattern() The LM data pattern included in a Data TLV.
java.lang.Short	frameSize() The Loss Measurement frame size between 64 bytes and the maximum transmission unit of the EVC.
java.time.Duration	measurementInterval() The Measurement Interval for FLR statistics.
java.time.Duration	messagePeriod() The interval between Loss or Delay Measurement OAM message transmission.
java.lang.Short	numberIntervalsStored() The number of completed measurement intervals to store in the history statistic table.
Mep.Priority	priority() The priority of frames with Performance Monitoring OAM message information.
MepId	remoteMepId() The remote MEP to perform the tests against.
MeasurementCreateBase.SessionType	sessionType() Indicates whether the current session is defined to be 'proactive' or 'on-demand.
StartTime	startTime() Defines the session start time.
StopTime	stopTime() Defines the session stop time.
boolean	testTlvIncluded() Whether a Test TLV or Data TLV is included when the size of the LM frame is determined by the frame-size object.
DelayMeasurementCreate.TestTlvPattern	testTlvPattern() The type of test pattern to be sent in the LM frame Test TLV.
DelayMeasurementCreate.Version	version() The version of the PDUs used to perform Loss or Delay Measurement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

protected final DelayMeasurementCreate.Version version

remoteMepId

protected final MepId remoteMepId

messagePeriod

protected final java.time.Duration messagePeriod

priority

protected final Mep.Priority priority

frameSize

protected final java.lang.Short frameSize

dataPattern

protected final DelayMeasurementCreate.DataPattern dataPattern

testTlvIncluded

protected final boolean testTlvIncluded

testTlvPattern

protected final DelayMeasurementCreate.TestTlvPattern testTlvPattern

measurementInterval

protected final java.time.Duration measurementInterval

numberIntervalsStored

protected final java.lang.Short numberIntervalsStored

alignMeasurementIntervals

protected final boolean alignMeasurementIntervals

alignMeasurementOffset

protected final java.time.Duration alignMeasurementOffset

sessionType

protected final MeasurementCreateBase.SessionType sessionType

startTime

protected final StartTime startTime

stopTime

protected final StopTime stopTime

Constructor Detail

DefaultMeasurementCreateBase

protected DefaultMeasurementCreateBase(DefaultMeasurementCreateBase.DefaultMeasCreateBaseBuilder builder)

Method Detail

version

public DelayMeasurementCreate.Version version()

Description copied from interface: MeasurementCreateBase

The version of the PDUs used to perform Loss or Delay Measurement. The exact PDUs to use are specified by this object in combination with measurement-type

Specified by:

version in interface MeasurementCreateBase

Returns:

The version of the PDUs

remoteMepId

public MepId remoteMepId()

Description copied from interface: MeasurementCreateBase

The remote MEP to perform the tests against.

Specified by:

remoteMepId in interface MeasurementCreateBase

Returns:

An ID of a MEP

messagePeriod

public java.time.Duration messagePeriod()

Description copied from interface: MeasurementCreateBase

The interval between Loss or Delay Measurement OAM message transmission. For Loss Measurement monitoring applications the default value is 1 sec. This object is not applicable if measurement-type is set to 'ccm' and is ignored for that Loss Measurement Type

Specified by:

messagePeriod in interface MeasurementCreateBase

Returns:

A java Duration

priority

public Mep.Priority priority()

Description copied from interface: MeasurementCreateBase

The priority of frames with Performance Monitoring OAM message information.

Specified by:

priority in interface MeasurementCreateBase

Returns:

A priority enumerated value 0-7

frameSize

public java.lang.Short frameSize()

Description copied from interface: MeasurementCreateBase

The Loss Measurement frame size between 64 bytes and the maximum transmission unit of the EVC. The range of frame sizes from 64 through 2000 octets need to be supported, and the range of frame sizes from 2001 through 9600 octets is suggested be supported. The adjustment to the frame size of the standard frame size is accomplished by the addition of a Data or Test TLV. A Data or Test TLV is only added to the frame if the frame size is greater than 64 bytes

Specified by:

frameSize in interface MeasurementCreateBase

Returns:

frame size in bytes

dataPattern

public DelayMeasurementCreate.DataPattern dataPattern()

Description copied from interface: MeasurementCreateBase

The LM data pattern included in a Data TLV. when the size of the LM frame is determined by the frame-size object and test-tlv-included is 'false'. If the frame size object does not define the LM frame size or test-tlv-included is 'true' the value of this object is ignored

Specified by:

dataPattern in interface MeasurementCreateBase

Returns:

The data pattern - ones or zeroes

testTlvIncluded

public boolean testTlvIncluded()

Description copied from interface: MeasurementCreateBase

Whether a Test TLV or Data TLV is included when the size of the LM frame is determined by the frame-size object. If the frame-size object does not define the LM frame size the value of this object is ignored.

Specified by:

testTlvIncluded in interface MeasurementCreateBase

Returns:

true indicates that the Test TLV is to be included, false indicates it is not

testTlvPattern

public DelayMeasurementCreate.TestTlvPattern testTlvPattern()

Description copied from interface: MeasurementCreateBase

The type of test pattern to be sent in the LM frame Test TLV. when the size of LM PDU is determined by the frame-size object and test-tlv-included is 'true'. If the frame size object does not define the LM frame size or test-tlv-included is 'false' the value of this object is ignored

Specified by:

testTlvPattern in interface MeasurementCreateBase

Returns:

A TLV pattern enum

measurementInterval

public java.time.Duration measurementInterval()

Description copied from interface: MeasurementCreateBase

The Measurement Interval for FLR statistics. A Measurement Interval of 15 minutes needs to be supported, other intervals may be supported.

Specified by:

measurementInterval in interface MeasurementCreateBase

Returns:

A java Duration

numberIntervalsStored

public java.lang.Short numberIntervalsStored()

Description copied from interface: MeasurementCreateBase

The number of completed measurement intervals to store in the history statistic table. At least 32 completed measurement intervals are to be stored. 96 measurement intervals are recommended to be stored

Specified by:

numberIntervalsStored in interface MeasurementCreateBase

Returns:

The number to be stored.

alignMeasurementIntervals

public boolean alignMeasurementIntervals()

Description copied from interface: MeasurementCreateBase

Whether the measurement intervals for the Loss Measurement session are aligned with a zero offset to real time. The value 'true' indicates that each Measurement Interval starts at a time which is aligned to NE time source hour if the interval is a factor of an hour, i.e. 60min/15min = 4. For instance, a measurement time interval of 15 minutes would stop/start the measurement interval at 0, 15, 30, and 45 minutes of an hour. A measurement interval of 7 minutes would not align to the hour since 7 minutes is NOT a factor of an hour, i.e. 60min/7min = 8.6, and the behavior is the same as if the object is set to 'false'. The value 'false' indicates that each Measurement Interval starts at a time which is indicated by repetition-period. One side effect of the usage of this parameter is that if the value is true and the repetition-period is not a factor of an hour then the start of the next Measurement Interval will be delayed until the next factor of an hour.

Specified by:

alignMeasurementIntervals in interface MeasurementCreateBase

Returns:

See above for the meaning of true and false

alignMeasurementOffset

public java.time.Duration alignMeasurementOffset()

Description copied from interface: MeasurementCreateBase

The offset in minutes from the time of day value. if align-measurement-intervals is 'true' and the repetition time is a factor of 60 minutes. If not, the value of this object is ignored. If the Measurement Interval is 15 minutes and align-measurement-intervals is true and if this object was set to 5 minutes, the Measurement Intervals would start at 5, 20, 35, 50 minutes past each hour

Specified by:

alignMeasurementOffset in interface MeasurementCreateBase

Returns:

A java Duration

sessionType

public MeasurementCreateBase.SessionType sessionType()

Description copied from interface: MeasurementCreateBase

Indicates whether the current session is defined to be 'proactive' or 'on-demand.

Specified by:

sessionType in interface MeasurementCreateBase

Returns:

An enumerated value

startTime

public StartTime startTime()

Description copied from interface: MeasurementCreateBase

Defines the session start time.

Specified by:

startTime in interface MeasurementCreateBase

Returns:

An object with the start time type and optionally an instant

stopTime

public StopTime stopTime()

Description copied from interface: MeasurementCreateBase

Defines the session stop time.

Specified by:

stopTime in interface MeasurementCreateBase

Returns:

An object with the stop time type and optionally an instant