alma.alarmsystem.dump

Class AlarmDumperBase

java.lang.Object

alma.acs.component.client.ComponentClient

alma.acs.component.client.AdvancedComponentClient

alma.alarmsystem.dump.AlarmDumperBase

Direct Known Subclasses:

AlarmCategoryDumper, AlarmSourceDumper

public abstract class AlarmDumperBase
extends AdvancedComponentClient

The base class of the alarm dumper. It groups common code for the dumpers that write XML alarms, from sources or categories, in the stdout.

The pattern for using a dumper is:

1. Instantiate the dumper that extends this class
2. call receiveAlarms()

call tearDown()

receiveAlarms() blocks until the user presses CTRL-C a signal is received or tearDown() is called.
receiveAlarms(long, TimeUnit) can be used instead of receiveAlarms() if the receiving has to terminate after the specified timeout.

tearDown() must be called before terminating to cleanly exit.

Since:

ACS-10.1

Author:

acaproni

Field Summary

Fields inherited from class alma.acs.component.client.ComponentClient

m_logger, m_shutdownHook

Constructor Summary

Constructors

Constructor and Description
AlarmDumperBase(java.util.logging.Logger theLogger, java.lang.String mangerLoc, java.lang.String clientname) Constructor

Method Summary

Modifier and Type	Method and Description
static void	clientRunner(java.lang.String[] args, boolean isSourceClient, long timeout, java.util.concurrent.TimeUnit timeUnit) This block of code avoid code replication.
abstract void	close() Close the resources of the alarm client
java.lang.String	formatTimestamp(java.sql.Timestamp timestamp) Return the timestamp in ISO format.
void	receiveAlarms() Connect the client This method never stops.
void	receiveAlarms(long timeout, java.util.concurrent.TimeUnit timeUnit) Connect the client until the timeout elapses or the user presses CTRL-C This method never when the timeout elapse or the user presses CTRL-C
protected void	registerShutdownHook() AlarmDumperBase registers its own shutdown hook in fact what is provided by ComponentClient logs a few warnings if the process is interrupted but in this case the situation is absolutely normal.
abstract void	startReceivingAlarms() Connects to the NC and start receiving alarms.
void	tearDown() Cleanly tear down

Methods inherited from class alma.acs.component.client.AdvancedComponentClient

createContainerServices, destroyContainerServices, getAcsCorba, getAcsManagerProxy

Methods inherited from class alma.acs.component.client.ComponentClient

getContainerServices, initAlarmSystem, initRemoteLogging, tearDownAlarmSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmDumperBase

public AlarmDumperBase(java.util.logging.Logger theLogger,
                       java.lang.String mangerLoc,
                       java.lang.String clientname)
                throws java.lang.Exception

Constructor

Parameters:

theLogger - The logger

mangerLoc - The CORBA loc of the manager

clientname - The name of the client

Throws:

java.lang.Exception - if an error happens instantiating the AdvancedComponentClient

Method Detail

startReceivingAlarms

public abstract void startReceivingAlarms()
                                   throws java.lang.Exception

Connects to the NC and start receiving alarms.

This must be implemented to connect to the right NC. If the connection failed, startReceivingAlarms() must thrown an exception

Throws:

java.lang.Exception

receiveAlarms

public void receiveAlarms()
                   throws java.lang.Exception

Connect the client This method never stops.

Throws:

java.lang.Exception - In case of error connecting the SourceClient

receiveAlarms

public void receiveAlarms(long timeout,
                          java.util.concurrent.TimeUnit timeUnit)
                   throws java.lang.Exception

Connect the client until the timeout elapses or the user presses CTRL-C This method never when the timeout elapse or the user presses CTRL-C

Throws:

java.lang.Exception - In case of error connecting the SourceClient

close

public abstract void close()
                    throws java.lang.Exception

Close the resources of the alarm client

Throws:

java.lang.Exception

tearDown

public void tearDown()

Cleanly tear down

Overrides:

tearDown in class ComponentClient

registerShutdownHook

protected void registerShutdownHook()

AlarmDumperBase registers its own shutdown hook in fact what is provided by ComponentClient logs a few warnings if the process is interrupted but in this case the situation is absolutely normal.

Overrides:

registerShutdownHook in class ComponentClient

formatTimestamp

public java.lang.String formatTimestamp(java.sql.Timestamp timestamp)

Return the timestamp in ISO format.

Parameters:

timestamp -

Returns:

clientRunner

public static void clientRunner(java.lang.String[] args,
                                boolean isSourceClient,
                                long timeout,
                                java.util.concurrent.TimeUnit timeUnit)

This block of code avoid code replication.

Parameters:

args - Command line args

isSourceClient - true if a source client must be instantiated, false for category client

timeout - If greater then 0 the process waits until the timeout elapses

timeUnit - The TimeUnit for the timeout (must be not null if the timeout is greater then 0)