|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.AccountStatusNotificationHandler<SMTPAccountStatusNotificationHandlerCfg>
org.opends.server.extensions.SMTPAccountStatusNotificationHandler
public class SMTPAccountStatusNotificationHandler
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:
Constructor Summary | |
---|---|
SMTPAccountStatusNotificationHandler()
Creates a new, uninitialized instance of this account status notification handler. |
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(SMTPAccountStatusNotificationHandlerCfg configuration)
Applies the configuration changes to this change listener. |
void |
handleStatusNotification(AccountStatusNotification notification)
Performs any processing that may be necessary in conjunction with the provided account status notification. |
void |
initializeStatusNotificationHandler(SMTPAccountStatusNotificationHandlerCfg configuration)
Initializes this account status notification handler based on the information in the provided configuration entry. |
boolean |
isConfigurationAcceptable(AccountStatusNotificationHandlerCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this account status notification handler. |
boolean |
isConfigurationChangeAcceptable(SMTPAccountStatusNotificationHandlerCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
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 |
---|
public SMTPAccountStatusNotificationHandler()
Method Detail |
---|
public void initializeStatusNotificationHandler(SMTPAccountStatusNotificationHandlerCfg configuration) throws ConfigException, InitializationException
initializeStatusNotificationHandler
in class AccountStatusNotificationHandler<SMTPAccountStatusNotificationHandlerCfg>
configuration
- The configuration entry that contains the
information to use to initialize this
account status notification handler.
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.public boolean isConfigurationAcceptable(AccountStatusNotificationHandlerCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class AccountStatusNotificationHandler<SMTPAccountStatusNotificationHandlerCfg>
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.
true
if the provided configuration is acceptable
for this account status notification handler, or
false
if not.public void handleStatusNotification(AccountStatusNotification notification)
handleStatusNotification
in class AccountStatusNotificationHandler<SMTPAccountStatusNotificationHandlerCfg>
notification
- The account status notification to be
processed.public boolean isConfigurationChangeAcceptable(SMTPAccountStatusNotificationHandlerCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<SMTPAccountStatusNotificationHandlerCfg>
configuration
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationChange(SMTPAccountStatusNotificationHandlerCfg configuration)
applyConfigurationChange
in interface ConfigurationChangeListener<SMTPAccountStatusNotificationHandlerCfg>
configuration
- The new configuration containing the changes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |