applications/southbound-cli/src/main/java/org/opendaylight/openflowplugin/applications/southboundcli/alarm/NodeReconciliationAlarmMBean.java

   1 /*
   2  * Copyright (c) 2018 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
   3  *
   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
   7  */
   8
   9 package org.opendaylight.openflowplugin.applications.southboundcli.alarm;
  10
  11 import java.util.List;
  12
  13 /**
  14  * NodeReconciliationAlarmMBean is the generic interface for
  15  * providing alarm services by maintaning the alarm object.
  16  */
  17 public interface NodeReconciliationAlarmMBean {
  18
  19     /**
  20      * This method is called to set the list of raiseAlarmObjets.
  21      * This includes the alarm objects which are to be raised
  22      *
  23      * @param raiseAlarmObject holds the list of alarm objects
  24      */
  25     void setRaiseAlarmObject(List<String> raiseAlarmObject);
  26
  27     /**
  28      * This method is called to retrieve the list of alarm objects which are to be raised.
  29      *
  30      * @return List of string containing the alarm objects
  31      */
  32     List<String> getRaiseAlarmObject();
  33
  34     /**
  35      * This method is called to set the list of alarm objects to be cleared.
  36      *
  37      * @param clearAlarmObject maintains the list of clearable alarm objects
  38      */
  39     void setClearAlarmObject(List<String> clearAlarmObject);
  40
  41     /**
  42      * This method is called to retrieve the list of the alarm objects to be cleared.
  43      *
  44      * @return List of clearable alarm objects
  45      */
  46     List<String> getClearAlarmObject();
  47
  48     /**
  49      * This method is called to raise the alarm with the specified alarm name.
  50      *
  51      * @param alarmName name of the alarm to be raised
  52      * @param additionalText description of alarm event
  53      * @param source source of alarm
  54      */
  55     void raiseAlarm(String alarmName, String additionalText, String source);
  56
  57     /**
  58      * This method is called to clear the raised alarm with the specified alarm name.
  59      *
  60      * @param alarmName name of the alarm to be cleared
  61      * @param additionalText description of alarm event
  62      * @param source source of alarm
  63      */
  64     void clearAlarm(String alarmName, String additionalText, String source);
  65 }