alma.acs.alarmsystem.source

Class AlarmSourceImpl

java.lang.Object

alma.acs.alarmsystem.source.AlarmSourceImpl

All Implemented Interfaces:

AlarmSource

public class AlarmSourceImpl
extends java.lang.Object
implements AlarmSource

The implementation of AlarmSource.

Flushing of queued alarms is done by a thread to avoid blocking the caller if there are too many queued alarms. There is possible critical race if the user executes a sequence of queueAlarms()/flushAlarms(), it happens if the queueAlarms() is called when the thread has not yet finished flushing the alarms. This is avoided by copying the alarms in queue in a temporary immutable vector.

Instances of AlarmSource objects should be get with ContainerServices#getAlarmSource().

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALARM_OSCILLATION_TIME To limit the effect of oscillations, publishing of inactive alarms is delayed by ALARM_OSCILLATION_TIME (in seconds)

Constructor Summary

Constructors

Constructor and Description
AlarmSourceImpl(ContainerServicesBase containerServices) Constructor

Method Summary

Modifier and Type	Method and Description
void	clearAlarm(java.lang.String faultFamily, java.lang.String faultMember, int faultCode) The alarm to clear is not sent directly to the alarm service.
void	disableAlarms() Disable the sending of alarms.
void	enableAlarms() Enable the sending of alarms.
void	flushAlarms() Flush the alarms queued and stop queuing.
void	queueAlarms() Start queuing the alarms.
void	queueAlarms(long delayTime, java.util.concurrent.TimeUnit unit) Start queuing the alarms.
void	raiseAlarm(java.lang.String faultFamily, java.lang.String faultMember, int faultCode) Raise an alarm with the given triplet.
void	raiseAlarm(java.lang.String faultFamily, java.lang.String faultMember, int faultCode, java.util.Properties properties) Raise an alarm with the given triplet and a set of properties.
void	setAlarm(java.lang.String faultFamily, java.lang.String faultMember, int faultCode, boolean active) Send the alarm with the passed triplet to the alarm service.
void	setAlarm(java.lang.String faultFamily, java.lang.String faultMember, int faultCode, java.util.Properties alarmProps, boolean active) Send the alarm with the passed triplet and properties to the alarm service.
void	start() Start the threads.
void	tearDown() Life-cycle: tearDown must be called when terminated using this class
void	terminateAllAlarms() Terminate all the active alarms.

Methods inherited from class java.lang.Object

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

Field Detail

ALARM_OSCILLATION_TIME

public static final int ALARM_OSCILLATION_TIME

To limit the effect of oscillations, publishing of inactive alarms is delayed by ALARM_OSCILLATION_TIME (in seconds)

If during this time interval the alarm is activated again then its temporary deactivation will be skipped.

Visibility is public for testing purposes.

See Also:

Constant Field Values

Constructor Detail

AlarmSourceImpl

public AlarmSourceImpl(ContainerServicesBase containerServices)

Constructor

Parameters:

containerServices - The container services

Method Detail

raiseAlarm

public void raiseAlarm(java.lang.String faultFamily,
                       java.lang.String faultMember,
                       int faultCode)

Description copied from interface: AlarmSource

Raise an alarm with the given triplet.

If the alarm is already active, it is not sent again to the alarm service.

Specified by:

raiseAlarm in interface AlarmSource

Parameters:

faultFamily - The FaultFamily

faultMember - The FaultMember

faultCode - The FaultCode

raiseAlarm

public void raiseAlarm(java.lang.String faultFamily,
                       java.lang.String faultMember,
                       int faultCode,
                       java.util.Properties properties)

Description copied from interface: AlarmSource

Raise an alarm with the given triplet and a set of properties.

If the alarm is already active, it is not sent again to the alarm service.

Specified by:

raiseAlarm in interface AlarmSource

Parameters:

faultFamily - The FaultFamily

faultMember - The FaultMember

faultCode - The FaultCode

properties - The user properties. It can be null or empty.

clearAlarm

public void clearAlarm(java.lang.String faultFamily,
                       java.lang.String faultMember,
                       int faultCode)

The alarm to clear is not sent directly to the alarm service. It is instead queued in alarmsToClean and will be cleared by the oscillation loop.

