Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory Class Reference

List of all members.

Static Public Member Functions

void init (ContainerServicesBase containerServices) throws AcsJContainerServicesEx
void done ()
synchronized ACSAlarmSystemInterface createSource (String sourceName) throws ACSASFactoryNotInitedEx, SourceCreationErrorEx
ACSAlarmSystemInterface createSource () throws ACSASFactoryNotInitedEx, SourceCreationErrorEx
synchronized ACSFaultState createFaultState () throws ACSASFactoryNotInitedEx, FaultStateCreationErrorEx
ACSFaultState createFaultState (String family, String member, int code) throws ACSASFactoryNotInitedEx, FaultStateCreationErrorEx
boolean usingACSAlarmSystem () throws ACSASFactoryNotInitedEx

Static Private Member Functions

void initCmwMom () throws Exception
boolean retrieveImplementationType (DAL dal)
String getProperty (String dao, String propName)

Static Private Attributes

final String CONFIGURATION_PATH = "Alarms/Administrative/AlarmSystemConfiguration"
Boolean useACSAlarmSystem = null
Logger logger = null
ContainerServicesBase containerServices

Detailed Description

ACSAlarmSystemInterfaceFactory extends the CERN AlarmSystemInterfaceFactory to create sources with different implementations depending on the actual configuration in the CDB.

The type of implementation is in AlarmSystemConfiguration.xml: a property named Implementation. CERN implementation is used only if the property is CERN. If the property is not found, is ACS or the CDB record does not exist the ACS implementation for sources is used.

Author:
acaproni


Member Function Documentation

ACSFaultState alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::createFaultState String  family,
String  member,
int  code
throws ACSASFactoryNotInitedEx, FaultStateCreationErrorEx [inline, static]
 

Factory method for creating ACSFaultState instances.

Returns:
a new ACSFaultState instance.
Parameters:
family the fault family.
member the fault member.
code the fault code.

synchronized ACSFaultState alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::createFaultState  )  throws ACSASFactoryNotInitedEx, FaultStateCreationErrorEx [inline, static]
 

Factory method for creating ACSFaultState instances.

Returns:
a new ACSFaultState instance.

ACSAlarmSystemInterface alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::createSource  )  throws ACSASFactoryNotInitedEx, SourceCreationErrorEx [inline, static]
 

Create a new instance of an alarm system interface without binding it to any source.

Returns:
the interface instance.
Exceptions:
ASIException if the AlarmSystemInterface instance can not be created.

synchronized ACSAlarmSystemInterface alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::createSource String  sourceName  )  throws ACSASFactoryNotInitedEx, SourceCreationErrorEx [inline, static]
 

Create a new instance of an alarm system interface.

Parameters:
sourceName the source name.
Returns:
the interface instance.
Exceptions:
ASIException if the AlarmSystemInterface instance can not be created.

void alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::done  )  [inline, static]
 

Cleanup the class. This method has to be called outside of the class and performs all the necessary clean up

String alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::getProperty String  dao,
String  propName
[inline, static, private]
 

Get the value of a property from the DAO.

Parameters:
dao The dao (XML string)
propName The name of the property
Returns:
The value of the property with the given name null if the property doesn't exist

void alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::init ContainerServicesBase  containerServices  )  throws AcsJContainerServicesEx [inline, static]
 

Init the static variables of the class This method has to be called before executing any other method.

Parameters:
logger The logger
dal The DAL to init the AS with CERN or ACS implementation
Exceptions:
AcsJContainerServicesEx 

void alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::initCmwMom  )  throws Exception [inline, static, private]
 

Initialize cmw-mom (that in turn inits acs-jms) by setting the container services.

The container services must be set in a cmw-mom static variable in order the messages are published into the NC. The container services will be passed from this class down to the acs-jms classes.

See also:
cern.cmw.mom.pubsub.impl.ACSJMSTopicConnectionImpl

boolean alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::retrieveImplementationType DAL  dal  )  [inline, static, private]
 

Read the Implementation property from the Alarm System Configuration

Parameters:
dal The DAL
Returns:
false if the Implementation property is CERN true otherwise

boolean alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::usingACSAlarmSystem  )  throws ACSASFactoryNotInitedEx [inline, static]
 

Return the type of AS used

Returns:
True if ACS AS is used, false otherwise


Member Data Documentation

final String alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::CONFIGURATION_PATH = "Alarms/Administrative/AlarmSystemConfiguration" [static, private]
 

ContainerServicesBase alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::containerServices [static, private]
 

Logger alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::logger = null [static, private]
 

Boolean alma::alarmsystem::source::ACSAlarmSystemInterfaceFactory::useACSAlarmSystem = null [static, private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:01:38 2009 for ACS Java API by doxygen 1.3.8