com.iplanet.am.sdk.ldap

Class EmailNotificationHelper

java.lang.Object

com.iplanet.am.sdk.ldap.EmailNotificationHelper

public class EmailNotificationHelper
extends Object

This class has the functionality to send email notifications to the users listed in the notification list for create, delete & modify

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINISTRATION_SERVICE
static String	EMAIL_ATTRIBUTE
static String	USER_CREATE_NOTIFICATION_LIST
static String	USER_DELETE_NOTIFICATION_LIST
static String	USER_MODIFY_NOTIFICATION_LIST

Constructor Summary

Constructors

Constructor and Description
EmailNotificationHelper(String userDN)

Method Summary

Modifier and Type	Method and Description
protected Set	getOrgTypeAttributes(AMOrganization org, String serviceName, String attrName) Protected method to be used to obtain organization attribute values for a given serviceName and attribute name.
boolean	isPresentUserCreateNotificationList()
boolean	isPresentUserDeleteNotificationList()
boolean	isPresentUserModifyNotificationList()
void	sendUserCreateNotification(Map attributes) The proper setUser<>NotificationList method should be called before calling this method.
void	sendUserDeleteNotification(Map attributes) The proper setUser<>NotificationList method should be called before calling this method.
void	sendUserModifyNotification(SSOToken token, Map attributes, Map oldAttributes) The proper setUser<>NotificationList method should be called before calling this method.
void	setUserCreateNotificationList()
void	setUserDeleteNotificationList()
void	setUserModifyNotificationList()

Methods inherited from class java.lang.Object

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

Field Detail

ADMINISTRATION_SERVICE

public static final String ADMINISTRATION_SERVICE

See Also:

Constant Field Values

USER_CREATE_NOTIFICATION_LIST

public static final String USER_CREATE_NOTIFICATION_LIST

See Also:

Constant Field Values

USER_DELETE_NOTIFICATION_LIST

public static final String USER_DELETE_NOTIFICATION_LIST

See Also:

Constant Field Values

USER_MODIFY_NOTIFICATION_LIST

public static final String USER_MODIFY_NOTIFICATION_LIST

See Also:

Constant Field Values

EMAIL_ATTRIBUTE

public static final String EMAIL_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

EmailNotificationHelper

public EmailNotificationHelper(String userDN)

Method Detail

setUserCreateNotificationList

public void setUserCreateNotificationList()

setUserDeleteNotificationList

public void setUserDeleteNotificationList()

setUserModifyNotificationList

public void setUserModifyNotificationList()

isPresentUserCreateNotificationList

public boolean isPresentUserCreateNotificationList()

isPresentUserDeleteNotificationList

public boolean isPresentUserDeleteNotificationList()

isPresentUserModifyNotificationList

public boolean isPresentUserModifyNotificationList()

sendUserCreateNotification

public void sendUserCreateNotification(Map attributes)

The proper setUser<>NotificationList method should be called before calling this method.

Parameters:

attributes - the attributes of the user

sendUserDeleteNotification

public void sendUserDeleteNotification(Map attributes)

The proper setUser<>NotificationList method should be called before calling this method.

Parameters:

attributes - the attributes of the user

sendUserModifyNotification

public void sendUserModifyNotification(SSOToken token,
                                       Map attributes,
                                       Map oldAttributes)

The proper setUser<>NotificationList method should be called before calling this method.

Parameters:

token - a valid single sign on token

attributes - the attribues of the user

oldAttributes - the previous attributes of the user

getOrgTypeAttributes

protected Set getOrgTypeAttributes(AMOrganization org,
                                   String serviceName,
                                   String attrName)
                            throws SSOException

Protected method to be used to obtain organization attribute values for a given serviceName and attribute name. Returns a null value if a template value or default value for the attribute does not exist.

Throws:

SSOException