alma.alarmsystem.source

Class ACSAlarmSystemInterfaceFactory

java.lang.Object

alma.alarmsystem.source.ACSAlarmSystemInterfaceFactory

public class ACSAlarmSystemInterfaceFactory
extends java.lang.Object

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 value of such property is CERN. If the property is not found, is ACS or the CDB record does not exist then the ACS implementation for sources is used.

ACSAlarmSystemInterfaceFactory owns the instances of the AlarmSource created by the component or containers. in this way it is possible to control the cleanup of the alarm sources when a component is unloaded or the ACSAlarmSystemInterfaceFactory terminates.

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
ACSAlarmSystemInterfaceFactory()

Method Summary

Modifier and Type	Method and Description
static ACSFaultState	createFaultState() Factory method for creating ACSFaultState instances.
static ACSFaultState	createFaultState(java.lang.String family, java.lang.String member, int code) Factory method for creating ACSFaultState instances.
static ACSAlarmSystemInterface	createSource() Create a new instance of an alarm system interface without binding it to any source.
static ACSAlarmSystemInterface	createSource(java.lang.String sourceName) Create a new instance of an alarm system interface.
static void	done() Cleanup the class.
static AlarmSource	getAlarmSource(ContainerServicesBase contSvcs) Return the AlarmSource for the container whose name is retrieved from the passed ContainerServicesBase by delegating to the AlarmSourceFactory.
static void	init(ContainerServicesBase containerServices) Init the static variables of the class This method has to be called before executing any other method.
static void	releaseAlarmSource(ContainerServicesBase contSvcs) Release the AlarmSource object of the component whose name is read from passed the ContainerServicesBase by delegating to the AlarmSourceFactory.
static boolean	usingACSAlarmSystem() Return the type of AS used

Methods inherited from class java.lang.Object

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

Constructor Detail

ACSAlarmSystemInterfaceFactory

public ACSAlarmSystemInterfaceFactory()

Method Detail

init

public static void init(ContainerServicesBase containerServices)
                 throws AcsJContainerServicesEx

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

Throws:

AcsJContainerServicesEx

done

public static void done()

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

createSource

public static ACSAlarmSystemInterface createSource(java.lang.String sourceName)
                                            throws ACSASFactoryNotInitedEx,
                                                   SourceCreationErrorEx

Create a new instance of an alarm system interface.

Parameters:

sourceName - the source name.

Returns:

the interface instance.

Throws:

ASIException - if the AlarmSystemInterface instance can not be created.

ACSASFactoryNotInitedEx

SourceCreationErrorEx

createSource

public static ACSAlarmSystemInterface createSource()
                                            throws ACSASFactoryNotInitedEx,
                                                   SourceCreationErrorEx

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

Returns:

the interface instance.

Throws:

ASIException - if the AlarmSystemInterface instance can not be created.

ACSASFactoryNotInitedEx

SourceCreationErrorEx

createFaultState

public static ACSFaultState createFaultState()
                                      throws ACSASFactoryNotInitedEx,
                                             FaultStateCreationErrorEx

Factory method for creating ACSFaultState instances.

Returns:

a new ACSFaultState instance.

Throws:

ACSASFactoryNotInitedEx

FaultStateCreationErrorEx

createFaultState

public static ACSFaultState createFaultState(java.lang.String family,
                                             java.lang.String member,
                                             int code)
                                      throws ACSASFactoryNotInitedEx,
                                             FaultStateCreationErrorEx

Factory method for creating ACSFaultState instances.

Parameters:

family - the fault family.

member - the fault member.

code - the fault code.

Returns:

a new ACSFaultState instance.

Throws:

ACSASFactoryNotInitedEx

FaultStateCreationErrorEx

usingACSAlarmSystem

public static boolean usingACSAlarmSystem()
                                   throws ACSASFactoryNotInitedEx

Return the type of AS used

Returns:

True if ACS AS is used, false otherwise

Throws:

java.lang.IllegalStateException - If the factory has not been initialized yet

ACSASFactoryNotInitedEx

getAlarmSource

public static AlarmSource getAlarmSource(ContainerServicesBase contSvcs)

Return the AlarmSource for the container whose name is retrieved from the passed ContainerServicesBase by delegating to the AlarmSourceFactory.

Parameters:

contSvcs - The ContainerServices

Returns:

the AlarmSource

releaseAlarmSource

public static void releaseAlarmSource(ContainerServicesBase contSvcs)

Release the AlarmSource object of the component whose name is read from passed the ContainerServicesBase by delegating to the AlarmSourceFactory.

Parameters:

containerServices - The ContainerServices