de.ipcon.db.module

Class ListeningKernelModule

java.lang.Object

de.ipcon.db.module.KernelModule

de.ipcon.db.module.ListeningKernelModule

All Implemented Interfaces:

DatabaseConnectionProviderI, KernelDatabaseAccessorI, KernelDatabaseSaverI, ConfChangeEventListenerI, DBManEventListenerI, FeatureListenerI, java.util.concurrent.ThreadFactory

Direct Known Subclasses:

AlarmModule, CompassFTSModule, NotificationModule

public abstract class ListeningKernelModule
extends KernelModule
implements ConfChangeEventListenerI, DBManEventListenerI, FeatureListenerI, java.util.concurrent.ThreadFactory

Abstract KernelModule subclass that listens for DBManEvents and reacts on them.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log

Fields inherited from class de.ipcon.db.module.KernelModule

STR_IF_POSSIBLE, STR_MANDATORY, STR_NEVER

Fields inherited from interface de.ipcon.db.core.KernelDatabaseSaverI

SAVE_RETRIES, SAVE_RETRY_DELAY_MS_MAX, SAVE_RETRY_DELAY_MS_MIN

Constructor Summary

Constructors

Constructor and Description
ListeningKernelModule(java.lang.String _nameForLog, DBManLocalI dbm)
ListeningKernelModule(java.lang.String _nameForLog, DBManLocalI dbm, DBManEventFilter _eventFilter)
ListeningKernelModule(java.lang.String _nameForLog, DBManLocalI dbm, DBManEventFilter _eventFilter, java.lang.String _dependsOnFeature)
ListeningKernelModule(java.lang.String _nameForLog, DBManLocalI dbm, DBManEventFilter _eventFilter, java.lang.String _dependsOnFeature, boolean _onlyOnAuthoritativeServer)

Method Summary

Modifier and Type	Method and Description
int	decrementPending()
void	featureBecameAvailable(java.lang.String feature) Called when a feature just became available (that is a LicenseI was newly imported, the starting date of its validity period arrived, or whatever).
void	featureNoLongerAvailable(java.lang.String feature) Blocks the calling Thread until the module is fully started/active.
java.util.concurrent.atomic.AtomicInteger	getCPending()
DBManEventFilter	getEventFilter()
java.lang.String	getNameForLog() Thread implementation containing the standard code to be executed for starting the module.
int	getPendingShowLimit()
abstract java.lang.String	getShouldStartSetting(DBManConfigurationHelperI conf) Retrieves and returns if this module should actually be started from the MyTISM configuration.
int	incrementPending()
void	initialize() Initialization of the module; called only once during DBMan startup.
boolean	isActive()
boolean	isMandatory() Convenience method that tells if this module is required for this MyTISM instance, according to the configuration.
boolean	isOrWillBeInactive() Returns true if this module is either already inactive or already stopping (to become inactive).
boolean	isWanted() Convenience method that tells if this module should be started according to the configuration of this MyTISM instance.
java.lang.Thread	newThread(java.lang.Runnable r) Creates daemon threads for the executor (boy, that really *does* sound sinister... ;-)
void	processConfChangeEvent(ConfChangeEvent e) Called when the MyTISM configuration was changed and if the setting for this module was modified either starts it up or stops it depending on the new setting.
void	processDBManEvent(DBManEvent event) Schedules handling of the received DBManEvent in a parallel thread.
void	setActive(boolean $10)
void	setCPending(java.util.concurrent.atomic.AtomicInteger $8)
void	setEventFilter(DBManEventFilter $7)
void	setNameForLog(java.lang.String $6)
void	setPendingShowLimit(int $9)
void	shutdown(java.util.concurrent.CountDownLatch latch, int shutdownWaitTimeoutInSecs)
void	start() Actually starts this module, if it was not already started.
void	start(boolean duringStartup)
void	stop() Stops/deactivates this module, if it was started/is active.
void	stop(java.util.concurrent.CountDownLatch latch)
void	stop(java.util.concurrent.CountDownLatch latch, int waitTimeoutInSecs)

Methods inherited from class de.ipcon.db.module.KernelModule

getBOLoader, getConfiguration, getConnection, getDbm, getJDBCConnection, getNewCachingBOLoader, getNodeNumber, getSchema, getUser, isAuthoritativeSyncServer, isShutdown, loadBO, loadBO, query, query, query, query, query, query, query, query, query, query, runsAsUser, save, save, save, save, save, save, save, save, save, save, save, save, setDbm, setShutdown, setUser, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.core.KernelDatabaseSaverI

handleSaveResultForRetry

Methods inherited from interface de.ipcon.db.core.DatabaseConnectionProviderI

wantsConnectionsClosed

Field Detail

log

public static final org.apache.log4j.Logger log

Constructor Detail

ListeningKernelModule

public ListeningKernelModule(java.lang.String _nameForLog,
                             DBManLocalI dbm)

Parameters:

_nameForLog - FIXME

dbm - the DBManLocalI instance this module belongs to

_eventFilter - if a DBManEventFilter is given (not null) the module will only react on events that match that filter

_dependsOnFeature - FIXME

_onlyOnAuthoritativeServer - Basically if given as true it means that the module is actually started and doing something, while if given as false it is not started and... FIXME! TT 2024-12-04: ...basically just sits there and does nothing :-/ This flag is used by the AlarmModule only and has the effect that on sync nodes the alarm system will do a bit of initialization work and then just hang around doing nothing at all but occupying (a bit of) memory.

