com.cosylab.acs.laser

Class LaserComponent

java.lang.Object

CERNAlarmServicePOA

com.cosylab.acs.laser.LaserComponent

All Implemented Interfaces:

AlarmSourcesListener.SourceListener

public class LaserComponent
extends CERNAlarmServicePOA
implements AlarmSourcesListener.SourceListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LaserComponent.LaserComponentTerminator A class to terminate the alarm service asynchronously.

Constructor Summary

Constructors

Constructor and Description
LaserComponent(AlarmSystemCorbaServer corbaServer, AlarmSystemContainerServices alSysContSvcs) Constructor

Method Summary

Modifier and Type	Method and Description
void	archiveSearch(int[] categoryIds, java.lang.String sql, java.lang.String clientId)
java.lang.String	createAdminUser(java.lang.String name, java.lang.String password)
void	createAlarm(java.lang.String userId, alma.alarmsystem.AlarmDefinition definition)
void	createCategory(java.lang.String userId, alma.alarmsystem.CategoryDefinition definition)
void	createSource(java.lang.String userId, alma.alarmsystem.SourceDefinition definition)
void	execute()
LogLevels	get_default_logLevels() Gets the log levels of the default logging configuration.
java.lang.String[]	get_logger_names() Gets the names of all loggers, to allow configuring their levels individually.
LogLevels	get_logLevels(java.lang.String logger_name) Gets log levels for a particular named logger.
Alarm[]	getActiveMultiplicityChildren(java.lang.String parentId)
Alarm[]	getActiveNodeChildren(java.lang.String parentId)
Alarm	getAlarmById(java.lang.String id)
Alarm	getAlarmByTriplet(java.lang.String ff, java.lang.String fm, int fc)
Alarm[]	getAlarmsByCategory(int categoryId)
Alarm[]	getAlarmsByPriority(int priority)
Alarm[]	getAlarmsByResponsiblePerson(int responsibleId)
Alarm[]	getAlarmsBySource(java.lang.String sourceId)
Category[]	getCategories()
Category	getCategoryByPath(java.lang.String path)
Category[]	getCategoryChildren(int nodeId)
Category	getCategoryParent(int nodeId)
java.lang.String	getCategoryRootTopic()
Category	getCategoryTreeRoot()
java.lang.String	getClientRootTopic()
long	getHeartbeatFrequency()
java.lang.String	getHeartbeatTopic()
Alarm[]	getMultiplicityChildren(java.lang.String parentId)
Alarm[]	getMultiplicityParents(java.lang.String childId)
int	getMultiplicityThreshold(java.lang.String parentId)
Alarm[]	getNodeChildren(java.lang.String parentId)
Alarm[]	getNodeParents(java.lang.String childId)
ResponsiblePerson[]	getResponsiblePersons()
java.lang.String	getSearchRootTopic()
Source[]	getSources()
void	initialize()
boolean	isACSAlarmService()
java.lang.String	loginAdminUser(java.lang.String name, java.lang.String password)
void	onMessage(java.lang.String message) The xml recieved from the source (to be unmarshalled into e ASIMessage).
void	refresh_logging_config() Commands the container or manager to read in again the logging configuration from the CDB and to reconfigure the loggers accordingly.
void	search(int[] categoryIds, java.lang.String sql, java.lang.String clientId)
void	select(int[] categoryIds, java.lang.String client)
void	sendCoreAlarmAsync(LaserCoreFaultState.LaserCoreFaultCodes alarm, boolean active) Send a core alarm in a dedicated thread.
void	sentCoreAlarms(java.util.Vector<LaserCoreFaultState.LaserCoreFaultCodes> alarms) Send alarm services alarms and return when all the alarms have been processed by the alarm message processor.
void	set_default_logLevels(LogLevels levels) Sets the log levels of the default logging configuration.
void	set_logLevels(java.lang.String logger_name, LogLevels levels) Sets log levels for a particular named logger.
void	shutdown() Shutdown the alarm service
void	submitAlarm(Triplet triplet, boolean active, java.lang.String sourceHostName, java.lang.String sourceName, long timestamp, Property[] alarmProperties) IDL method: submit an alarm without.

