@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
Attribute	This class defines a data structure for storing and interacting with an attribute that may be used in the Directory Server.
CryptoManager	This interface defines the methods to call to access cryptographic services including encryption and hashing; in particular, when the ciphertext or HMAC is produced on one directory server instance and is to be consumed on another.
Operation	This interface defines a generic operation that may be processed by the Directory Server.
SynchronizationProviderResult	This class defines a data structure that holds information about the result of processing by a synchronization provider.

Class Summary

Class	Description
AbstractAttribute	An abstract base class for implementing new types of Attribute.
AbstractOperation	This class defines a generic operation that may be processed by the Directory Server.
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.
AttributeBuilder	This class provides an interface for creating new non-virtual Attributes, or "real" attributes.
AttributeParser	A fluent API for parsing attributes as different types of object.
Attributes	This class contains various methods for manipulating Attributes as well as static factory methods for facilitating common Attribute construction use-cases.
AuthenticationInfo	This class defines a data structure that may be used to store information about an authenticated user.
BackupConfig	This class defines a data structure for holding configuration information to use when performing a backup of a Directory Server backend.
BackupDirectory	This class defines a data structure for holding information about a filesystem directory that contains data for one or more backups associated with a backend.
BackupInfo	This class defines a data structure for holding information about a backup that is available in a backup directory.
CacheEntry	This class defines a Directory Server cache entry, which is simply used to store an entry with its associated backend and entry ID.
CancelRequest	This class defines a data structure that can be used to hold information about a request to cancel or abandon an operation in progress.
CancelResult	This enumeration defines the set of possible outcomes that can result from processing a cancel request.
CollectiveVirtualAttribute	This class defines a collective virtual attribute, which is a special kind of attribute whose values do not actually exist in persistent storage but rather are obtained dynamically from applicable collective attribute subentry.
Control	This class defines a data structure that holds information about a control that can be included in a request or response.
DirectoryConfig	This interface defines a set of methods that may be used by third-party code to obtain information about the core Directory Server configuration and the instances of various kinds of components that have registered themselves with the server.
DirectoryEnvironmentConfig	This class provides a set of properties that may control various aspects of the server environment.
Entry	This class defines a data structure for a Directory Server entry.
EntryEncodeConfig	This class defines a data structure that contains configuration information about how an entry should be encoded.
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.
HostPort	This class defines a data structure that combines an address and port number, as may be used to accept a connection from or initiate a connection to a remote system.
IntermediateResponse	This class defines a data structure for holding information that may be sent to the client in the form of an intermediate response.
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.
MemberList	This class defines a mechanism that may be used to iterate over the members of a group.
Modification	This class defines a data structure for storing and interacting with a modification that may be requested of an entry in the Directory Server.
NamedCharacterSet	This class provides a data structure that makes it possible to associate a name with a given set of characters.
NullOutputStream	This class defines a custom output stream that simply discards any data written to it.
OperationConfig	Base for data structures that define configuration for operations.
RawAttribute	This class defines a raw attribute, which has a type (which may include zero or more options), and zero or more values.
RawFilter	This class defines the data structures and methods to use when interacting with a raw search filter, which defines a set of criteria for locating entries in a search request.
RawModification	This class defines the data structures and methods to use when interacting with a raw modification, which describes a change that should be made to an attribute.
RecordingInputStream	A wrapper InputStream that will record all reads from an underlying InputStream.
RecordingOutputStream	A wrapper OutputStream that will record all writes to an underlying OutputStream.
RestoreConfig	This class defines a data structure for holding configuration information to use when restoring a backup of a Directory Server backend.
SearchFilter	This class defines a data structure for storing and interacting with a search filter that may serve as criteria for locating entries in the Directory Server.
SearchResultEntry	This class defines a data structure for storing information about an entry that matches a given set of search criteria and should be returned to the client.
SearchResultReference	This class defines a data structure for storing information about a referral returned while processing a search request.
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.
VirtualAttribute	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.
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.
FilterType	This enumeration defines the set of possible filter types that may be used for search filters.
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.
SSLClientAuthPolicy	This enumeration defines a policy that indicates how the server should deal with SSL/TLS-based client connections.
StabilityLevel	This class implements an enumeration whose values may be used to indicate the stability level of API classes and/or methods.
SubEntry.CollectiveConflictBehavior	Defines the set of permissible values for the conflict behavior.
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
CanceledOperationException	This class defines an exception that may be thrown if the operation being processed is cancelled for some reason (e.g., an abandon or cancel request from the client).
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.
DirectoryException	This class defines an exception that may be thrown if a problem occurs in the Directory Server.
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.
LDAPException	This class defines an exception that may be thrown if a problem occurs while interacting with an LDAP protocol element.
MembershipException	This class defines an exception that may be thrown if a problem occurs while attempting to iterate across the members of a group.
OpenDsException	This class defines a base exception for OpenDS exceptions.

Annotation Types Summary

Annotation Type	Description
Attribute.RemoveOnceSwitchingAttributes	Marks code that can be removed once we are switching from server's to SDK's Attribute.
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).