alma.acs.alarm.gui.senderpanel

Class AlarmSender

java.lang.Object

alma.acs.alarm.gui.senderpanel.AlarmSender

All Implemented Interfaces:

java.lang.Runnable

public class AlarmSender
extends java.lang.Object
implements java.lang.Runnable

The class to send alarms to the alarm service.

The sending is done by a dedicated thread to avoid blocking the caller. Alarms are queued and published in a FIFO order. The size of the queue is limited to that is enough for testing purposes of this class. If the queues is full, the caller methods waits until there is enough room in the queue.

AlarmSender objects notify the listener whenever an alarm has been published.

Life cycle:

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
AlarmSender(ContainerServices svcs, java.lang.String name) Constructor
AlarmSender(ContainerServices svcs, java.lang.String name, long timeBetweenAlarms) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	addListener(AlarmSentListener listener) Add a listener
int	alarmsWaiting() Return the number of alars queued and waiting to be sent
void	close() Close the sender and the thread
boolean	removeListener(AlarmSentListener listener) Remove a listener
void	run() The thread to get alarms from queue and publish them into the NC
void	send(ParallelAlarmSender.AlarmToSend alarmToSend) Send the specified alarm to the alarm service.
protected void	sendSynch(SenderPanelUtils.Triplet triplet, SenderPanelUtils.AlarmDescriptorType descriptor, java.util.Properties props) Synchronously publishes the specified alarm in the source NC.
void	start() Start the thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmSender

public AlarmSender(ContainerServices svcs,
                   java.lang.String name)
            throws ACSASFactoryNotInitedEx,
                   SourceCreationErrorEx

Constructor

Parameters:

svcs - The ContainerServices

name - The name of the sender

Throws:

SourceCreationErrorEx

ACSASFactoryNotInitedEx

AlarmSender

public AlarmSender(ContainerServices svcs,
                   java.lang.String name,
                   long timeBetweenAlarms)
            throws ACSASFactoryNotInitedEx,
                   SourceCreationErrorEx

Constructor

Parameters:

svcs - The ContainerServices

name - The name of the sender

The - time between sending 2 alarms

Throws:

SourceCreationErrorEx

ACSASFactoryNotInitedEx

Method Detail

sendSynch

protected void sendSynch(SenderPanelUtils.Triplet triplet,
                         SenderPanelUtils.AlarmDescriptorType descriptor,
                         java.util.Properties props)

Synchronously publishes the specified alarm in the source NC.

Sending alarms through this method should be generally avoided, preferring #send(Triplet, AlarmDescriptorType, Properties) instead.

Parameters:

triplet - The triplet in the form FF,FM,FC

The - descriptor

props - The user properties

Throws:

FaultStateCreationErrorEx

ACSASFactoryNotInitedEx

send

public void send(ParallelAlarmSender.AlarmToSend alarmToSend)
          throws java.lang.InterruptedException

Send the specified alarm to the alarm service.

This method return immediately: each alarm is queued and sent later on by the thread.

If the queue of alarms contains more then , the caller waits until the thread frees the queue.

Parameters:

alarmToSend - The alarm to send to the alarm server

Throws:

java.lang.InterruptedException - If interrupted while awaiting to put the alarm in the queue

addListener

public boolean addListener(AlarmSentListener listener)

Add a listener

Parameters:

listener - The listener to notify when an alarm has been sent

Returns:

true if this set did not already contain the specified element

removeListener

public boolean removeListener(AlarmSentListener listener)

Remove a listener

Parameters:

listener - The listener to notify when an alarm has been sent

Returns:

true if this set contained the specified element

start

public void start()

Start the thread.

close

public void close()

Close the sender and the thread

alarmsWaiting

public int alarmsWaiting()

Return the number of alars queued and waiting to be sent

Returns:

run

public void run()

The thread to get alarms from queue and publish them into the NC

Specified by:

run in interface java.lang.Runnable