de.ipcon.db.notification

Class NotificationModule

java.lang.Object

de.ipcon.db.module.KernelModule

de.ipcon.db.module.ListeningKernelModule

de.ipcon.db.notification.NotificationModule

All Implemented Interfaces:

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

public class NotificationModule
extends ListeningKernelModule
implements BTHandlerI, DBManEventListenerI

This is the main class of the notification system. It is responsible for initializing the handlers for the various "media", checking if new notification orders were created, etc.

Field Summary

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

Fields inherited from interface de.ipcon.db.OriginHashProviderI

ENV_DAWN_MACHINE_ID

Constructor Summary

Constructors

Constructor and Description
NotificationModule(DBManLocalI dbm)
NotificationModule(java.lang.String _nameForLog, DBManLocalI dbm)

Method Summary

Modifier and Type	Method and Description
void	addClassesOfInterest(java.util.Set<java.lang.Class> classesOfInterest)
void	adjustRetryWVActiveState(boolean active)
static Benachrichtigungsversendung[]	createVersendungen(java.util.Collection<AddressWithInfo> addresses, Transaction tx, java.lang.Boolean wasSuccessful, java.lang.String remark, boolean asCatchall, java.lang.Boolean erneutVersuchenMoeglich) Creates, saves and returns Benachrichtigungsversendung instances for the given AddressWithInfo instances and their respective MyTISMBenachrichtigung.
static Benachrichtigungsversendung[]	createVersendungen(java.util.Collection<AddressWithInfo> addresses, Transaction tx, java.lang.Boolean wasSuccessful, java.lang.String remark, boolean asCatchall, java.lang.Boolean erneutVersuchenMoeglich, java.lang.Throwable cause)
static Benachrichtigungsversendung[]	createVersendungen(javax.mail.SendFailedException sfe, java.util.Collection<AddressWithInfo> addresses, Transaction tx, java.lang.String remark, boolean asCatchall, java.lang.Boolean erneutVersuchenMoeglich) Creates, saves and returns Benachrichtigungsversendung instances for the given AddressWithInfo instances and their respective MyTISMBenachrichtigung, using info about success or failure from the given SendFailedException.
static Benachrichtigungsversendung[]	createVersendungen(javax.mail.SendFailedException sfe, java.util.Collection<AddressWithInfo> addresses, Transaction tx, java.lang.String remark, boolean asCatchall, java.lang.Boolean erneutVersuchenMoeglich, java.lang.Throwable cause)
BTsHandler	getBTsHandler()
java.util.ArrayList	getHandlers()
org.apache.log4j.Logger	getLogger()
org.bouncycastle.openpgp.PGPSecretKey	getOpenPGPSecretKey() Executed when a relevant DBManBOChangeEvent is received.
java.lang.String	getShouldStartSetting(DBManConfigurationHelperI conf) Retrieves and returns if this module should actually be started from the MyTISM configuration.
java.util.Date	getStartingDateForChecks()
java.lang.Integer	getWantsEncryption()
java.lang.Integer	getWantsSignature()
boolean	handleBT(BT bt)
void	handleSendingLogChanges(java.util.Collection<Benachrichtigungsversendung> createdSendingLogs, java.lang.String origin) At the end of the day, only changes to Benachrichtigungsversendung instances affect the notification order "done" state; if such changes happened, recalc that state here.
boolean	notifyAddress(MyTISMAdresse address, MyTISMBenachrichtigung notification, Transaction tx, boolean isRetry)
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	retryFailedNotifications(java.lang.Long orderId) Triggers retry of failed notifications for the MyTISMBenachrichtigungsAuftrag with the given Id.
void	setBTsHandler(BTsHandler $110)
void	setOpenPGPSecretKey(org.bouncycastle.openpgp.PGPSecretKey $107)
void	setWantsEncryption(java.lang.Integer $108)
void	setWantsSignature(java.lang.Integer $109)

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

decrementPending, featureBecameAvailable, featureNoLongerAvailable, getCPending, getEventFilter, getNameForLog, getPendingShowLimit, incrementPending, initialize, isActive, isMandatory, isOrWillBeInactive, isWanted, newThread, processDBManEvent, setActive, setCPending, setEventFilter, setNameForLog, setPendingShowLimit, shutdown, start, start, stop, stop, stop

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.event.DBManEventListenerI

processDBManEvent

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

handleSaveResultForRetry

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

wantsConnectionsClosed

Methods inherited from interface de.ipcon.db.OriginHashProviderI

getDawnMachineID, getOriginHash

Constructor Detail

NotificationModule

public NotificationModule(DBManLocalI dbm)

