@PublicAPI(stability=VOLATILE)
Package org.opends.server.types
Contains implementations for a number of Directory Server data types. Most, but not necessarily all, of these data
types may be considered part of the public API for use when extending the Directory Server. Please refer to the
official documentation for authoritative information on what classes are considered part of the public API.
-
Interface Summary Interface Description MemberList<T> Iterator that can be used to iterate over the members of a group.SynchronizationProviderResult This class defines a data structure that holds information about the result of processing by a synchronization provider. -
Class Summary Class Description AbstractVirtualAttribute This class defines a virtual attribute, which is a special kind of attribute whose values do not actually exist in persistent storage but rather are computed or otherwise obtained dynamically.AbstractVirtualAttribute.GeneratorIterator This iterator implements the state management associated with iterators for its subclasses.AccountStatusNotification This class defines a data type for storing information associated with an account status notification.AdditionalLogItem An additional log item for an operation which may be processed in the access log.AuthenticationInfo This class defines a data structure that may be used to store information about an authenticated user.CacheEntry This class defines a Directory Server cache entry, which is simply used to store an entry with its associated backend and entry ID.Cancellable Base for data structures that define configuration for operations.CancelRequest Deprecated. CancelResult Deprecated. DirectoryEnvironmentConfig This class provides a set of properties that may control various aspects of the server environment.Entries Contains server-specific methods that deal with entries.FilePermission This class provides a mechanism for setting file permissions in a more abstract manner than is provided by the underlying operating system and/or filesystem.LDAPURL This class defines a data structure that represents the components of an LDAP URL, including the scheme, host, port, base DN, attributes, scope, filter, and extensions.LDIFExportConfig This class defines a data structure for holding configuration information to use when performing an LDIF export.LDIFImportConfig This class defines a data structure for holding configuration information to use when performing an LDIF import.LDIFImportResult This class defines a data structure for providing information about the state of a completed LDIF import, including the total number of entries read, skipped, and rejected.LockManager A lock manager coordinates directory update operations so that the DIT structure remains in a consistent state, as well as providing repeatable read isolation.NamedCharacterSet This class provides a data structure that makes it possible to associate a name with a given set of characters.Operation This class defines a generic operation that may be processed by the Directory Server.ProcessId Represents a process ID which allows differentiating DS and RS instances running in the same JVM.ProxyAuthHelper Helper for using proxy auth controls.Range<T extends Comparable<T>> Represents a range of objects, where the bounds are always inclusive and may benull
.SubEntry This class represents RFC 3672 subentries and RFC 3671 collective attribute subentries objects.SubtreeSpecification An RFC 3672 subtree specification.SubtreeSpecification.FilterRefinement A refinement which uses a search filter.SynchronizationProviderResult.ContinueProcessing Defines a continue processing synchronization provider result.SynchronizationProviderResult.StopProcessing Defines a stop processing synchronization provider result.VirtualAttributeRule This class defines a virtual attribute rule, which associates a virtual attribute provider with its associated configuration, including the attribute type for which the values should be generated; the base DN(s), group DN(s), and search filter(s) that should be used to identify which entries should have the virtual attribute, and how conflicts between real and virtual values should be handled. -
Enum Summary Enum Description AcceptRejectWarn This class implements an enumeration that may be used for configuration items that may have three possible values: accept, reject, or warn.AccountStatusNotificationProperty This class implements an enumeration that holds the possible set of additional properties that can be included in an account status notification.AccountStatusNotificationType This class implements an enumeration that holds the possible event types that can trigger an account status notification.AuthenticationType This enumeration defines the set of possible authentication types that may be used for a bind request.DisconnectReason This enumeration defines the set of possible reasons for the closure of a connection between a client and the Directory Server.ExistingFileBehavior This enumeration defines the set of possible behaviors that should be taken when attempting to write to a file that already exists.IndexType This class implements an enumeration that may be used to define the ways in which an attribute may be indexed within the server.OperationType This enumeration defines the set of possible operation types that may be processed by the Directory Server.Privilege This class implements an enumeration that defines the set of privileges available in the Directory Server.StabilityLevel This class implements an enumeration whose values may be used to indicate the stability level of API classes and/or methods.WritabilityMode This class implements an enumeration that may be used to control the writability mode for the entire server or for a specific backend. -
Exception Summary Exception Description CryptoManagerException This class defines an exception that is thrown in the case of problems with encryption key management, and is a wrapper for a variety of other cipher related exceptions.IdentifiedException This class defines a base exception that should be extended by any exception that exposes a unique identifier for the associated message.InitializationException This class defines an exception that may be thrown if a problem occurs while trying to initialize a Directory Server component.OpenDsException This class defines a base exception for OpenDS exceptions. -
Annotation Types Summary Annotation Type Description PublicAPI This class defines an annotation type that can be used to describe the position of a package, class, or method in the OpenDS public API (including to denote that the associated code should NOT be considered part of the public API).