org.opends.server.admin.std.client
Interface AccountStatusNotificationHandlerCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
ErrorLogAccountStatusNotificationHandlerCfgClient, SMTPAccountStatusNotificationHandlerCfgClient

public interface AccountStatusNotificationHandlerCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends AccountStatusNotificationHandlerCfgClient,? extends AccountStatusNotificationHandlerCfg> definition()
          Get the configuration definition associated with this Account Status Notification Handler.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends AccountStatusNotificationHandlerCfgClient,? extends AccountStatusNotificationHandlerCfg> definition()
Get the configuration definition associated with this Account Status Notification Handler.

Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Account Status Notification Handler.

isEnabled

java.lang.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.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "enabled" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.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.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Account Status Notification Handler implementation.

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.