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

Class JmxAlertHandlerCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<JmxAlertHandlerCfgClient,JmxAlertHandlerCfg>

org.forgerock.opendj.server.config.meta.JmxAlertHandlerCfgDefn

public final class JmxAlertHandlerCfgDefn
extends ManagedObjectDefinition<JmxAlertHandlerCfgClient,JmxAlertHandlerCfg>

An interface for querying the JMX Alert Handler managed object definition meta information.

The JMX Alert Handler is used to generate JMX notifications to alert administrators of significant events that occur within the server.

Method Summary

Modifier and Type	Method	Description
JmxAlertHandlerCfgClient	createClientConfiguration(ManagedObject<? extends JmxAlertHandlerCfgClient> impl)	Creates a client configuration view of the provided managed object.
JmxAlertHandlerCfg	createServerConfiguration(ServerManagedObject<? extends JmxAlertHandlerCfg> impl)	Creates a server configuration view of the provided server managed object.
StringPropertyDefinition	getDisabledAlertTypePropertyDefinition()	Get the "disabled-alert-type" property definition.
StringPropertyDefinition	getEnabledAlertTypePropertyDefinition()	Get the "enabled-alert-type" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static JmxAlertHandlerCfgDefn	getInstance()	Get the JMX Alert Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<JmxAlertHandlerCfg>	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 JmxAlertHandlerCfgDefn getInstance()

Get the JMX Alert Handler configuration definition singleton.

Returns:

Returns the JMX Alert Handler configuration definition singleton.

createClientConfiguration

public JmxAlertHandlerCfgClient createClientConfiguration(ManagedObject<? extends JmxAlertHandlerCfgClient> 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<JmxAlertHandlerCfgClient,JmxAlertHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<JmxAlertHandlerCfgClient,JmxAlertHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<JmxAlertHandlerCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<JmxAlertHandlerCfgClient,JmxAlertHandlerCfg>

Returns:

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

getDisabledAlertTypePropertyDefinition

public StringPropertyDefinition getDisabledAlertTypePropertyDefinition()

Get the "disabled-alert-type" property definition.

Specifies the names of the alert types that are disabled for this alert handler.

If there are any values for this attribute, then no alerts with any of the specified types are allowed. If there are no values for this attribute, then only alerts with a type included in the set of enabled alert types are allowed, or if there are no values for the enabled alert types option, then all alert types are allowed.

Returns:

Returns the "disabled-alert-type" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the JMX Alert Handler is enabled.

Returns:

Returns the "enabled" property definition.

getEnabledAlertTypePropertyDefinition

public StringPropertyDefinition getEnabledAlertTypePropertyDefinition()

Get the "enabled-alert-type" property definition.

Specifies the names of the alert types that are enabled for this alert handler.

If there are any values for this attribute, then only alerts with one of the specified types are allowed (unless they are also included in the disabled alert types). If there are no values for this attribute, then any alert with a type not included in the list of disabled alert types is allowed.

Returns:

Returns the "enabled-alert-type" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the JMX Alert Handler implementation.

Returns:

Returns the "java-class" property definition.