org.onosproject.faultmanagement.api

Interface AlarmStore

All Superinterfaces:

org.onosproject.store.Store<org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent,AlarmStoreDelegate>

All Known Implementing Classes:

DistributedAlarmStore

public interface AlarmStore
extends org.onosproject.store.Store<org.onosproject.incubator.net.faultmanagement.alarm.AlarmEvent,AlarmStoreDelegate>

Manages inventory of alarms; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
org.onosproject.incubator.net.faultmanagement.alarm.Alarm	getAlarm(org.onosproject.incubator.net.faultmanagement.alarm.AlarmId alarmId) Retrieves and alarm based on it's id.
Collection<org.onosproject.incubator.net.faultmanagement.alarm.Alarm>	getAlarms() Retrieves all alarms present in the system.
Collection<org.onosproject.incubator.net.faultmanagement.alarm.Alarm>	getAlarms(org.onosproject.net.DeviceId deviceId) Retrieves alarms for a device.
void	removeAlarm(org.onosproject.incubator.net.faultmanagement.alarm.AlarmId alarmId) Removes an alarm.
void	setAlarm(org.onosproject.incubator.net.faultmanagement.alarm.Alarm alarm) Stores an alarm.

Methods inherited from interface org.onosproject.store.Store

hasDelegate, setDelegate, unsetDelegate

Method Detail

getAlarm

org.onosproject.incubator.net.faultmanagement.alarm.Alarm getAlarm(org.onosproject.incubator.net.faultmanagement.alarm.AlarmId alarmId)

Retrieves and alarm based on it's id.

Parameters:

alarmId - alarm identifier

Returns:

alarm

getAlarms

Collection<org.onosproject.incubator.net.faultmanagement.alarm.Alarm> getAlarms()

Retrieves all alarms present in the system.

Returns:

alarms

getAlarms

Collection<org.onosproject.incubator.net.faultmanagement.alarm.Alarm> getAlarms(org.onosproject.net.DeviceId deviceId)

Retrieves alarms for a device.

Parameters:

deviceId - device identifier

Returns:

alarms

setAlarm

void setAlarm(org.onosproject.incubator.net.faultmanagement.alarm.Alarm alarm)

Stores an alarm.

Parameters:

alarm - alarm

removeAlarm

void removeAlarm(org.onosproject.incubator.net.faultmanagement.alarm.AlarmId alarmId)

Removes an alarm.

Parameters:

alarmId - alarm