org.opends.server.extensions

Class SMTPAccountStatusNotificationHandler

java.lang.Object

org.opends.server.api.AccountStatusNotificationHandler<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

org.opends.server.extensions.SMTPAccountStatusNotificationHandler

All Implemented Interfaces:

org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

public class SMTPAccountStatusNotificationHandler
extends AccountStatusNotificationHandler<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>
implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

This class provides an implementation of an account status notification handler that can send e-mail messages via SMTP to end users and/or administrators whenever an account status notification occurs. The e-mail messages will be generated from template files, which contain the information to use to create the message body. The template files may contain plain text, in addition to the following tokens:

• %%notification-type%% -- Will be replaced with the name of the account status notification type for the notification.
• %%notification-message%% -- Will be replaced with the message for the account status notification.
• %%notification-user-dn%% -- Will be replaced with the string representation of the DN for the user that is the target of the account status notification.
• %%notification-user-attr:attrname%% -- Will be replaced with the value of the attribute specified by attrname from the user's entry. If the specified attribute has multiple values, then the first value encountered will be used. If the specified attribute does not have any values, then it will be replaced with an emtpy string.
• %%notification-property:propname%% -- Will be replaced with the value of the specified notification property from the account status notification. If the specified property has multiple values, then the first value encountered will be used. If the specified property does not have any values, then it will be replaced with an emtpy string.

Constructor Summary

Constructors

Constructor and Description
SMTPAccountStatusNotificationHandler() Creates a new, uninitialized instance of this account status notification handler.

Method Summary

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg configuration)
void	handleStatusNotification(AccountStatusNotification notification) Performs any processing that may be necessary in conjunction with the provided account status notification.
void	initializeStatusNotificationHandler(org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg configuration) Initializes this account status notification handler based on the information in the provided configuration entry.
boolean	isConfigurationAcceptable(org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this account status notification handler.
boolean	isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Methods inherited from class org.opends.server.api.AccountStatusNotificationHandler

finalizeStatusNotificationHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

SMTPAccountStatusNotificationHandler

public SMTPAccountStatusNotificationHandler()

Creates a new, uninitialized instance of this account status notification handler.

Method Detail

initializeStatusNotificationHandler

public void initializeStatusNotificationHandler(org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg configuration)
                                         throws org.forgerock.opendj.config.server.ConfigException,
                                                InitializationException

Description copied from class: AccountStatusNotificationHandler

Initializes this account status notification handler based on the information in the provided configuration entry.

Specified by:

initializeStatusNotificationHandler in class AccountStatusNotificationHandler<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

Parameters:

configuration - The configuration entry that contains the information to use to initialize this account status notification handler.

Throws:

org.forgerock.opendj.config.server.ConfigException - If the provided entry does not contain a valid configuration for this account status notification handler.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfg configuration,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Description copied from class: AccountStatusNotificationHandler

Indicates whether the provided configuration is acceptable for this account status notification handler. It should be possible to call this method on an uninitialized account status notification handler instance in order to determine whether the handler would be able to use the provided configuration.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Overrides:

isConfigurationAcceptable in class AccountStatusNotificationHandler<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

Parameters:

configuration - The account status notification handler configuration for which to make the determination.

unacceptableReasons - A list that may be used to hold the reasons that the provided configuration is not acceptable.

Returns:

true if the provided configuration is acceptable for this account status notification handler, or false if not.

handleStatusNotification

public void handleStatusNotification(AccountStatusNotification notification)

Description copied from class: AccountStatusNotificationHandler

Performs any processing that may be necessary in conjunction with the provided account status notification.

Specified by:

handleStatusNotification in class AccountStatusNotificationHandler<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

Parameters:

notification - The account status notification to be processed.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg configuration,
                                               List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)

Specified by:

isConfigurationChangeAcceptable in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg configuration)

Specified by:

applyConfigurationChange in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.SMTPAccountStatusNotificationHandlerCfg>