alma.alarmsystem.clients

Class AlarmCategoryClient

java.lang.Object

alma.alarmsystem.clients.AlarmCategoryClient

All Implemented Interfaces:

AlarmSelectionListener

public class AlarmCategoryClient
extends java.lang.Object
implements AlarmSelectionListener

AlarmCategoryClient listens to alarms produced by the alarm server, by means of a CategoryClient and offers greater functionalities to listeners like:

• Filtering of alarms based on the value of their triplets
• Notification about the number of active alarms for each priority

After instantiating a object of this class, the clients should register in order to be notified with callbacks and only after call connect() or connect(Category[]).
close()must be called when finished using this object to ensure the correct cleanup of the allocated resources.

AlarmCategoryClient has been introduced after ICT-547 offering more functionality of what has been requested in the ticket to be ready for next generation of user needs. As a such, its API will most likely expanded in the future to cope with new requirements.

Note that it is possible to add filtering capabilities while connecting to the categories by properly setting Filter to the AlarmSelectionHandler. However a quick look to filtering seems to suggest that it is based on SQL because CERN AS originally persisted alarms in a database. In out implementation all the alarms are in memory and therefore we can't get advantage of SQL for filtering.

Since:

ACS-12.2

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
AlarmCategoryClient(ContainerServices contServices) Constructor
AlarmCategoryClient(org.omg.CORBA.ORB orb, AcsLogger logger) Contructor

Method Summary

Modifier and Type	Method and Description
boolean	addAlarmListener(AlarmListenersContainer.AlarmListener listener)
AlarmListenersContainer.AlarmListener	addAlarmListener(AlarmSelectionListener listener)
AlarmListenersContainer.AlarmListener	addAlarmListener(AlarmSelectionListener listener, AlarmFilter filter)
boolean	addStatsListener(AlarmCategoryStatListener listener)
void	close() Release all the resource,
void	connect() Connects to all the categories of the alarm system.
void	connect(Category[] categories) Connects to the passed categories of the alarm system
Alarm[]	getActiveChildren(java.lang.String id, boolean node)
Alarm[]	getChildren(java.lang.String id, boolean node)
int	getMultiplicityThreshold(java.lang.String id)
Alarm[]	getParents(java.lang.String id, boolean node)
void	onAlarm(Alarm alarm) This method is executed whenever a new alarm is received.
void	onException(LaserSelectionException e) This method is executed whenever a new exception happens.
boolean	removeAlarmListener(AlarmListenersContainer.AlarmListener listenerToRemove)
boolean	removeStatListener(AlarmCategoryStatListener listenerToRemove)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmCategoryClient

public AlarmCategoryClient(ContainerServices contServices)
                    throws AlarmClientException

Constructor

Parameters:

contServices - The containerServices

Throws:

AlarmClientException

See Also:

#AlarmCategoryClient(ContainerServices)}

AlarmCategoryClient

public AlarmCategoryClient(org.omg.CORBA.ORB orb,
                           AcsLogger logger)

Contructor

Parameters:

orb - The orb

logger - The logger

See Also:

#AlarmCategoryClient(ORB, AcsLogger)}

Method Detail

connect

public void connect()
             throws AlarmClientException,
                    AcsJCannotGetComponentEx

Connects to all the categories of the alarm system. It is equivalent to connect(null).

Throws:

AlarmClientException - In case of failure connecting the client

AcsJCannotGetComponentEx - If the alarm service component is not available

See Also:

CategoryClient.connect(AlarmSelectionListener, Category[])

connect

public void connect(Category[] categories)
             throws AlarmClientException,
                    AcsJCannotGetComponentEx

Connects to the passed categories of the alarm system

Parameters:

categories - The categories to connect to

Throws:

AcsJCannotGetComponentEx - In case the AlarmService is not available

AlarmClientException - In case of failure connecting the client

See Also:

CategoryClient.connect(AlarmSelectionListener, Category[])

close

public void close()
           throws AlarmClientException

Release all the resource,

Throws:

AlarmClientException

onAlarm

public void onAlarm(Alarm alarm)

This method is executed whenever a new alarm is received.

Specified by:

onAlarm in interface AlarmSelectionListener

Parameters:

alarm - the changed alarm

See Also:

AlarmSelectionListener

onException

public void onException(LaserSelectionException e)

This method is executed whenever a new exception happens.

Specified by:

onException in interface AlarmSelectionListener

Parameters:

e - the LaserSelectionException carrying the exception code

See Also:

AlarmSelectionListener

getParents

public Alarm[] getParents(java.lang.String id,
                          boolean node)
                   throws AlarmClientException

Throws:

AlarmClientException

See Also:

CategoryClient#getParents(String, boolean)}

getChildren

public Alarm[] getChildren(java.lang.String id,
                           boolean node)
                    throws AlarmClientException

Throws:

AlarmClientException

See Also:

CategoryClient#getChildren(String, boolean)}

getMultiplicityThreshold

public int getMultiplicityThreshold(java.lang.String id)
                             throws AlarmClientException

Throws:

AlarmClientException

See Also:

CategoryClient#getMultiplicityThreshold(String)}

getActiveChildren

public Alarm[] getActiveChildren(java.lang.String id,
                                 boolean node)
                          throws AlarmClientException

Throws:

AlarmClientException

See Also:

CategoryClient#getActiveChildren(String, boolean)}

addAlarmListener

public boolean addAlarmListener(AlarmListenersContainer.AlarmListener listener)

See Also:

AlarmListenersContainer.addAlarmListener(AlarmListener)

addAlarmListener

public AlarmListenersContainer.AlarmListener addAlarmListener(AlarmSelectionListener listener,
                                                              AlarmFilter filter)

See Also:

AlarmListenersContainer.addAlarmListener(AlarmSelectionListener, AlarmFilter)

addAlarmListener

public AlarmListenersContainer.AlarmListener addAlarmListener(AlarmSelectionListener listener)

See Also:

AlarmListenersContainer.addAlarmListener(AlarmSelectionListener)

removeAlarmListener

public boolean removeAlarmListener(AlarmListenersContainer.AlarmListener listenerToRemove)

See Also:

AlarmListenersContainer.removeAlarmListener(AlarmListener)

addStatsListener

public boolean addStatsListener(AlarmCategoryStatListener listener)

See Also:

AlarmListenersContainer.addStatsListener(AlarmCategoryStatListener)

removeStatListener

public boolean removeStatListener(AlarmCategoryStatListener listenerToRemove)

See Also:

AlarmListenersContainer.removeStatListener(AlarmCategoryStatListener)