Methods inherited from class java.lang.Object

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

Constructor Detail

LaserComponent

public LaserComponent(AlarmSystemCorbaServer corbaServer,
                      AlarmSystemContainerServices alSysContSvcs)
               throws java.lang.Exception

Constructor

Throws:

java.lang.Exception

Method Detail

initialize

public void initialize()

shutdown

public void shutdown()

Shutdown the alarm service

sendCoreAlarmAsync

public void sendCoreAlarmAsync(LaserCoreFaultState.LaserCoreFaultCodes alarm,
                               boolean active)

Send a core alarm in a dedicated thread.

This method is useful when a core alarm must be sent without waiting for its processing to be completed by the alarm message processor.
A typical example is a core alarm generated by the alarm message processor itself.

sendCoreAlarmAsync delegates to sentCoreAlarms(Vector) that is invoked in a dedicated thread.

Parameters:

alarm - The core alarm to send

true - if the alarm must be set and false otherwise

sentCoreAlarms

public void sentCoreAlarms(java.util.Vector<LaserCoreFaultState.LaserCoreFaultCodes> alarms)

Send alarm services alarms and return when all the alarms have been processed by the alarm message processor.

The alarms generated by the alarm service are injected in the component by executing the onMessage

Parameters:

alarms - The alarms to send alarms can be null or empty;

onMessage

public void onMessage(java.lang.String message)

Description copied from interface: AlarmSourcesListener.SourceListener

The xml recieved from the source (to be unmarshalled into e ASIMessage).

Specified by:

onMessage in interface AlarmSourcesListener.SourceListener

See Also:

MessageListener

execute

public void execute()
             throws ComponentLifecycleException

Throws:

ComponentLifecycleException

getActiveMultiplicityChildren

public Alarm[] getActiveMultiplicityChildren(java.lang.String parentId)

getActiveNodeChildren

public Alarm[] getActiveNodeChildren(java.lang.String parentId)

getAlarmById

public Alarm getAlarmById(java.lang.String id)

getAlarmByTriplet

public Alarm getAlarmByTriplet(java.lang.String ff,
                               java.lang.String fm,
                               int fc)

getAlarmsByCategory

public Alarm[] getAlarmsByCategory(int categoryId)

getAlarmsByPriority

public Alarm[] getAlarmsByPriority(int priority)

getAlarmsByResponsiblePerson

public Alarm[] getAlarmsByResponsiblePerson(int responsibleId)

getAlarmsBySource

public Alarm[] getAlarmsBySource(java.lang.String sourceId)

getCategories

public Category[] getCategories()

getCategoryByPath

public Category getCategoryByPath(java.lang.String path)

getCategoryChildren

public Category[] getCategoryChildren(int nodeId)

getCategoryParent

public Category getCategoryParent(int nodeId)

getCategoryRootTopic

public java.lang.String getCategoryRootTopic()

getCategoryTreeRoot

public Category getCategoryTreeRoot()

getClientRootTopic

public java.lang.String getClientRootTopic()

getHeartbeatFrequency

public long getHeartbeatFrequency()

getHeartbeatTopic

public java.lang.String getHeartbeatTopic()

getMultiplicityChildren

public Alarm[] getMultiplicityChildren(java.lang.String parentId)

getMultiplicityParents

public Alarm[] getMultiplicityParents(java.lang.String childId)

getMultiplicityThreshold

public int getMultiplicityThreshold(java.lang.String parentId)

getNodeChildren

public Alarm[] getNodeChildren(java.lang.String parentId)

getNodeParents

public Alarm[] getNodeParents(java.lang.String childId)

getResponsiblePersons

public ResponsiblePerson[] getResponsiblePersons()

getSearchRootTopic

public java.lang.String getSearchRootTopic()

getSources

public Source[] getSources()

archiveSearch

