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

Class AccountStatusNotificationHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg>

org.forgerock.opendj.server.config.meta.AccountStatusNotificationHandlerCfgDefn

public final class AccountStatusNotificationHandlerCfgDefn
extends ManagedObjectDefinition<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg>

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

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
AccountStatusNotificationHandlerCfgClient	createClientConfiguration(ManagedObject<? extends AccountStatusNotificationHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
AccountStatusNotificationHandlerCfg	createServerConfiguration(ServerManagedObject<? extends AccountStatusNotificationHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static AccountStatusNotificationHandlerCfgDefn	getInstance()	Get the Account Status Notification Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<AccountStatusNotificationHandlerCfg>	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, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, 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 AccountStatusNotificationHandlerCfgDefn getInstance()

Get the Account Status Notification Handler configuration definition singleton.

Returns:

Returns the Account Status Notification Handler configuration definition singleton.

createClientConfiguration

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

Description copied from class: ManagedObjectDefinition

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<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<AccountStatusNotificationHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<AccountStatusNotificationHandlerCfgClient,AccountStatusNotificationHandlerCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

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

Returns:

Returns the "java-class" property definition.