de.ipcon.db.alarm

Class AlarmHandler

java.lang.Object

de.ipcon.db.alarm.AlarmHandler

All Implemented Interfaces:

BTHandlerI

Direct Known Subclasses:

BOAssociatedAlarmHandler, EinfacherTerminHandler

public abstract class AlarmHandler
extends java.lang.Object
implements BTHandlerI

Method Summary

Modifier and Type	Method and Description
void	addClassesOfInterest(java.util.Set<java.lang.Class> classesOfInterest) Adds to the given Set all classes that this handler must monitor for changes.
void	deactivateAlarmDueToErrors(Alarm alarm, java.lang.Exception ex, java.lang.String msg) Sets the given alarm to "deactivated" and stores the given error info with it.
void	deactivateAlarmDueToErrors(Alarm alarm, java.lang.Exception ex, java.lang.String msg, org.apache.log4j.Logger logger)
abstract java.lang.Class	getAlarmClass() Determines the specific subclass of Alarm for which this AlarmHandler is responsible.
java.util.Map<java.lang.Long,Alarm>	getAlarme() Basically a simple data holder for the plethora of values that need to be passed around in the course of an alarm triggering.
java.util.Iterator	getAlarmeIterator()
AlarmModule	getAlarmModule()
BTsHandler	getBTsHandler()
KernelDatabaseAccessorI	getKernelDatabaseAccessor()
KernelDatabaseSaverI	getKernelDatabaseSaver()
org.apache.log4j.Logger	getLogger()
SchemaI	getSchema()
java.util.Date	getStartingDateForChecks()
Benutzer	getUser() Returns the system user that this AlarmHandler is supposed to use/represent.
boolean	handleBT(BT bt)
boolean	isHandleSyncEvents()
static void	markTXAsToBeIgnored(Transaction tx) Marks the given transaction (and via this the BT created from it) as to be ignored by the alarm system to avoid otherwise possible endless loops.
abstract void	retrigger(AlarmAusloesung aa, ErrorCollector ec) Performs the triggering actions defined by the given AlarmAusloesung again, as if the respective Alarm had just been triggered in the regular way.
void	setAlarme(java.util.Map<java.lang.Long,Alarm> $47)
void	setAlarmModule(AlarmModule $49)
void	setBTsHandler(BTsHandler $50)
void	setHandleSyncEvents(boolean $48)

Methods inherited from class java.lang.Object

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

Method Detail

getLogger

public org.apache.log4j.Logger getLogger()

Specified by:

getLogger in interface BTHandlerI

getKernelDatabaseAccessor

public KernelDatabaseAccessorI getKernelDatabaseAccessor()

getKernelDatabaseSaver

public KernelDatabaseSaverI getKernelDatabaseSaver()

getStartingDateForChecks

public java.util.Date getStartingDateForChecks()

Specified by:

getStartingDateForChecks in interface BTHandlerI

getAlarmClass

public abstract java.lang.Class getAlarmClass()

Determines the specific subclass of Alarm for which this AlarmHandler is responsible.

Returns:

the specific subclass of Alarm that this handler is responsible for.

deactivateAlarmDueToErrors

public void deactivateAlarmDueToErrors(Alarm alarm,
                                       java.lang.Exception ex,
                                       java.lang.String msg)

Sets the given alarm to "deactivated" and stores the given error info with it.

Parameters:

alarm - the Alarm to deactivate

ex - the Exception that occurred

msg - the message to set as "last error" on the alarm

logger - FIXME if given logs message

deactivateAlarmDueToErrors

public void deactivateAlarmDueToErrors(Alarm alarm,
                                       java.lang.Exception ex,
                                       java.lang.String msg,
                                       org.apache.log4j.Logger logger)

markTXAsToBeIgnored

public static void markTXAsToBeIgnored(Transaction tx)

Marks the given transaction (and via this the BT created from it) as to be ignored by the alarm system to avoid otherwise possible endless loops.

getAlarmeIterator

public java.util.Iterator getAlarmeIterator()

handleBT

public boolean handleBT(BT bt)
                 throws java.lang.InterruptedException

Specified by:

handleBT in interface BTHandlerI

Throws:

java.lang.InterruptedException

addClassesOfInterest

public void addClassesOfInterest(java.util.Set<java.lang.Class> classesOfInterest)

Adds to the given Set all classes that this handler must monitor for changes. Such classes include the Alarm subclass this handler is responsible for, other associated classes that are relevant for the functionality of those Alarms and in some cases BO classes this handler monitors as part of the alarm subtypes actual functionality.

Specified by:

addClassesOfInterest in interface BTHandlerI

Parameters:

set - the Set the relevant classes should be added to

retrigger

public abstract void retrigger(AlarmAusloesung aa,
                               ErrorCollector ec)

Performs the triggering actions defined by the given AlarmAusloesung again, as if the respective Alarm had just been triggered in the regular way. Intended for manual maintenance/repair for cases where some problem occurred in the original triggering.

getUser

public Benutzer getUser()

Returns the system user that this AlarmHandler is supposed to use/represent.

getSchema

public SchemaI getSchema()

getAlarme

public java.util.Map<java.lang.Long,Alarm> getAlarme()

Basically a simple data holder for the plethora of values that need to be passed around in the course of an alarm triggering.

setAlarme

public void setAlarme(java.util.Map<java.lang.Long,Alarm> $47)

isHandleSyncEvents

public boolean isHandleSyncEvents()

setHandleSyncEvents

public void setHandleSyncEvents(boolean $48)

getAlarmModule

public AlarmModule getAlarmModule()

setAlarmModule

public void setAlarmModule(AlarmModule $49)

getBTsHandler

public BTsHandler getBTsHandler()

setBTsHandler

public void setBTsHandler(BTsHandler $50)