@PublicAPI(stability=PRIVATE)

Package org.opends.server.admin

Common administration classes.

See: Description

Interface Summary

Interface	Description
Configuration	A common base interface for all server managed object configurations.
ConfigurationClient	A common base interface for all managed object configuration clients.
DefaultBehaviorProviderVisitor<T,R,P>	A visitor of default behavior providers, in the style of the visitor design pattern.
DefinitionResolver	This interface is used to determine the "best match" managed object definition in a definition hierarchy.
ManagedObjectPathSerializer	A strategy for serializing managed object paths.
PropertyProvider	An interface which can be used to initialize the contents of a managed object.
RelationDefinitionVisitor<R,P>	A visitor of relation definitions, in the style of the visitor design pattern.

Class Summary

Class	Description
AbsoluteInheritedDefaultBehaviorProvider<T>	A default behavior provider which retrieves default values from a managed object in an absolute location.
AbstractManagedObjectDefinition<C extends ConfigurationClient,S extends Configuration>	Defines the structure of an abstract managed object.
ACIPropertyDefinition	ACI property definition.
ACIPropertyDefinition.Builder	An interface for incrementally constructing ACI property definitions.
AdministrationConnector	This class is a wrapper on top of LDAPConnectionHandler to manage the administration connector, which is an LDAPConnectionHandler with specific (limited) configuration properties.
AdministrationDataSync	Check if information found in "cn=admin data" is coherent with cn=config.
AdministratorAction	Defines an optional action which administators must perform after they have modified a property.
AggregationPropertyDefinition<C extends ConfigurationClient,S extends Configuration>	Aggregation property definition.
AggregationPropertyDefinition.Builder<C extends ConfigurationClient,S extends Configuration>	An interface for incrementally constructing aggregation property definitions.
AliasDefaultBehaviorProvider<T>	A default behavior provider which indicates special behavior.
AttributeTypePropertyDefinition	Attribute type property definition.
AttributeTypePropertyDefinition.Builder	An interface for incrementally constructing attribute type property definitions.
BooleanPropertyDefinition	Boolean property definition.
BooleanPropertyDefinition.Builder	An interface for incrementally constructing boolean property definitions.
ClassLoaderProvider	Manages the class loader which should be used for loading configuration definition classes and associated extensions.
ClassPropertyDefinition	Class property definition.
ClassPropertyDefinition.Builder	An interface for incrementally constructing class property definitions.
Constraint	An interface for enforcing constraints and dependencies between managed objects and their properties.
DefaultBehaviorProvider<T>	An interface for determining the default behavior of a property.
DefaultManagedObject<C extends ConfigurationClient,S extends Configuration>	A default managed object which should be created when a parent managed object is created.
DefaultManagedObject.Builder<C extends ConfigurationClient,S extends Configuration>	An interface for incrementally constructing default managed objects.
DefinedDefaultBehaviorProvider<T>	A default behavior provider which represents a well-defined set of default values.
DNPropertyDefinition	DN property definition.
DNPropertyDefinition.Builder	An interface for incrementally constructing DN property definitions.
DurationPropertyDefinition	Duration property definition.
DurationPropertyDefinition.Builder	An interface for incrementally constructing duration property definitions.
EnumPropertyDefinition<E extends Enum<E>>	Enumeration property definition.
EnumPropertyDefinition.Builder<E extends Enum<E>>	An interface for incrementally constructing enumeration property definitions.
GenericConstraint	A generic constraint which comprises of an underlying condition and a description.
InstantiableRelationDefinition<C extends ConfigurationClient,S extends Configuration>	A managed object composite relationship definition which represents a composition of zero or more managed objects.
InstantiableRelationDefinition.Builder<C extends ConfigurationClient,S extends Configuration>	An interface for incrementally constructing instantiable relation definitions.
IntegerPropertyDefinition	Integer property definition.
IntegerPropertyDefinition.Builder	An interface for incrementally constructing integer property definitions.
IPAddressMaskPropertyDefinition	IP address mask property definition.
IPAddressMaskPropertyDefinition.Builder	An interface for incrementally constructing IP address mask property definitions.
IPAddressPropertyDefinition	IP address property definition.
IPAddressPropertyDefinition.Builder	An interface for incrementally constructing IP address property definitions.
LDAPProfile	This class is used to map configuration elements to their LDAP schema names.
LDAPProfile.Wrapper	LDAP profile wrappers can be used to provide temporary LDAP profile information for components which do not have LDAP profile property files.
ManagedObjectDefinition<C extends ConfigurationClient,S extends Configuration>	Defines the structure of a managed object which can be instantiated.
ManagedObjectDefinitionI18NResource	A class for retrieving internationalized resource properties associated with a managed object definition.
ManagedObjectDefinitionResource	A class for retrieving non-internationalized resource properties associated with a managed object definition.
ManagedObjectPath<C extends ConfigurationClient,S extends Configuration>	A path which can be used to determine the location of a managed object instance.
OptionalRelationDefinition<C extends ConfigurationClient,S extends Configuration>	A managed object composite relationship definition which represents a composition of an optional single managed object (i.e.
OptionalRelationDefinition.Builder<C extends ConfigurationClient,S extends Configuration>	An interface for incrementally constructing optional relation definitions.
PropertyDefinition<T>	An interface for querying generic property definition features.
PropertyDefinition.AbstractBuilder<T,D extends PropertyDefinition<T>>	An interface for incrementally constructing property definitions.
PropertyDefinitionUsageBuilder	A property definition visitor which can be used to generate syntax usage information.
PropertyDefinitionVisitor<R,P>	A visitor of property definitions, in the style of the visitor design pattern.
PropertyValueVisitor<R,P>	A visitor of property values, in the style of the visitor design pattern.
Reference<C extends ConfigurationClient,S extends Configuration>	A reference to another managed object.
RelationDefinition<C extends ConfigurationClient,S extends Configuration>	Relation definitions define relationships between types of managed objects.
RelationDefinition.AbstractBuilder<C extends ConfigurationClient,S extends Configuration,D extends RelationDefinition<C,S>>	An interface for incrementally constructing relation definitions.
RelationDefinition.Common<C extends ConfigurationClient,S extends Configuration>	Opaque structure containing fields common to all relation definition types.
RelativeInheritedDefaultBehaviorProvider<T>	A default behavior provider which retrieves default values from a parent managed object.
SetRelationDefinition<C extends ConfigurationClient,S extends Configuration>	A managed object composite relationship definition which represents a composition of zero or more managed objects each of which must have a different type.
SetRelationDefinition.Builder<C extends ConfigurationClient,S extends Configuration>	An interface for incrementally constructing set relation definitions.
SingletonRelationDefinition<C extends ConfigurationClient,S extends Configuration>	A managed object composite relationship definition which represents a composition of a single managed object (i.e.
SingletonRelationDefinition.Builder<C extends ConfigurationClient,S extends Configuration>	An interface for incrementally constructing singleton relation definitions.
SizePropertyDefinition	Memory size property definition.
SizePropertyDefinition.Builder	An interface for incrementally constructing memory size property definitions.
StringPropertyDefinition	String property definition.
StringPropertyDefinition.Builder	An interface for incrementally constructing string property definitions.
Tag	An interface for querying the properties of a tag.
TopCfgDefn	Configuration definition TopCfgDefn is the root of the configuration definition hierarchy.
UndefinedDefaultBehaviorProvider<T>	A default behavior provider which indicates undefined behavior.

Enum Summary

Enum	Description
AdministratorAction.Type	Specifies the type of administrator action which must be performed in order for pending changes to take effect.
DefinitionDecodingException.Reason	An enumeration defining the reasons why the definition could not be resolved.
ManagedObjectOption	This enumeration contains various options that can be associated with managed object definitions.
PropertyOption	This enumeration contains various options that can be associated with property definitions.
RelationOption	This enumeration contains various options that can be associated with relation definitions.

Exception Summary

Exception	Description
AdminException	Exceptions thrown when interacting with administration framework.
DecodingException	The requested managed object was found but it could not be decoded.
DefinitionDecodingException	The requested managed object was found but its type could not be determined.
ManagedObjectAlreadyExistsException	A managed object could not be created because there is an existing managed object with the same name.
ManagedObjectNotFoundException	The requested managed object could not be located.
OperationsException	Exceptions thrown as a result of errors that occurred when reading, listing, and modifying managed objects.
PropertyException	Exceptions thrown as a result of errors that occurred when decoding and modifying property values.
PropertyNotFoundException	Thrown when an attempt is made to retrieve a property using its name but the name was not recognized.

Package org.opends.server.admin Description

Common administration classes.

This package contains administration related classes and interfaces common to both the client and server.