de.ipcon.db.notification

Class StatusNotificationHelper

java.lang.Object

de.ipcon.db.notification.StatusNotificationHelper

public class StatusNotificationHelper
extends java.lang.Object

FIXME Helps send status notifications.

Constructor Summary

Constructors

Constructor and Description
StatusNotificationHelper(org.apache.log4j.Logger log, NotifiableI sender, NotifiableI receiver, java.lang.String culprit, java.lang.String statusSectionTitle)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getTextForStatusNotification(java.lang.String culprit, java.lang.String msg, java.lang.String statusSectionTitle, java.lang.String statusDetails, java.lang.Throwable t) Convenience helper method that gets the full message body text for a generic "status notification" mail to be used for services and similar things where some admin etc. should be informed.
java.lang.String	getTextForStatusNotification(java.lang.String msg, java.lang.String statusDetails, java.lang.Throwable t)
void	sendFailureNotification(Transaction tx, java.lang.String msg, java.lang.String statusDetails, java.lang.Throwable t) Sends out (by creating a notification order) a status notification about a problem/failure.
void	sendRecoveryNotification(Transaction tx, java.lang.String msg, java.lang.String statusDetails) Sends out (by creating a notification order) a status notification about a recovery from a problem/failure.
void	sendStatusNotification(Transaction tx, java.lang.String subject, java.lang.String msg, java.lang.String statusDetails, java.lang.Throwable t) Sends out (by creating a notification order) a status notification with the given subject and a message text which is created from the other info.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusNotificationHelper

public StatusNotificationHelper(org.apache.log4j.Logger log,
                                NotifiableI sender,
                                NotifiableI receiver,
                                java.lang.String culprit,
                                java.lang.String statusSectionTitle)

Method Detail

sendFailureNotification

public void sendFailureNotification(Transaction tx,
                                    java.lang.String msg,
                                    java.lang.String statusDetails,
                                    java.lang.Throwable t)

Sends out (by creating a notification order) a status notification about a problem/failure.

Parameters:

tx - the Transaction to create the notification order in

msg - some custom message text; if null or empty a default placeholder will be used

statusDetails - some text that will describe what the actual status is; might be some error response from an external API or whatever; if null or empty the "status info" section will be omitted

t - a Throwable which might be available if this notification is about a problem

sendRecoveryNotification

public void sendRecoveryNotification(Transaction tx,
                                     java.lang.String msg,
                                     java.lang.String statusDetails)

Sends out (by creating a notification order) a status notification about a recovery from a problem/failure.

Parameters:

tx - the Transaction to create the notification order in

msg - some custom message text; if null or empty a default placeholder will be used

statusDetails - some text that will describe what the actual status is; might be some error response from an external API or whatever; if null or empty the "status info" section will be omitted

sendStatusNotification

public void sendStatusNotification(Transaction tx,
                                   java.lang.String subject,
                                   java.lang.String msg,
                                   java.lang.String statusDetails,
                                   java.lang.Throwable t)

Sends out (by creating a notification order) a status notification with the given subject and a message text which is created from the other info.

Parameters:

subject - the subject for the notification

msg - some custom message text; if null or empty a default placeholder will be used

statusDetails - some text that will describe what the actual status is; might be some error response from an external API or whatever; if null or empty the "status info" section will be omitted

t - a Throwable which might be available if this notification is about a problem

getTextForStatusNotification

public java.lang.String getTextForStatusNotification(java.lang.String msg,
                                                     java.lang.String statusDetails,
                                                     java.lang.Throwable t)

getTextForStatusNotification

public static java.lang.String getTextForStatusNotification(java.lang.String culprit,
                                                            java.lang.String msg,
                                                            java.lang.String statusSectionTitle,
                                                            java.lang.String statusDetails,
                                                            java.lang.Throwable t)

Convenience helper method that gets the full message body text for a generic "status notification" mail to be used for services and similar things where some admin etc. should be informed.

Will look something like:

 From <originDesc>:

 Something happened which is described here in some detail blablabla...

 === Exception info: ===
 SomeException: Exception message
    at some.stack.trace(123)
    at some.other.stack.trace(456)

 === <statusTitle>: ===
 Computer says "no"
 

Parameters:

culprit - some name or description from what the notification is coming from

msg - some custom message text; if null or empty a default placeholder will be used

statusSectionTitle - a possible custom header title for the "status info section" of the notification; if null or empty will use a default

statusDetails - some text that will describe what the actual status is; might be some error response from an external API or whatever; if null or empty the "status info" section will be omitted

t - an exception which might have occurred in the service or whatever; may be null, in that case the body text will not include the "exception info section"

Returns:

the full body text to be used in the status notification