Directory Services 7.5.1 API
These API specifications reflect the public APIs for directory service plugin development.
The following groups of packages are documented:
- LDAP SDK packages - classes and interfaces for accessing and implementing LDAP directory services as defined in RFC 4510.
- Server packages - classes and interfaces for writing server plugins.
- Common packages - common ForgeRock classes and interfaces used in directory services APIs.
Package
Description
Package contains the AuditService.
Package contains common audit batch configuration files.
Package contains audit events.
This package contains the default
AuditEventHandlers.This package contains the batch publisher and its various implementations.
Utility classes for writing streams of characters.
Contains the classes for filtering audit events.
This package contains the default AuditEventHandler implementations.
This package contains the Elasticsearch
AuditEventHandler implementation.This package contains a JMS AuditEventHandler implementation.
This package contains the JSON-file
AuditEventHandler implementation.This package contains the JSON-stdout
AuditEventHandler implementation.This package contains the audit handler implementation for Splunk.
This package contains a Syslog AuditEventHandler implementation.
This package contains utilities to build and configure audit service and handlers from JSON configuration.
Dependencies that can be made available to the
AuditService via a
DependencyProvider.File retention classes.
Audit log file rotation classes.
Classes for handling secure audit logging.
This package contains utility classes used in the audit service.
This package contains the common config property resolvers.
This package contains the template parser used in property substitution.
Contains utility classes for commons config.
A i18n framework for embedding localizable messages in applications.
This package provides an alternative localization mechanism to
org.slf4j.cal10n.Provides an API for the traversal and manipulation of JSON object model structures in Java.
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
JSON resource Commons HTTP Framework integration.
These classes are the commonly used classes from other applications.
Schema validator exceptions.
These classes are capable of helping the validators to check certain constraints.
These classes are capable of validating the objects against the initially loaded schema.
Common utility classes for monitoring.
Common Monitoring API Annotations based on MicroMeter
Common Monitoring API Core based on MicroMeter
Common Monitoring API Config functionality based on MicroMeter
Common Monitoring API Histogram based on MicroMeter
Common Monitoring API Histogram Pause Detector based on MicroMeter
Common Monitoring API Search functionality based on MicroMeter
Common Monitoring API Utilities based on MicroMeter
Common Monitoring API Annotations based on MicroMeter
Implementation for Common Monitoring API based on DropWizard.
Common utility classes for monitoring.
Common administration classes.
Common client-side administration classes.
LDAP configuration transport implementation.
Client side driver implementation interfaces.
Logical conditions for defining constraints.
This package contains the DS config.
This package contains LDAP schema syntaxes for attributes that can handle either
a commons-config expression using the pattern "&{some.token}" or an actual value corresponding to
the underlying syntax.
Server-side administration interface.
Contains a number of API declarations for use throughout the
Directory Server.
Contains the Service Discovery Mechanisms and APIs.
Classes and interfaces providing I/O functionality.
Classes and interfaces providing Reactive Streams I/O transports.
Classes and interfaces for core types including connections, entries, and
attributes.
Classes and interfaces for common LDAP controls.
Classes and interfaces for core LDAP requests/responses.
Classes and interfaces for constructing and querying LDAP schemas.
Classes and interfaces for reading and writing LDIF.
APIs for implementing REST to LDAP gateways.
This package contains
Filter to authenticate and authorize LDAP connections.This package contains LDAP schema syntaxes and matching rules for JSON based attributes.
An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based
KeyStore service.Provides client-side interfaces for querying and managing the Core
directory server administrative components.
Provides introspection interfaces for the Core directory server
administrative components.
Provides server-side interfaces for accessing the Core directory
server administrative components.
Classes implementing core server APIs.
Provides support for an embedded directory server.
Contains code of the setup command line interface tool.
Contains code of the opendj setup model.
Contains code of the dsrepl command line interface tool.
Provides a unified API for accessing secrets of various kinds.
Contains secret credential related API objects.
Contains cryptographic key related API objects.
Implementations of
SecretStore for accessing keys stored in Java KeyStores, such as
PKCS#11 Hardware Security Modules (HSMs) and PKCS#12 file-based encrypted key stores.Provides a
SecretStore implementation that loads secrets from a Common Configuration
PropertyResolver and then decodes it with a
SecretPropertyFormat.This package contains classes that load, initialize, and access a managed keystore.
Provides token handler definition.
Provides common interfaces and classes.
Provides common annotations.
Provides common crypto constants and classes.
Provides fast and memory efficient Base64, Base64Url, and Hex decoding and encoding.
Provides an abstraction of identifiers generators.
Utility classes for dealing with internationalization (i18n).
An implementation of the
Promise API in Java.Provides a mechanism for implementing query filters.
Provides a mechanism for handling shutdown of ExecutorService instances.
Provides interfaces for handling shutdown.
Provides a time service abstraction.
Provides utilities for reading and processing XML.
Defines all the messages that may be used in the Directory Server and tools.
Common administration classes.
Contains a number of API declarations for use throughout the Directory Server.
Defines the Directory Server plugin API.
Contains the Directory Server Sun Java System Directory Server Enterprise Edition (dseecompat) compatability access
control handler implementation.
Contains the policy based access control handler implementation.
Contains various Directory Server backend implementations.
Contains the code for the Directory Server backend that uses the Berkeley DB Java Edition as the repository for
storing entry and index information.
Contains the code for implementing Directory Server pluggable storage backends.
Interfaces and classes required when implementing new storage engines for the pluggable backend.
Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.
Classes related to backup and restore.
Contains code used to interact with the Directory Server configuration.
Contains classes that represent specific LDAP controls and their values.
Contains various classes that comprise the core of the Directory Server codebase.
This package implements the Directory Server cryptographic framework, which is described in the
CrytpoManager design document.
Contains the Service Discovery Mechanisms and APIs.
Contains various implementations of Directory Server APIs that are not appropriate for other packages.
Contains implementations of Directory Server access, error, and debug loggers.
Contains classes exported in opendj-slf4j-adapter osgi bundle.
Contains various Directory Server monitor provider implementations.
Contains the implementation for various Directory Server plugins.
Contains various Directory Server connection handler implementations which will be used to accept connections from
and perform communication with clients over various protocols.
Contains the implementation for the Directory Server connection handler that is responsible for interacting with
clients using HTTP.
Contains factories to build the authorization stage of the HTTP request processing.
Contains the implementation for the HTTPEndpoint that is responsible for providing a REST interface to this LDAP
server.
Contains the implementation for the Directory Server connection handler that is responsible for interacting with
clients using JMX.
Contains the implementation for the Directory Server connection handler that is responsible for interacting with
clients using LDAPv3.
This package contains utilities that can are used by all the packages below org.opends.server.replication.
This package contains the part of the Multi-master replication code that works on the Directory Server side.
This package contains the code used by the replication server and by the code running on the Directory Server side to
exchange their information.
This package contains the code for the Replication Server part of the Multimaster replication feature.
This package contains the API for the changelog database.
This package contains a file-based log implementation for the changelog database API.
This package contains the generic of the Multi-Master replication code that works on the Directory Server side.
Contains implementations of various Directory Server schema elements.
Contains implementations for various Directory Server tasks.
Contains various Directory Server tool implementations.
Classes related to dsbackup tool.
Defines the classes that are you used by the status command line.
Contains the classes that are used by the supportextract tool.
This package contains classes that support client tool interaction with the tasks backend.
Defines the specific classes that are used by the upgrade tool.
Contains implementations for a number of Directory Server data types.
Contains a number of interfaces that are implemented by the various types of Directory Server operations.
Contains implementations for various Directory Server utility classes and methods which may be used throughout the
server but do not necessarily fit in elsewhere.
Classes needed by SLF4J to choose actual implementation of SLF4J API.