@PublicAPI(stability=VOLATILE)

Package org.opends.server.config

Contains code used to interact with the Directory Server configuration.

See: Description

Class Summary

Class	Description
BooleanConfigAttribute	This class defines a Boolean configuration attribute, which can hold a single Boolean value of true or false.
ConfigAttribute	This class defines a configuration attribute, which can hold zero or more values associated with a configurable property within the Directory Server.
ConfigConstants	This class defines a number of constants used by the Directory Server configuration, including configuration attribute and objectclass names, and attribute options.
ConfigEntry	This class defines a configuration entry, which can hold zero or more attributes that may control the configuration of various components of the Directory Server.
DNConfigAttribute	This class defines a DN configuration attribute, which can hold zero or more DN values.
IntegerConfigAttribute	This class defines an integer configuration attribute, which can hold zero or more integer values.
IntegerWithUnitConfigAttribute	This class defines a configuration attribute that stores both an integer value and an associated unit.
JMXMBean	This class defines a JMX MBean that can be registered with the Directory Server to provide monitoring and statistical information, provide read and/or read-write access to the configuration, and provide notifications and alerts if a significant event or severe/fatal error occurs.
MultiChoiceConfigAttribute	This class defines a multi-choice configuration attribute, which can hold zero or more string values.
ReadOnlyConfigAttribute	This class defines a configuration attribute that is only intended for use in displaying information.
StringConfigAttribute	This class defines a string configuration attribute, which can hold zero or more string values.

Exception Summary

Exception	Description
ConfigException	This class defines an exception that may be thrown during the course of interactions with the Directory Server configuration.

Package org.opends.server.config Description

Contains code used to interact with the Directory Server configuration. This includes various kinds of configuration attributes for different data types, as well as the primary means of exposing configuration and operations over JMX. Further, it includes the code for the default configuration handler which stores information in an LDIF file.

Whenever a configuration entry is modified, assuming that the result of the modification is in conformance with the server schema, then any configurable components and configuration change listeners associated with that entry will be invoked and given an opportunity to reject that update if there is a problem with it, or dynamically react to it by applying the new configuration. If a new configuration entry is added, then any configuration add listeners associated with that entry's parent will be invoked. If an existing entry is removed, then any configuration delete listeners associated with that entry's parent will be invoked.