Package org.forgerock.opendj.server.config.client

Interface ErrorLogAccountStatusNotificationHandlerCfgClient

All Superinterfaces:

AccountStatusNotificationHandlerCfgClient, ConfigurationClient

public interface ErrorLogAccountStatusNotificationHandlerCfgClient
extends AccountStatusNotificationHandlerCfgClient

A client-side interface for reading and modifying Error Log Account Status Notification Handler settings.

The Error Log Account Status Notification Handler is a notification handler that writes information to the server error log whenever an appropriate account status event occurs.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends ErrorLogAccountStatusNotificationHandlerCfgClient,? extends ErrorLogAccountStatusNotificationHandlerCfg>	definition()	Get the configuration definition associated with this Error Log Account Status Notification Handler.
SortedSet<ValueOrExpression<ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType>>	getAccountStatusNotificationType()	Gets the "account-status-notification-type" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setAccountStatusNotificationType(Collection<ValueOrExpression<ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType>> values)	Sets the "account-status-notification-type" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.AccountStatusNotificationHandlerCfgClient

isEnabled, setEnabled

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends ErrorLogAccountStatusNotificationHandlerCfgClient,? extends ErrorLogAccountStatusNotificationHandlerCfg> definition()

Get the configuration definition associated with this Error Log Account Status Notification Handler.

Specified by:

definition in interface AccountStatusNotificationHandlerCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Error Log Account Status Notification Handler.

getAccountStatusNotificationType

@MandatoryProperty
SortedSet<ValueOrExpression<ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType>> getAccountStatusNotificationType()

Gets the "account-status-notification-type" property.

Indicates which types of event can trigger an account status notification.

Returns:

Returns the values of the "account-status-notification-type" property.

setAccountStatusNotificationType

@MandatoryProperty
void setAccountStatusNotificationType(Collection<ValueOrExpression<ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType>> values)
                               throws PropertyException

Sets the "account-status-notification-type" property.

Indicates which types of event can trigger an account status notification.

Parameters:

values - The values of the "account-status-notification-type" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.ErrorLogAccountStatusNotificationHandler

Specified by:

getJavaClass in interface AccountStatusNotificationHandlerCfgClient

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 Error Log Account Status Notification Handler implementation.

Specified by:

setJavaClass in interface AccountStatusNotificationHandlerCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.