Interface AccountStatusNotificationHandlerCfg
-
- All Superinterfaces:
Configuration
- All Known Subinterfaces:
ErrorLogAccountStatusNotificationHandlerCfg
,SmtpAccountStatusNotificationHandlerCfg
public interface AccountStatusNotificationHandlerCfg extends Configuration
A server-side interface for querying Account Status Notification Handler settings.Account Status Notification Handlers are invoked to provide notification to users in some form (for example, by an email message) when the status of a user's account has changed in some way. The Account Status Notification Handler can be used to notify the user and/or administrators of the change.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener)
Register to be notified when this Account Status Notification Handler is changed.Class<? extends AccountStatusNotificationHandlerCfg>
configurationClass()
Gets the configuration class associated with this Account Status Notification Handler.String
getJavaClass()
Gets the "java-class" property.boolean
isEnabled()
Gets the "enabled" property.void
removeChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener)
Deregister an existing Account Status Notification Handler configuration change listener.-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
-
-
-
Method Detail
-
configurationClass
Class<? extends AccountStatusNotificationHandlerCfg> configurationClass()
Gets the configuration class associated with this Account Status Notification Handler.- Specified by:
configurationClass
in interfaceConfiguration
- Returns:
- Returns the configuration class associated with this Account Status Notification Handler.
-
addChangeListener
void addChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener)
Register to be notified when this Account Status Notification Handler is changed.- Parameters:
listener
- The Account Status Notification Handler configuration change listener.
-
removeChangeListener
void removeChangeListener(ConfigurationChangeListener<AccountStatusNotificationHandlerCfg> listener)
Deregister an existing Account Status Notification Handler configuration change listener.- Parameters:
listener
- The Account Status Notification Handler configuration change listener.
-
isEnabled
boolean isEnabled()
Gets the "enabled" property.Indicates whether the Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.
- Returns:
- Returns the value of the "enabled" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the Account Status Notification Handler implementation.
- Returns:
- Returns the value of the "java-class" property.
-
-