Package org.yamcs.http.api

Class AlarmsApi

java.lang.Object

org.yamcs.protobuf.alarms.AbstractAlarmsApi<Context>

org.yamcs.http.api.AlarmsApi

All Implemented Interfaces:

Api<Context>

public class AlarmsApi
extends AbstractAlarmsApi<Context>

Field Summary

Fields

Modifier and Type	Field	Description
static Map<AlarmNotificationType,AlarmNotificationType>	protoNotificationType

Constructor Summary

Constructors

Constructor	Description
AlarmsApi(AuditLog auditLog)

Method Summary

Modifier and Type	Method	Description
void	acknowledgeAlarm(Context ctx, AcknowledgeAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Acknowledge an alarm
void	clearAlarm(Context ctx, ClearAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Clear an alarm
void	editAlarm(Context ctx, EditAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Update an alarm
static Yamcs.NamedObjectId	getAlarmId(Db.Event ev)
static AlarmSeverity	getEventAlarmSeverity(Event.EventSeverity evSeverity)
static AlarmSeverity	getParameterAlarmSeverity(Pvalue.MonitoringResult mr)
void	listAlarms(Context ctx, ListAlarmsRequest request, Observer<ListAlarmsResponse> observer)	List alarms
void	listProcessorAlarms(Context ctx, ListProcessorAlarmsRequest request, Observer<ListProcessorAlarmsResponse> observer)	List alarms
void	shelveAlarm(Context ctx, ShelveAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Shelve an alarm
void	subscribeAlarms(Context ctx, SubscribeAlarmsRequest request, Observer<AlarmData> observer)	Receive alarm updates
void	subscribeGlobalStatus(Context ctx, SubscribeGlobalStatusRequest request, Observer<GlobalAlarmStatus> observer)	Receive alarm status updates
static final <T> AlarmData	toAlarmData(AlarmNotificationType notificationType, ActiveAlarm<T> activeAlarm, boolean detail)
void	unshelveAlarm(Context ctx, UnshelveAlarmRequest request, Observer<com.google.protobuf.Empty> observer)	Unshelve an alarm
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,AlarmNotificationType> protoNotificationType

Constructor Details

AlarmsApi

public AlarmsApi(AuditLog auditLog)

Method Details

listAlarms

public void listAlarms(Context ctx,
 ListAlarmsRequest request,
 Observer<ListAlarmsResponse> observer)

Description copied from class: AbstractAlarmsApi

  List alarms
 

Specified by:

listAlarms in class AbstractAlarmsApi<Context>

listProcessorAlarms

public void listProcessorAlarms(Context ctx,
 ListProcessorAlarmsRequest request,
 Observer<ListProcessorAlarmsResponse> observer)

Description copied from class: AbstractAlarmsApi

  List alarms
 

Specified by:

listProcessorAlarms in class AbstractAlarmsApi<Context>

editAlarm

public void editAlarm(Context ctx,
 EditAlarmRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractAlarmsApi

  Update an alarm
 

Specified by:

editAlarm in class AbstractAlarmsApi<Context>

acknowledgeAlarm

public void acknowledgeAlarm(Context ctx,
 AcknowledgeAlarmRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractAlarmsApi

  Acknowledge an alarm
 

Specified by:

acknowledgeAlarm in class AbstractAlarmsApi<Context>

shelveAlarm

public void shelveAlarm(Context ctx,
 ShelveAlarmRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractAlarmsApi

  Shelve an alarm
 

Specified by:

shelveAlarm in class AbstractAlarmsApi<Context>

unshelveAlarm

public void unshelveAlarm(Context ctx,
 UnshelveAlarmRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractAlarmsApi

  Unshelve an alarm
 

Specified by:

unshelveAlarm in class AbstractAlarmsApi<Context>

clearAlarm

public void clearAlarm(Context ctx,
 ClearAlarmRequest request,
 Observer<com.google.protobuf.Empty> observer)

Description copied from class: AbstractAlarmsApi

  Clear an alarm
 

Specified by:

clearAlarm in class AbstractAlarmsApi<Context>

subscribeAlarms

public void subscribeAlarms(Context ctx,
 SubscribeAlarmsRequest request,
 Observer<AlarmData> observer)

Description copied from class: AbstractAlarmsApi

  Receive alarm updates
 

Specified by:

subscribeAlarms in class AbstractAlarmsApi<Context>

subscribeGlobalStatus

public void subscribeGlobalStatus(Context ctx,
 SubscribeGlobalStatusRequest request,
 Observer<GlobalAlarmStatus> observer)

Description copied from class: AbstractAlarmsApi

  Receive alarm status updates
 

Specified by:

subscribeGlobalStatus in class 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> AlarmData toAlarmData(AlarmNotificationType notificationType,
 ActiveAlarm<T> activeAlarm,
 boolean detail)

getParameterAlarmSeverity

public static AlarmSeverity getParameterAlarmSeverity(Pvalue.MonitoringResult mr)

getEventAlarmSeverity

public static AlarmSeverity getEventAlarmSeverity(Event.EventSeverity evSeverity)

getAlarmId

public static Yamcs.NamedObjectId getAlarmId(Db.Event ev)