Uses of Class
org.opends.server.types.PublicAPI
-
Packages that use PublicAPI Package Description org.opends.messages Defines all the messages that may be used in the Directory Server and tools.org.opends.server.api Contains a number of API declarations for use throughout the Directory Server.org.opends.server.api.plugin Defines the Directory Server plugin API.org.opends.server.config Contains code used to interact with the Directory Server configuration.org.opends.server.loggers Contains implementations of Directory Server access, error, and debug loggers.org.opends.server.types Contains implementations for a number of Directory Server data types.org.opends.server.types.operation Contains a number of interfaces that are implemented by the various types of Directory Server operations.org.opends.server.util Contains implementations for various Directory Server utility classes and methods which may be used throughout the server but do not necessarily fit in elsewhere. -
Packages with annotations of type PublicAPI Package Description org.opends.server.admin Common administration classes.org.opends.server.api Contains a number of API declarations for use throughout the Directory Server.org.opends.server.replication.server.changelog.api This package contains the API for the changelog database.org.opends.server.backends Contains various Directory Server backend implementations.org.opends.server.replication.common This package contains utilities that can are used by all the packages below org.opends.server.replication.org.opends.server.config Contains code used to interact with the Directory Server configuration.org.opends.server.controls Contains classes that represent specific LDAP controls and their values.org.opends.server.core Contains various classes that comprise the core of the Directory Server codebase.org.opends.server.crypto This package implements the Directory Server cryptographic framework, which is described in the CrytpoManager design document.org.opends.server.discovery Contains the Service Discovery Mechanisms and APIs.org.opends.server.authorization.dseecompat Contains the Directory Server Sun Java System Directory Server Enterprise Edition (dseecompat) compatability access control handler implementation.org.opends.server.extensions Contains various implementations of Directory Server APIs that are not appropriate for other packages.org.opends.server.replication.server.changelog.file This package contains a file-based log implementation for the changelog database API.org.opends.server.protocols.http Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using HTTP.org.opends.server.backends.jeb Contains the code for the Directory Server backend that uses the Berkeley DB Java Edition as the repository for storing entry and index information.org.opends.server.protocols.jmx Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using JMX.org.opends.server.protocols.ldap Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using LDAPv3.org.opends.server.loggers Contains implementations of Directory Server access, error, and debug loggers.org.opends.messages Defines all the messages that may be used in the Directory Server and tools.org.opends.server.monitors Contains various Directory Server monitor provider implementations.org.opends.server.types.operation Contains a number of interfaces that are implemented by the various types of Directory Server operations.org.opends.server.backends.pluggable Contains the code for implementing Directory Server pluggable storage backends.org.opends.server.api.plugin Defines the Directory Server plugin API.org.opends.server.replication.plugin This package contains the part of the Multi-master replication code that works on the Directory Server side.org.opends.server.plugins Contains the implementation for various Directory Server plugins.org.opends.server.replication.protocol This package contains the code used by the replication server and by the code running on the Directory Server side to exchange their information.org.opends.server.protocols Contains various Directory Server connection handler implementations which will be used to accept connections from and perform communication with clients over various protocols.org.opends.server.schema Contains implementations of various Directory Server schema elements.org.opends.server.replication.server This package contains the code for the Replication Server part of the Multimaster replication feature.org.opends.server.replication.service This package contains the generic of the Multi-Master replication code that works on the Directory Server side.org.opends.server.snmp This package contains Simple Network Management Protocol (SNMP) connection handler, the required classes to support MIB 2605 objects and SNMP requests, and the SNMP adaptor that allows a SNMP manager to access OpenDS monitoring information.org.opends.server.backends.pluggable.spi Interfaces and classes required when implementing new storage engines for the pluggable backend.org.opends.server.backends.task Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.org.opends.server.tasks Contains implementations for various Directory Server tasks.org.opends.server.tools.tasks This package contains classes that support client tool interaction with the tasks backend.org.opends.server.tools Contains various Directory Server tool implementations.org.opends.server.types Contains implementations for a number of Directory Server data types.org.opends.server.tools.upgrade Defines the specific classes that are used by the upgrade tool.org.opends.server.util Contains implementations for various Directory Server utility classes and methods which may be used throughout the server but do not necessarily fit in elsewhere. -
-
Uses of PublicAPI in org.opends.messages
Classes in org.opends.messages with annotations of type PublicAPI Modifier and Type Class Description class
Severity
Defines values for message severity. -
Uses of PublicAPI in org.opends.server.api
Classes in org.opends.server.api with annotations of type PublicAPI Modifier and Type Class Description class
AccessControlHandler<T extends AccessControlHandlerCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server access control handler.class
AccountStatusNotificationHandler<T extends AccountStatusNotificationHandlerCfg>
This class defines the set of methods that must be implemented for an account status notification handler.interface
AlertGenerator
This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.interface
AlertHandler<T extends AlertHandlerCfg>
This interface defines the set of methods that must be implemented for a Directory Server alert handler.interface
BackupTaskListener
This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend backup task is about to begin or has just completed.class
CertificateMapper<T extends CertificateMapperCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required to uniquely map an SSL client certificate to a Directory Server user entry.class
ClientConnection
This class defines the set of methods and structures that must be implemented by a Directory Server client connection.interface
DirectoryServerMBean
This interface must be implemented by all Directory Server components that interact with JMX in any way.class
DirectoryThread
This class defines a generic thread that should be the superclass for all threads created by the Directory Server.class
EntryCache<T extends EntryCacheCfg>
This class defines the set of methods that must be implemented by a Directory Server entry cache.interface
ExportTaskListener
This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF export task is about to begin or has just completed.class
ExtendedOperationHandler<T extends ExtendedOperationHandlerCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more types of extended operations.interface
Group<T extends GroupImplementationCfg>
This interface defines the set of methods that must be implemented by a Directory Server group.class
IdentityMapper<T extends IdentityMapperCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server identity mapper.interface
ImportTaskListener
This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF import task is about to begin or has just completed.class
KeyManagerProvider<T extends KeyManagerProviderCfg>
This class defines an API that may be used to obtain a set ofjavax.net.ssl.KeyManager
objects for use when performing SSL communication.class
LocalBackend<C extends Configuration>
This class defines the set of methods and structures that must be implemented for a Directory Server backend.interface
LocalBackendInitializationListener
This interface defines a set of methods that may be used by server components to perform any processing that they might find necessary whenever a local backend is initialized and/or finalized.class
MonitorData
This class is used to hold monitoring data, i.e.class
MonitorProvider
This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.class
PasswordGenerator<T extends PasswordGeneratorCfg>
This class defines a set of methods and structures that must be implemented by a Directory Server module that may be used to generate user passwords.class
PasswordStorageScheme<T extends PasswordStorageSchemeCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements a password storage scheme.class
PasswordValidator<T extends PasswordValidatorCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that may be used to determine whether a proposed password is acceptable for a user.interface
RestoreTaskListener
This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend restore task is about to begin or has just completed.class
SASLMechanismHandler<T extends SaslMechanismHandlerCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more SASL mechanisms.interface
ServerShutdownListener
This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.interface
SubentryChangeListener
This interface defines a mechanism that Directory Server components may use if they need to be notified of changes that are being made to subentries in the Directory Server.class
SynchronizationProvider<T extends SynchronizationProviderCfg>
This class defines the set of methods and structures that are available for use in a Directory Server synchronization provider.class
TrustManagerProvider<T extends TrustManagerProviderCfg>
This class defines an API that may be used to obtain a set ofjavax.net.ssl.TrustManager
objects for use when performing SSL/StartTLS negotiation.class
VirtualAttributeProvider<T extends VirtualAttributeCfg>
This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more virtual attributes.class
WorkQueue<T extends WorkQueueCfg>
This class defines the structure and methods that must be implemented by a Directory Server work queue.Methods in org.opends.server.api with annotations of type PublicAPI Modifier and Type Method Description void
ClientConnection. deregisterPersistentSearch(PersistentSearch persistentSearch)
Deregisters the provided persistent search for this client.protected void
ClientConnection. finalizeConnectionInternal()
Performs any internal cleanup that may be necessary when this client connection is disconnected.void
ClientConnection. registerPersistentSearch(PersistentSearch persistentSearch)
Registers the provided persistent search for this client. -
Uses of PublicAPI in org.opends.server.api.plugin
Classes in org.opends.server.api.plugin with annotations of type PublicAPI Modifier and Type Class Description class
DirectoryServerPlugin<T extends PluginCfg>
This class defines the set of methods and structures that are available for use in Directory Server plugins.class
PluginResult
This class defines a data structure that holds information about the result of processing by a plugin.class
PluginType
This class defines an enumeration containing the types of plugins that are supported for use in the Directory Server.Methods in org.opends.server.api.plugin with annotations of type PublicAPI Modifier and Type Method Description void
DirectoryServerPlugin. initializeInternal(ServerContext serverContext, Dn pluginDN, Set<PluginType> pluginTypes, boolean invokeForInternalOps)
Performs any initialization that should be done for all types of plugins regardless of type.void
DirectoryServerPlugin. setInvokeForInternalOperations(boolean invokeForInternalOps)
Specifies whether this plugin should be invoked for internal operations. -
Uses of PublicAPI in org.opends.server.config
Classes in org.opends.server.config with annotations of type PublicAPI Modifier and Type Class Description class
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 monitoring, and provide notifications and alerts if a significant event or severe/fatal error occurs. -
Uses of PublicAPI in org.opends.server.loggers
Classes in org.opends.server.loggers with annotations of type PublicAPI Modifier and Type Class Description class
AccessLogPublisher<T extends AccessLogPublisherCfg>
This class defines the set of methods and structures that must be implemented for a Directory Server access log publisher.class
DebugLogPublisher<T extends DebugLogPublisherCfg>
This class defines the set of methods and structures that must be implemented for a Directory Server debug log publisher.class
ErrorLogPublisher<T extends ErrorLogPublisherCfg>
This class defines the set of methods and structures that must be implemented for a Directory Server error log publisher.class
HTTPAccessLogPublisher<T extends HttpAccessLogPublisherCfg>
This class defines the set of methods and structures that must be implemented for a Directory Server HTTP access log publisher.interface
LogPublisher<T extends LogPublisherCfg>
This class defines the set of methods and structures that must be implemented for a Directory Server log publisher. -
Uses of PublicAPI in org.opends.server.types
Classes in org.opends.server.types with annotations of type PublicAPI Modifier and Type Class Description class
AcceptRejectWarn
This class implements an enumeration that may be used for configuration items that may have three possible values: accept, reject, or warn.class
AccountStatusNotification
This class defines a data type for storing information associated with an account status notification.class
AccountStatusNotificationProperty
This class implements an enumeration that holds the possible set of additional properties that can be included in an account status notification.class
AccountStatusNotificationType
This class implements an enumeration that holds the possible event types that can trigger an account status notification.class
AuthenticationInfo
This class defines a data structure that may be used to store information about an authenticated user.class
AuthenticationType
This enumeration defines the set of possible authentication types that may be used for a bind request.class
CacheEntry
This class defines a Directory Server cache entry, which is simply used to store an entry with its associated backend and entry ID.class
Cancellable
Base for data structures that define configuration for operations.class
CancelRequest
Deprecated.class
CancelResult
Deprecated.class
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.class
DirectoryEnvironmentConfig
This class provides a set of properties that may control various aspects of the server environment.class
DisconnectReason
This enumeration defines the set of possible reasons for the closure of a connection between a client and the Directory Server.class
ExistingFileBehavior
This enumeration defines the set of possible behaviors that should be taken when attempting to write to a file that already exists.class
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.class
IdentifiedException
This class defines a base exception that should be extended by any exception that exposes a unique identifier for the associated message.class
IndexType
This class implements an enumeration that may be used to define the ways in which an attribute may be indexed within the server.class
InitializationException
This class defines an exception that may be thrown if a problem occurs while trying to initialize a Directory Server component.class
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.class
LDIFExportConfig
This class defines a data structure for holding configuration information to use when performing an LDIF export.class
LDIFImportConfig
This class defines a data structure for holding configuration information to use when performing an LDIF import.class
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.class
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.interface
MemberList<T>
Iterator that can be used to iterate over the members of a group.class
NamedCharacterSet
This class provides a data structure that makes it possible to associate a name with a given set of characters.class
OpenDsException
This class defines a base exception for OpenDS exceptions.class
Operation
This class defines a generic operation that may be processed by the Directory Server.class
OperationType
This enumeration defines the set of possible operation types that may be processed by the Directory Server.class
Privilege
This class implements an enumeration that defines the set of privileges available in the Directory Server.class
StabilityLevel
This class implements an enumeration whose values may be used to indicate the stability level of API classes and/or methods.class
SubtreeSpecification
An RFC 3672 subtree specification.interface
SynchronizationProviderResult
This class defines a data structure that holds information about the result of processing by a synchronization provider.class
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.class
WritabilityMode
This class implements an enumeration that may be used to control the writability mode for the entire server or for a specific backend.Methods in org.opends.server.types with annotations of type PublicAPI Modifier and Type Method Description static Map<AccountStatusNotificationProperty,List<String>>
AccountStatusNotification. createProperties(PasswordPolicyState pwPolicyState, boolean tempLocked, int timeToExpiration, List<ByteString> oldPasswords, List<ByteString> newPasswords)
Creates a set of account status notification properties from the provided information. -
Uses of PublicAPI in org.opends.server.types.operation
Classes in org.opends.server.types.operation with annotations of type PublicAPI Modifier and Type Interface Description interface
InProgressOperation
This class defines a set of methods that are available for use by plugins for operations that are currently in the middle of their "core" processing (e.g., for examining search result entries or references before they are sent to the client).interface
InProgressSearchOperation
This class defines a set of methods that are available for use by in progress search plugins.interface
PluginOperation
This class defines a set of methods that are available for use by all types of plugins involved in operation processing (pre-parse, pre-operation, post-operation, post-response, search result entry, search result reference, and intermediate response).interface
PostOperationAbandonOperation
This class defines a set of methods that are available for use by post-operation plugins for abandon operations.interface
PostOperationAddOperation
This class defines a set of methods that are available for use by post-operation plugins for add operations.interface
PostOperationBindOperation
This class defines a set of methods that are available for use by post-operation plugins for bind operations.interface
PostOperationCompareOperation
This class defines a set of methods that are available for use by post-operation plugins for compare operations.interface
PostOperationDeleteOperation
This class defines a set of methods that are available for use by post-operation plugins for delete operations.interface
PostOperationExtendedOperation
This class defines a set of methods that are available for use by post-operation plugins for extended operations.interface
PostOperationModifyDNOperation
This class defines a set of methods that are available for use by post-operation plugins for modify DN operations.interface
PostOperationModifyOperation
This class defines a set of methods that are available for use by post-operation plugins for modify operations.interface
PostOperationOperation
This class defines a set of methods that are available for use by post-operation plugins for all types of operations.interface
PostOperationSearchOperation
This class defines a set of methods that are available for use by post-operation plugins for search operations.interface
PostOperationUnbindOperation
This class defines a set of methods that are available for use by post-operation plugins for unbind operations.interface
PostResponseAddOperation
This class defines a set of methods that are available for use by post-response plugins for add operations.interface
PostResponseBindOperation
This class defines a set of methods that are available for use by post-response plugins for bind operations.interface
PostResponseCompareOperation
This class defines a set of methods that are available for use by post-response plugins for compare operations.interface
PostResponseDeleteOperation
This class defines a set of methods that are available for use by post-response plugins for delete operations.interface
PostResponseExtendedOperation
This class defines a set of methods that are available for use by post-response plugins for extended operations.interface
PostResponseModifyDNOperation
This class defines a set of methods that are available for use by post-response plugins for modify DN operations.interface
PostResponseModifyOperation
This class defines a set of methods that are available for use by post-response plugins for modify operations.interface
PostResponseOperation
This class defines a set of methods that are available for use by post-response plugins for all types of operations.interface
PostResponseSearchOperation
This class defines a set of methods that are available for use by post-response plugins for search operations.interface
PostSynchronizationAddOperation
This class defines a set of methods that are available for use by post-synchronization plugins for add operations.interface
PostSynchronizationDeleteOperation
This class defines a set of methods that are available for use by post-synchronization plugins for delete operations.interface
PostSynchronizationModifyDNOperation
This class defines a set of methods that are available for use by post-synchronization plugins for modify DN operations.interface
PostSynchronizationModifyOperation
This class defines a set of methods that are available for use by post-synchronization plugins for modify operations.interface
PostSynchronizationOperation
This class defines a set of methods that are available for use by post-synchronization plugins for all types of operations.interface
PreOperationAddOperation
This class defines a set of methods that are available for use by pre-operation plugins for add operations.interface
PreOperationBindOperation
This class defines a set of methods that are available for use by pre-operation plugins for bind operations.interface
PreOperationCompareOperation
This class defines a set of methods that are available for use by pre-operation plugins for compare operations.interface
PreOperationDeleteOperation
This class defines a set of methods that are available for use by pre-operation plugins for delete operations.interface
PreOperationExtendedOperation
This class defines a set of methods that are available for use by pre-operation plugins for extended operations.interface
PreOperationModifyDNOperation
This class defines a set of methods that are available for use by pre-operation plugins for modify DN operations.interface
PreOperationModifyOperation
This class defines a set of methods that are available for use by pre-operation plugins for modify operations.interface
PreOperationOperation
This class defines a set of methods that are available for use by pre-operation plugins for all types of operations.interface
PreOperationSearchOperation
This class defines a set of methods that are available for use by pre-operation plugins for search operations.interface
PreParseAbandonOperation
This class defines a set of methods that are available for use by pre-parse plugins for abandon operations.interface
PreParseAddOperation
This class defines a set of methods that are available for use by pre-parse plugins for add operations.interface
PreParseBindOperation
This class defines a set of methods that are available for use by pre-parse plugins for bind operations.interface
PreParseCompareOperation
This class defines a set of methods that are available for use by pre-parse plugins for compare operations.interface
PreParseDeleteOperation
This class defines a set of methods that are available for use by pre-parse plugins for delete operations.interface
PreParseExtendedOperation
This class defines a set of methods that are available for use by pre-parse plugins for extended operations.interface
PreParseModifyDNOperation
This class defines a set of methods that are available for use by pre-parse plugins for modify DN operations.interface
PreParseModifyOperation
This class defines a set of methods that are available for use by pre-parse plugins for modify operations.interface
PreParseOperation
This class defines a set of methods that are available for use by pre-parse plugins for all types of operations.interface
PreParseSearchOperation
This class defines a set of methods that are available for use by pre-parse plugins for search operations.interface
PreParseUnbindOperation
This class defines a set of methods that are available for use by pre-parse plugins for unbind operations.interface
SubordinateModifyDNOperation
This class defines a set of methods that are available for use by subordinate modify DN operation plugins. -
Uses of PublicAPI in org.opends.server.util
Classes in org.opends.server.util with annotations of type PublicAPI Modifier and Type Class Description class
Crypt
UNIX Crypt cipher, ported from the Sun OpenSolaris project.class
EMailMessage
This class defines an e-mail message that may be sent to one or more recipients via SMTP.class
LDIFException
This class defines an exception that may be thrown while attempting to parse LDIF content.class
LDIFReader
This class provides the ability to read information from an LDIF file.class
LevenshteinDistance
This class provides an implementation of the Levenshtein distance algorithm, which may be used to determine the minimum number of changes required to transform one string into another.class
MultiOutputStream
This class defines a simpleOutputStream
object that can be used to write all messages to multiple targets at the same time, much like the UNIX "tee" command.class
ServerConstants
This class defines a set of constants that may be referenced throughout the Directory Server source.class
StaticUtils
This class defines a number of static utility methods that may be used throughout the server.class
TimeThread
This class provides an application-wide timing service.
-