Module org.yamcs.core
Package org.yamcs.http.api

Class AlarmsApi

java.lang.Object
org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>
org.yamcs.http.api.AlarmsApi
All Implemented Interfaces:
org.yamcs.api.Api<Context>
public class AlarmsApi extends org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static Map<AlarmNotificationType,org.yamcs.protobuf.AlarmNotificationType>
    protoNotificationType
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AlarmsApi(AuditLog auditLog)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    acknowledgeAlarm(Context ctx, org.yamcs.protobuf.alarms.AcknowledgeAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    void
    clearAlarm(Context ctx, org.yamcs.protobuf.alarms.ClearAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    void
    editAlarm(Context ctx, org.yamcs.protobuf.alarms.EditAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    static org.yamcs.protobuf.Yamcs.NamedObjectId
    getAlarmId(Db.Event ev)
     
    static org.yamcs.protobuf.AlarmSeverity
    getEventAlarmSeverity(org.yamcs.protobuf.Event.EventSeverity evSeverity)
     
    static org.yamcs.protobuf.AlarmSeverity
    getParameterAlarmSeverity(org.yamcs.protobuf.Pvalue.MonitoringResult mr)
     
    void
    listAlarms(Context ctx, org.yamcs.protobuf.alarms.ListAlarmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.alarms.ListAlarmsResponse> observer)
    List the alarms including the old ones not active anymore
    void
    listProcessorAlarms(Context ctx, org.yamcs.protobuf.alarms.ListProcessorAlarmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.alarms.ListProcessorAlarmsResponse> observer)
    List the active alarms
    void
    shelveAlarm(Context ctx, org.yamcs.protobuf.alarms.ShelveAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    void
    subscribeAlarms(Context ctx, org.yamcs.protobuf.alarms.SubscribeAlarmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.AlarmData> observer)
     
    void
    subscribeGlobalStatus(Context ctx, org.yamcs.protobuf.alarms.SubscribeGlobalStatusRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.alarms.GlobalAlarmStatus> observer)
     
    static final <T> org.yamcs.protobuf.AlarmData
    toAlarmData(org.yamcs.protobuf.AlarmNotificationType notificationType, ActiveAlarm<T> activeAlarm, boolean detail)
     
    void
    unshelveAlarm(Context ctx, org.yamcs.protobuf.alarms.UnshelveAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
     
    static ActiveAlarm<?>
    verifyAlarm(Processor processor, String alarmName, int id)
    Finds the appropriate alarm server for the alarm.

    Methods inherited from class org.yamcs.protobuf.alarms.AbstractAlarmsApi

    callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

    Methods inherited from class java.lang.Object

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

  • Field Details

    • protoNotificationType

      public static Map<AlarmNotificationType,org.yamcs.protobuf.AlarmNotificationType> protoNotificationType

  • Constructor Details

    • AlarmsApi

      public AlarmsApi(AuditLog auditLog)

  • Method Details

    • listAlarms

      public void listAlarms(Context ctx, org.yamcs.protobuf.alarms.ListAlarmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.alarms.ListAlarmsResponse> observer)
      List the alarms including the old ones not active anymore
      Specified by:
      listAlarms in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • listProcessorAlarms

      public void listProcessorAlarms(Context ctx, org.yamcs.protobuf.alarms.ListProcessorAlarmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.alarms.ListProcessorAlarmsResponse> observer)
      List the active alarms
      Specified by:
      listProcessorAlarms in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • editAlarm

      public void editAlarm(Context ctx, org.yamcs.protobuf.alarms.EditAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      editAlarm in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • acknowledgeAlarm

      public void acknowledgeAlarm(Context ctx, org.yamcs.protobuf.alarms.AcknowledgeAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      acknowledgeAlarm in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • shelveAlarm

      public void shelveAlarm(Context ctx, org.yamcs.protobuf.alarms.ShelveAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      shelveAlarm in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • unshelveAlarm

      public void unshelveAlarm(Context ctx, org.yamcs.protobuf.alarms.UnshelveAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      unshelveAlarm in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • clearAlarm

      public void clearAlarm(Context ctx, org.yamcs.protobuf.alarms.ClearAlarmRequest request, org.yamcs.api.Observer<com.google.protobuf.Empty> observer)
      Specified by:
      clearAlarm in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • subscribeAlarms

      public void subscribeAlarms(Context ctx, org.yamcs.protobuf.alarms.SubscribeAlarmsRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.AlarmData> observer)
      Specified by:
      subscribeAlarms in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • subscribeGlobalStatus

      public void subscribeGlobalStatus(Context ctx, org.yamcs.protobuf.alarms.SubscribeGlobalStatusRequest request, org.yamcs.api.Observer<org.yamcs.protobuf.alarms.GlobalAlarmStatus> observer)
      Specified by:
      subscribeGlobalStatus in class org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

    • verifyAlarm

      public static ActiveAlarm<?> verifyAlarm(Processor processor, String alarmName, int id) throws HttpException
      Finds the appropriate alarm server for the alarm.

      FIXME why not one namespace and a single server?

      Throws:
      HttpException

    • toAlarmData

      public static final <T> org.yamcs.protobuf.AlarmData toAlarmData(org.yamcs.protobuf.AlarmNotificationType notificationType, ActiveAlarm<T> activeAlarm, boolean detail)

    • getParameterAlarmSeverity

      public static org.yamcs.protobuf.AlarmSeverity getParameterAlarmSeverity(org.yamcs.protobuf.Pvalue.MonitoringResult mr)

    • getEventAlarmSeverity

      public static org.yamcs.protobuf.AlarmSeverity getEventAlarmSeverity(org.yamcs.protobuf.Event.EventSeverity evSeverity)

    • getAlarmId

      public static org.yamcs.protobuf.Yamcs.NamedObjectId getAlarmId(Db.Event ev)