public void archiveSearch(int[] categoryIds,
                          java.lang.String sql,
                          java.lang.String clientId)

search

public void search(int[] categoryIds,
                   java.lang.String sql,
                   java.lang.String clientId)

select

public void select(int[] categoryIds,
                   java.lang.String client)
            throws LaserProcessingException

Throws:

LaserProcessingException

createAdminUser

public java.lang.String createAdminUser(java.lang.String name,
                                        java.lang.String password)
                                 throws alma.alarmsystem.LaserDefinitionException

Throws:

alma.alarmsystem.LaserDefinitionException

loginAdminUser

public java.lang.String loginAdminUser(java.lang.String name,
                                       java.lang.String password)

createCategory

public void createCategory(java.lang.String userId,
                           alma.alarmsystem.CategoryDefinition definition)
                    throws alma.alarmsystem.LaserDefinitionException

Throws:

alma.alarmsystem.LaserDefinitionException

createSource

public void createSource(java.lang.String userId,
                         alma.alarmsystem.SourceDefinition definition)
                  throws alma.alarmsystem.LaserDefinitionException

Throws:

alma.alarmsystem.LaserDefinitionException

createAlarm

public void createAlarm(java.lang.String userId,
                        alma.alarmsystem.AlarmDefinition definition)
                 throws alma.alarmsystem.LaserDefinitionException

Throws:

alma.alarmsystem.LaserDefinitionException

isACSAlarmService

public boolean isACSAlarmService()

submitAlarm

public void submitAlarm(Triplet triplet,
                        boolean active,
                        java.lang.String sourceHostName,
                        java.lang.String sourceName,
                        long timestamp,
                        Property[] alarmProperties)
                 throws BadParameterEx,
                        UnexpectedExceptionEx

IDL method: submit an alarm without.

Build a message to sent to the AlarmMessageProcessorImpl.process(Message).

Parameters:

triplet - The triplet of the alarm

active - if true the alarm is active

sourceHostName - The name of the host of the source

timestamp - The timestamp of the source

alarmProperties - Additional user-defined properties of the alarm

Throws:

BadParameterEx

UnexpectedExceptionEx

get_default_logLevels

public LogLevels get_default_logLevels()

Gets the log levels of the default logging configuration. These levels are used by all loggers that have not been configured individually.

set_default_logLevels

public void set_default_logLevels(LogLevels levels)
                           throws IllegalLogLevelsEx

Sets the log levels of the default logging configuration. These levels are used by all loggers that have not been configured individually.

Throws:

IllegalLogLevelsEx

get_logger_names

public java.lang.String[] get_logger_names()

Gets the names of all loggers, to allow configuring their levels individually. The names are those that appear in the log records in the field "SourceObject". This includes the container logger, ORB logger, component loggers, and (only C++) GlobalLogger.

The returned logger names are randomly ordered.

get_logLevels

public LogLevels get_logLevels(java.lang.String logger_name)
                        throws LoggerDoesNotExistEx

Gets log levels for a particular named logger. If the returned field LogLevels.useDefault is true, then the logger uses the default levels, see get_default_logLevels(); otherwise the returned local and remote levels apply.

For possible convenience, the default levels are returned in addition to setting LogLevels#useDefault to true.

Throws:

LoggerDoesNotExistEx

set_logLevels

public void set_logLevels(java.lang.String logger_name,
                          LogLevels levels)
                   throws LoggerDoesNotExistEx,
                          IllegalLogLevelsEx

Sets log levels for a particular named logger. If levels.useDefault is true, then the logger will be reset to using default levels; otherwise it will use the supplied local and remote levels.

Throws:

LoggerDoesNotExistEx

IllegalLogLevelsEx

refresh_logging_config

public void refresh_logging_config()

Commands the container or manager to read in again the logging configuration from the CDB and to reconfigure the loggers accordingly. This allows for persistent changes in the logging configuration to become effective, and also for changes of more advanced parameters.

Note that unlike for the logging initialization in initialize(), now we give precedence to the CDB values over any previous settings.