Specified by:

clearAlarm in interface AlarmSource

Parameters:

faultFamily - The FaultFamily

faultMember - The FaultMember

faultCode - The FaultCode

setAlarm

public void setAlarm(java.lang.String faultFamily,
                     java.lang.String faultMember,
                     int faultCode,
                     java.util.Properties alarmProps,
                     boolean active)

Description copied from interface: AlarmSource

Send the alarm with the passed triplet and properties to the alarm service. The state activate/terminate of the alarm depends on the passed boolean.

This method is the most complete way to send an alarm.

If the alarm is already active, it is not sent again to the alarm service. If the alarm is already terminated, it is not sent again to the alarm service.

Specified by:

setAlarm in interface AlarmSource

Parameters:

faultFamily - The FaultFamily

faultMember - The FaultMember

faultCode - The FaultCode

alarmProps - The user properties. It can be null or empty.

active - if true the alarm is activated otherwise it is terminated.

setAlarm

public void setAlarm(java.lang.String faultFamily,
                     java.lang.String faultMember,
                     int faultCode,
                     boolean active)

Description copied from interface: AlarmSource

Send the alarm with the passed triplet to the alarm service. The state activate/terminate of the alarm depends on the passed boolean.

This method is the most complete way to send an alarm.

If the alarm is already active, it is not sent again to the alarm service. If the alarm is already terminated, it is not sent again to the alarm service.

Specified by:

setAlarm in interface AlarmSource

Parameters:

faultFamily - The FaultFamily

faultMember - The FaultMember

faultCode - The FaultCode

active - if true the alarm is activated otherwise it is terminated.

terminateAllAlarms

public void terminateAllAlarms()

Description copied from interface: AlarmSource

Terminate all the active alarms.

Specified by:

terminateAllAlarms in interface AlarmSource

queueAlarms

public void queueAlarms(long delayTime,
                        java.util.concurrent.TimeUnit unit)

Description copied from interface: AlarmSource

Start queuing the alarms.

The alarms are flushed when the passed time expires or flush gets called.

The purpose of the queuing is to avoid alarms flickering for example during the initialization phase of a device where spurious states could trigger the event of false alarms

Specified by:

queueAlarms in interface AlarmSource

Parameters:

delayTime - The time to queue alarms

unit - The unit of the delay

queueAlarms

public void queueAlarms()

Description copied from interface: AlarmSource

Start queuing the alarms.

The alarms are queued until flushAlarms() is executed.

The purpose of the queuing is to avoid alarms flickering for example during the initialization phase of a device where spurious states could trigger the event of false alarms.

Specified by:

queueAlarms in interface AlarmSource

See Also:

AlarmSource.flushAlarms()

flushAlarms

public void flushAlarms()

Flush the alarms queued and stop queuing.

This method gets called both directly for flushing alarms immediately, and also delayed (new thread from queueAlarms(long, TimeUnit)).

Implementation note: this method is synchronized and calls setAlarm(String, String, int, Properties, boolean) asynchronously in order to not block access to this class for too long.

Specified by:

flushAlarms in interface AlarmSource

See Also:

AlarmSource.flushAlarms()

disableAlarms

public void disableAlarms()

Description copied from interface: AlarmSource

Disable the sending of alarms.

When the alarms are disabled, all the alarms submitted with raise, clear and set are discarded. This means that those alarms are immediately discarded. They are not queued, and will never arrive at the alarm service.

Specified by:

disableAlarms in interface AlarmSource

See Also:

AlarmSource.enableAlarms()

enableAlarms

public void enableAlarms()

Description copied from interface: AlarmSource

Enable the sending of alarms.

Better just "This method reverts the effect of a previous call to disableAlarms(), so that alarms will get processed again.

Alarms are enabled by default.

Specified by:

enableAlarms in interface AlarmSource

See Also:

AlarmSource.disableAlarms()

start

public void start()

Start the threads.

Specified by:

start in interface AlarmSource

See Also:

tearDown()

tearDown

public void tearDown()

Description copied from interface: AlarmSource

Life-cycle: tearDown must be called when terminated using this class

Specified by:

tearDown in interface AlarmSource