2 * Copyright (c) 2018 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
9 package org.opendaylight.openflowplugin.applications.southboundcli.alarm;
11 import java.util.List;
14 * NodeReconciliationAlarmMBean is the generic interface for
15 * providing alarm services by maintaning the alarm object.
17 public interface NodeReconciliationAlarmMBean {
20 * This method is called to set the list of raiseAlarmObjets.
21 * This includes the alarm objects which are to be raised
23 * @param raiseAlarmObject holds the list of alarm objects
25 void setRaiseAlarmObject(List<String> raiseAlarmObject);
28 * This method is called to retrieve the list of alarm objects which are to be raised.
30 * @return List of string containing the alarm objects
32 List<String> getRaiseAlarmObject();
35 * This method is called to set the list of alarm objects to be cleared.
37 * @param clearAlarmObject maintains the list of clearable alarm objects
39 void setClearAlarmObject(List<String> clearAlarmObject);
42 * This method is called to retrieve the list of the alarm objects to be cleared.
44 * @return List of clearable alarm objects
46 List<String> getClearAlarmObject();
49 * This method is called to raise the alarm with the specified alarm name.
51 * @param alarmName name of the alarm to be raised
52 * @param additionalText description of alarm event
53 * @param source source of alarm
55 void raiseAlarm(String alarmName, String additionalText, String source);
58 * This method is called to clear the raised alarm with the specified alarm name.
60 * @param alarmName name of the alarm to be cleared
61 * @param additionalText description of alarm event
62 * @param source source of alarm
64 void clearAlarm(String alarmName, String additionalText, String source);