com.ibm.itim.mail

Class NotificationManager

java.lang.Object

com.ibm.itim.mail.NotificationManager

public class NotificationManager
extends java.lang.Object

Generates messages and delivers them based on a category of notification and the context of the situation causing the notification. The creation of the correct message(s) based on this contextual information is provided by NotificationFactories. Different factories can be registered with the NotificationManager for different events through settings in the enRole.properties file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOTIFY_ASYNC
static java.lang.String	NOTIFY_SYNC

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getNotifyMode() Returns the current notification mode.
static void	notify(java.lang.String notificationCategory, java.lang.Object context) Notifies the correct recipients with the correct message content and format based on the passed notification category and situational context.
static void	notify(java.lang.String notificationCategory, java.lang.Object context, boolean asynch) Notifies the correct recipients with the correct message content and format based on the passed notification category and situational context.

Methods inherited from class java.lang.Object

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

Field Detail

NOTIFY_SYNC

public static final java.lang.String NOTIFY_SYNC

See Also:

Constant Field Values

NOTIFY_ASYNC

public static final java.lang.String NOTIFY_ASYNC

See Also:

Constant Field Values

Method Detail

notify

public static final void notify(java.lang.String notificationCategory,
                                java.lang.Object context)

Notifies the correct recipients with the correct message content and format based on the passed notification category and situational context.

Parameters:

notificationCategory - The category of notification to send.

context - The context of the situation triggering the notification.

notify

public static final void notify(java.lang.String notificationCategory,
                                java.lang.Object context,
                                boolean asynch)
                         throws java.lang.Exception

Notifies the correct recipients with the correct message content and format based on the passed notification category and situational context. Allows caller to override Asynch mail processing

Parameters:

notificationCategory - The category of notification to send.

context - The context of the situation triggering the notification.

asynch - true indicates allow asynch mail processing. false forces synchronus mail processing to occur

Throws:

java.lang.Exception

getNotifyMode

public static final java.lang.String getNotifyMode()

Returns the current notification mode. See the static states: NotificationManager.NOTIFY_SYNC and NotificationManager.NOTIFY_ASYNC This value comes from the enrole.mail.notify property of enrole.properties file. If this value is changed, application server needs to be restarted.

Returns:

the current notification mode.