NotificationModule

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

Method Detail

getHandlers

public java.util.ArrayList getHandlers()

getShouldStartSetting

public java.lang.String getShouldStartSetting(DBManConfigurationHelperI conf)

Description copied from class: ListeningKernelModule

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

Specified by:

getShouldStartSetting in class ListeningKernelModule

Returns:

one of STR_NEVER, STR_IF_POSSIBLE or STR_MANDATORY

getLogger

public org.apache.log4j.Logger getLogger()

Specified by:

getLogger in interface BTHandlerI

processConfChangeEvent

public void processConfChangeEvent(ConfChangeEvent e)

Description copied from class: ListeningKernelModule

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

Overrides:

processConfChangeEvent in class ListeningKernelModule

Parameters:

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

adjustRetryWVActiveState

public void adjustRetryWVActiveState(boolean active)

retryFailedNotifications

public void retryFailedNotifications(java.lang.Long orderId)

Triggers retry of failed notifications for the MyTISMBenachrichtigungsAuftrag with the given Id.

notifyAddress

public boolean notifyAddress(MyTISMAdresse address,
                             MyTISMBenachrichtigung notification,
                             Transaction tx,
                             boolean isRetry)
                      throws NoHandlerAvailableException

Throws:

NoHandlerAvailableException

createVersendungen

public static Benachrichtigungsversendung[] createVersendungen(javax.mail.SendFailedException sfe,
                                                               java.util.Collection<AddressWithInfo> addresses,
                                                               Transaction tx,
                                                               java.lang.String remark,
                                                               boolean asCatchall,
                                                               java.lang.Boolean erneutVersuchenMoeglich)

Creates, saves and returns Benachrichtigungsversendung instances for the given AddressWithInfo instances and their respective MyTISMBenachrichtigung, using info about success or failure from the given SendFailedException. This method tries to also handle all internal errors by also creating a Benachrichtigungsversendung with appropriate info.

createVersendungen

public static Benachrichtigungsversendung[] createVersendungen(javax.mail.SendFailedException sfe,
                                                               java.util.Collection<AddressWithInfo> addresses,
                                                               Transaction tx,
                                                               java.lang.String remark,
                                                               boolean asCatchall,
                                                               java.lang.Boolean erneutVersuchenMoeglich,
                                                               java.lang.Throwable cause)

createVersendungen

public static Benachrichtigungsversendung[] createVersendungen(java.util.Collection<AddressWithInfo> addresses,
                                                               Transaction tx,
                                                               java.lang.Boolean wasSuccessful,
                                                               java.lang.String remark,
                                                               boolean asCatchall,
                                                               java.lang.Boolean erneutVersuchenMoeglich)

Creates, saves and returns Benachrichtigungsversendung instances for the given AddressWithInfo instances and their respective MyTISMBenachrichtigung.

createVersendungen

public static Benachrichtigungsversendung[] createVersendungen(java.util.Collection<AddressWithInfo> addresses,
                                                               Transaction tx,
                                                               java.lang.Boolean wasSuccessful,
                                                               java.lang.String remark,
                                                               boolean asCatchall,
                                                               java.lang.Boolean erneutVersuchenMoeglich,
                                                               java.lang.Throwable cause)

handleBT

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

Specified by:

handleBT in interface BTHandlerI

Throws:

java.lang.InterruptedException

handleSendingLogChanges

public void handleSendingLogChanges(java.util.Collection<Benachrichtigungsversendung> createdSendingLogs,
                                    java.lang.String origin)

At the end of the day, only changes to Benachrichtigungsversendung instances affect the notification order "done" state; if such changes happened, recalc that state here.

getStartingDateForChecks

public java.util.Date getStartingDateForChecks()

Specified by:

getStartingDateForChecks in interface BTHandlerI

addClassesOfInterest

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

Specified by:

addClassesOfInterest in interface BTHandlerI

getOpenPGPSecretKey

public org.bouncycastle.openpgp.PGPSecretKey getOpenPGPSecretKey()

Executed when a relevant DBManBOChangeEvent is received.

setOpenPGPSecretKey

public void setOpenPGPSecretKey(org.bouncycastle.openpgp.PGPSecretKey $107)

getWantsEncryption

public java.lang.Integer getWantsEncryption()

setWantsEncryption

public void setWantsEncryption(java.lang.Integer $108)

getWantsSignature

public java.lang.Integer getWantsSignature()

setWantsSignature

public void setWantsSignature(java.lang.Integer $109)

getBTsHandler

public BTsHandler getBTsHandler()

setBTsHandler

public void setBTsHandler(BTsHandler $110)