com.netegrity.imapi
Class NotificationRuleAdapter

java.lang.Object
  LifeCycleImpl
      com.netegrity.imapi.NotificationRuleAdapter

All Implemented Interfaces:

LifeCycle, Logger

public abstract class NotificationRuleAdapter
extends LifeCycleImpl
implements LifeCycle, Logger

The base class for custom notification rules. All notification rules must extend this class. Identity Manager executes a notification rule by calling the evaluate() method in this class.

A notification rule determines the list of recipients for an email notification that is generated from an Identity Manager email template.

Possible sources of email addresses for an email's recipients:

• The attributes of the recipient's User managed object.
• A third-party data source.

Identity Manager calls a notification rule after receiving a getNotifiers() call from an email template. The getNotifiers() method specifies the notification rule that Identity Manager should call, and optionally, one or more name/value pairs of user-defined data that is specified in the template. Identity Manager passes this information into evaluate() when it invokes the specified notification rule.

For information about Identity Manager email templates, see the CA Identity Manager Operations Guide.

Since:

IdentityMinder 5.6

Constructor Summary

NotificationRuleAdapter()

Method Summary

abstract java.util.Vector

evaluate(NotificationRuleContext notificationRuleContext, java.util.Hashtable templateParams) Determines the notification list for an email template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netegrity.imapi.LifeCycle

init, init, shutdown, startup, uninit

Methods inherited from interface com.netegrity.imapi.Logger

logDebugMessage, logErrorMessage, logInfoMessage, logWarningMessage

Constructor Detail

NotificationRuleAdapter

public NotificationRuleAdapter()

Method Detail

evaluate

public abstract java.util.Vector evaluate(NotificationRuleContext notificationRuleContext,
                                          java.util.Hashtable templateParams)

Determines the notification list for an email template.

Parameters:

notificationRuleContext - Notification rule context information that Identity Manager passes into the method.

templateParams - Any name/value pairs of user-defined data that may be specified in the email template.

Returns:

The email addresses to be sent the email notification.