alma.acs.alarmsystem.source

Class AlarmSender

java.lang.Object

alma.acs.alarmsystem.source.AlarmSender

public class AlarmSender
extends java.lang.Object

A support class for sending alarms.

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
AlarmSender(ContainerServicesBase containerServices) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Closes the alarm sending and frees the resources.
void	sendAlarm(java.lang.String FF, java.lang.String FM, int FC, boolean active) Send an alarm with no user properties
void	sendAlarm(java.lang.String FF, java.lang.String FM, int FC, java.util.Properties properties, boolean active) Send an alarm with user properties

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmSender

public AlarmSender(ContainerServicesBase containerServices)

Constructor

Parameters:

containerServices - The ContainerServicesBase

Method Detail

sendAlarm

public void sendAlarm(java.lang.String FF,
                      java.lang.String FM,
                      int FC,
                      java.util.Properties properties,
                      boolean active)

Send an alarm with user properties

Parameters:

FF - The fault family

FM - The fault member

FC - The fault code

properties - The properties (can be null or empty)

active - If true the alarm is activated otherwise it is terminated

sendAlarm

public void sendAlarm(java.lang.String FF,
                      java.lang.String FM,
                      int FC,
                      boolean active)

Send an alarm with no user properties

Parameters:

FF - The fault family

FM - The fault member

FC - The fault code

active - If true the alarm is activated otherwise it is terminated

See Also:

sendAlarm(String, String, int, Properties, boolean)

close

public void close()

Closes the alarm sending and frees the resources.

This is the last method to be executed: after it is not possible to send alarms anymore.