alma.alarmsystem.clients

Class CategoryClient

java.lang.Object

alma.alarmsystem.clients.CategoryClient

Direct Known Subclasses:

AcsCategoryClient

public class CategoryClient
extends java.lang.Object

A client that listen to alarms from all the categories. It is meant to be used only by AlarmCategoryClient and should not be instantiated directly.

It is a wrapper to CERN classes in order to simplify the usage from ACS without dealing with low level details of the alarm system.

The class connects to the alarm system as a CERN client, logging in a generic user. The listener receives alarms and errors from the alarm system by means of a callback. The alarm system sends all the already active alarms when the user logs is.

The close() method has to be called in order to free all the resources.

TODO: reduce the visibility of this class to ensure it is not used outside of AlarmCategoryClient

Author:

acaproni

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close() Release all the resource,
void	connect(AlarmSelectionListener listener) Connects to all the categories of the alarm system.
void	connect(AlarmSelectionListener listener, Category[] categories) Connects to the passed categories of the alarm system
protected void	finalize() Ensure that the resources have been released before destroying the object
Alarm[]	getActiveChildren(java.lang.String id, boolean node) Get the active children of a reduced alarm.
Alarm[]	getChildren(java.lang.String id, boolean node) Get the parents of a reduced alarm.
int	getMultiplicityThreshold(java.lang.String id) Return the threshold for the multiplicity node whose ID is passed as parameter.
Alarm[]	getParents(java.lang.String id, boolean node) Get the parents of a reduced alarm.

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryClient

public CategoryClient(ContainerServices contServices)
               throws AlarmClientException

Constructor

Parameters:

contServices - The containerServices

Throws:

AlarmClientException

CategoryClient

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

Contructor

Parameters:

orb - The orb

logger - The logger

Method Detail

connect

public void connect(AlarmSelectionListener listener)
             throws AlarmClientException,
                    AcsJCannotGetComponentEx

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

Parameters:

listener - The lister to notify of the alarms received from the categories

Throws:

AlarmClientException - In case of failure connecting the client

AcsJCannotGetComponentEx - If the alarm service component is not available

See Also:

connect(AlarmSelectionListener, Category[])

connect

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

Connects to the passed categories of the alarm system

Parameters:

listener - The lister to notify of the alarms received from the categories

categories - The categories to connect to

Throws:

AcsJCannotGetComponentEx - In case the AlarmService is not available

AlarmClientException - In case of failure connecting the client

close

public void close()
           throws AlarmClientException

Release all the resource,

Throws:

AlarmClientException

finalize

protected void finalize()
                 throws java.lang.Throwable

Ensure that the resources have been released before destroying the object

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

getParents

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

Get the parents of a reduced alarm.

The method asks the alarm service component for the parents of a reduced alarm.

Parameters:

id - The id of the alarm

node - true if the alarm is a Node alarm; false if the alarm of the passed ID is a multiplicity.

Returns:

The array of the alarm parent of the alarm with the passed ID

Throws:

AlarmClientException - In case of error getting the alarms from the component

getChildren

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

Get the parents of a reduced alarm.

The method asks the alarm service component for the children of a reduced alarm.

Parameters:

id - The id of the alarm

node - true if the alarm is a Node alarm; false if the alarm of the passed ID is a multiplicity.

Returns:

The array of the alarm parent of the alarm with the passed ID

Throws:

AlarmClientException - In case of error getting the alarms from the component

getMultiplicityThreshold

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

Return the threshold for the multiplicity node whose ID is passed as parameter.

Parameters:

id - The id of the multiplicity node

Returns:

The multiplicity threshold of the node with the given id

Throws:

AlarmClientException - If an error happens getting the threshold from the component

getActiveChildren

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

Get the active children of a reduced alarm.

The method asks the alarm service component for the active children of a reduced alarm.

Parameters:

id - The id of the alarm

node - true if the alarm is a Node alarm; false if the alarm of the passed ID is a multiplicity.

Returns:

The array of the alarm parent of the alarm with the passed ID

Throws:

AlarmClientException - In case of error getting the alarms from the component