Package org.forgerock.opendj.server.config.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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends AccountStatusNotificationHandlerCfgClient,? extends AccountStatusNotificationHandlerCfg>	definition()	Get the configuration definition associated with this Account Status Notification Handler.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.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

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

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:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.