ListeningKernelModule

public ListeningKernelModule(java.lang.String _nameForLog,
                             DBManLocalI dbm,
                             DBManEventFilter _eventFilter)

ListeningKernelModule

public ListeningKernelModule(java.lang.String _nameForLog,
                             DBManLocalI dbm,
                             DBManEventFilter _eventFilter,
                             java.lang.String _dependsOnFeature)

ListeningKernelModule

public ListeningKernelModule(java.lang.String _nameForLog,
                             DBManLocalI dbm,
                             DBManEventFilter _eventFilter,
                             java.lang.String _dependsOnFeature,
                             boolean _onlyOnAuthoritativeServer)

Method Detail

getShouldStartSetting

public abstract java.lang.String getShouldStartSetting(DBManConfigurationHelperI conf)

Retrieves and returns if this module should actually be started from the MyTISM configuration.

Returns:

one of STR_NEVER, STR_IF_POSSIBLE or STR_MANDATORY

isWanted

public boolean isWanted()

Convenience method that tells if this module should be started according to the configuration of this MyTISM instance.

isMandatory

public boolean isMandatory()

Convenience method that tells if this module is required for this MyTISM instance, according to the configuration.

initialize

public void initialize()

Initialization of the module; called only once during DBMan startup. Runs synchronously, therefore care should be taken that it does not run for too long. FIXME TT 2024-12-11: As the main work is being done in a spawned thread the above is not so relevant any more.

isOrWillBeInactive

public boolean isOrWillBeInactive()

Returns true if this module is either already inactive or already stopping (to become inactive). Used internally for coordination between the start/stop methods.

Returns:

true if this module not isActive() or a stop thread exists; false if neither is the case

processConfChangeEvent

public void processConfChangeEvent(ConfChangeEvent e)

Called when the MyTISM configuration was changed and if the setting for this module was modified either starts it up or stops it depending on the new setting.

Specified by:

processConfChangeEvent in interface ConfChangeEventListenerI

Parameters:

e - The ConfChangeEvent object containing details of the configuration change.

shutdown

public void shutdown(java.util.concurrent.CountDownLatch latch,
                     int shutdownWaitTimeoutInSecs)

featureBecameAvailable

public void featureBecameAvailable(java.lang.String feature)

Description copied from interface: FeatureListenerI

Called when a feature just became available (that is a LicenseI was newly imported, the starting date of its validity period arrived, or whatever). Use AbstractFeatureManager.getFeatureDefinition( _feature ) to retrieve more info about the feature.

Specified by:

featureBecameAvailable in interface FeatureListenerI

start

public void start()

Actually starts this module, if it was not already started. Starting up is done in a new Thread.

Parameters:

duringStartup - if true the method was called during server startup; if false the method was called (again) when the module was started up otherwise, for example because the required feature became available

start

public void start(boolean duringStartup)

featureNoLongerAvailable

public void featureNoLongerAvailable(java.lang.String feature)

Blocks the calling Thread until the module is fully started/active. Waits at most a given number of milliseconds for the start/activation thread to die. A timeout of 0 (the default) means to wait forever.

Specified by:

featureNoLongerAvailable in interface FeatureListenerI

Parameters:

delayInMS - the given number of milliseconds to wait for the start/activation thread to die. A timeout of 0 (the default) means to wait forever

stop

public void stop()

Stops/deactivates this module, if it was started/is active. Starts a separate Thread that performs the actual stopping asynchronously.

Parameters:

latch - a CountDownLatch which is provided and used by the DBMan in case of server shutdown to monitor module shutdown; if null (the default) it means this method was not called during shutdown

waitTimeoutInSecs - time in seconds the DBMan will wait at most for this module to perform its shutdown; if < 0 (the default) it means this method was not called during shutdown but otherwise and a default value (60 seconds currently) will be used

stop

public void stop(java.util.concurrent.CountDownLatch latch)

stop

public void stop(java.util.concurrent.CountDownLatch latch,
                 int waitTimeoutInSecs)

processDBManEvent

public void processDBManEvent(DBManEvent event)

Schedules handling of the received DBManEvent in a parallel thread.

Specified by:

processDBManEvent in interface DBManEventListenerI

Parameters:

event - the event that came from the server

newThread

public java.lang.Thread newThread(java.lang.Runnable r)

Creates daemon threads for the executor (boy, that really *does* sound sinister... ;-)

Specified by:

newThread in interface java.util.concurrent.ThreadFactory

incrementPending

public int incrementPending()

decrementPending

public int decrementPending()

getNameForLog

public java.lang.String getNameForLog()

Thread implementation containing the standard code to be executed for starting the module. Should not need to be subclassed, subclasses of ListeningKernelModule should overwrite ListeningKernelModule#doStart() and/or ListeningKernelModule#doStartAfterListening().

setNameForLog

public void setNameForLog(java.lang.String $6)

getEventFilter

public DBManEventFilter getEventFilter()

setEventFilter

public void setEventFilter(DBManEventFilter $7)

getCPending

public java.util.concurrent.atomic.AtomicInteger getCPending()

setCPending

public void setCPending(java.util.concurrent.atomic.AtomicInteger $8)

getPendingShowLimit

public int getPendingShowLimit()

setPendingShowLimit

public void setPendingShowLimit(int $9)

isActive

public boolean isActive()

setActive

public void setActive(boolean $10)