Package org.forgerock.opendj.server.config.meta

Class ErrorLogAccountStatusNotificationHandlerCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<ErrorLogAccountStatusNotificationHandlerCfgClient,ErrorLogAccountStatusNotificationHandlerCfg>

org.forgerock.opendj.server.config.meta.ErrorLogAccountStatusNotificationHandlerCfgDefn

public final class ErrorLogAccountStatusNotificationHandlerCfgDefn
extends ManagedObjectDefinition<ErrorLogAccountStatusNotificationHandlerCfgClient,ErrorLogAccountStatusNotificationHandlerCfg>

An interface for querying the Error Log Account Status Notification Handler managed object definition meta information.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType	Defines the set of permissable values for the "account-status-notification-type" property.

Method Summary

Modifier and Type	Method	Description
ErrorLogAccountStatusNotificationHandlerCfgClient	createClientConfiguration(ManagedObject<? extends ErrorLogAccountStatusNotificationHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
ErrorLogAccountStatusNotificationHandlerCfg	createServerConfiguration(ServerManagedObject<? extends ErrorLogAccountStatusNotificationHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
EnumPropertyDefinition<ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType>	getAccountStatusNotificationTypePropertyDefinition()	Get the "account-status-notification-type" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static ErrorLogAccountStatusNotificationHandlerCfgDefn	getInstance()	Get the Error Log Account Status Notification Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<ErrorLogAccountStatusNotificationHandlerCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static ErrorLogAccountStatusNotificationHandlerCfgDefn getInstance()

Get the Error Log Account Status Notification Handler configuration definition singleton.

Returns:

Returns the Error Log Account Status Notification Handler configuration definition singleton.

createClientConfiguration

public ErrorLogAccountStatusNotificationHandlerCfgClient createClientConfiguration(ManagedObject<? extends ErrorLogAccountStatusNotificationHandlerCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<ErrorLogAccountStatusNotificationHandlerCfgClient,ErrorLogAccountStatusNotificationHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public ErrorLogAccountStatusNotificationHandlerCfg createServerConfiguration(ServerManagedObject<? extends ErrorLogAccountStatusNotificationHandlerCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ErrorLogAccountStatusNotificationHandlerCfgClient,ErrorLogAccountStatusNotificationHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<ErrorLogAccountStatusNotificationHandlerCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ErrorLogAccountStatusNotificationHandlerCfgClient,ErrorLogAccountStatusNotificationHandlerCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAccountStatusNotificationTypePropertyDefinition

public EnumPropertyDefinition<ErrorLogAccountStatusNotificationHandlerCfgDefn.AccountStatusNotificationType> getAccountStatusNotificationTypePropertyDefinition()

Get the "account-status-notification-type" property definition.

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

Returns:

Returns the "account-status-notification-type" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Error Log Account Status Notification Handler is enabled. Only enabled handlers are invoked whenever a related event occurs in the server.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.