Directory Services 7.3.5 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 |
|---|---|
| org.forgerock.audit |
Package contains the AuditService.
|
| org.forgerock.audit.batch |
Package contains common audit batch configuration files.
|
| org.forgerock.audit.events |
Package contains audit events.
|
| org.forgerock.audit.events.handlers |
This package contains the default
AuditEventHandlers. |
| org.forgerock.audit.events.handlers.buffering |
This package contains the batch publisher and its various implementations.
|
| org.forgerock.audit.events.handlers.writers |
Utility classes for writing streams of characters.
|
| org.forgerock.audit.filter |
Contains the classes for filtering audit events.
|
| org.forgerock.audit.handlers.csv |
This package contains the default AuditEventHandler implementations.
|
| org.forgerock.audit.handlers.elasticsearch |
This package contains the Elasticsearch
AuditEventHandler implementation. |
| org.forgerock.audit.handlers.jms |
This package contains a JMS AuditEventHandler implementation.
|
| org.forgerock.audit.handlers.json |
This package contains the JSON-file
AuditEventHandler implementation. |
| org.forgerock.audit.handlers.json.stdout |
This package contains the JSON-stdout
AuditEventHandler implementation. |
| org.forgerock.audit.handlers.splunk |
This package contains the audit handler implementation for Splunk.
|
| org.forgerock.audit.handlers.syslog |
This package contains a Syslog AuditEventHandler implementation.
|
| org.forgerock.audit.json |
This package contains utilities to build and configure audit service and handlers from JSON configuration.
|
| org.forgerock.audit.providers |
Dependencies that can be made available to the
AuditService via a
DependencyProvider. |
| org.forgerock.audit.retention |
File retention classes.
|
| org.forgerock.audit.rotation |
Audit log file rotation classes.
|
| org.forgerock.audit.secure |
Classes for handling secure audit logging.
|
| org.forgerock.audit.util |
This package contains utility classes used in the audit service.
|
| org.forgerock.config.resolvers |
This package contains the common config property resolvers.
|
| org.forgerock.config.resolvers.template |
This package contains the template parser used in property substitution.
|
| org.forgerock.config.util |
Contains utility classes for commons config.
|
| org.forgerock.i18n |
A i18n framework for embedding localizable messages in applications.
|
| org.forgerock.i18n.slf4j |
This package provides an alternative localization mechanism to
org.slf4j.cal10n. |
| org.forgerock.json |
Provides an API for the traversal and manipulation of JSON object model structures in Java.
|
| org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
| org.forgerock.json.resource.http |
JSON resource Commons HTTP Framework integration.
|
| org.forgerock.json.schema.validator |
These classes are the commonly used classes from other applications.
|
| org.forgerock.json.schema.validator.exceptions |
Schema validator exceptions.
|
| org.forgerock.json.schema.validator.helpers |
These classes are capable of helping the validators to check certain constraints.
|
| org.forgerock.json.schema.validator.validators |
These classes are capable of validating the objects against the initially loaded schema.
|
| org.forgerock.monitoring |
Common utility classes for monitoring.
|
| org.forgerock.monitoring.api.annotation |
Common Monitoring API Annotations based on MicroMeter
|
| org.forgerock.monitoring.api.instrument |
Common Monitoring API Core based on MicroMeter
|
| org.forgerock.monitoring.api.instrument.binder | |
| org.forgerock.monitoring.api.instrument.config |
Common Monitoring API Config functionality based on MicroMeter
|
| org.forgerock.monitoring.api.instrument.histogram |
Common Monitoring API Histogram based on MicroMeter
|
| org.forgerock.monitoring.api.instrument.histogram.pause |
Common Monitoring API Histogram Pause Detector based on MicroMeter
|
| org.forgerock.monitoring.api.instrument.search |
Common Monitoring API Search functionality based on MicroMeter
|
| org.forgerock.monitoring.api.instrument.util |
Common Monitoring API Utilities based on MicroMeter
|
| org.forgerock.monitoring.api.lang |
Common Monitoring API Annotations based on MicroMeter
|
| org.forgerock.monitoring.dropwizard |
Implementation for Common Monitoring API based on DropWizard.
|
| org.forgerock.monitoring.http |
Common utility classes for monitoring.
|
| org.forgerock.opendj.config |
Common administration classes.
|
| org.forgerock.opendj.config.client |
Common client-side administration classes.
|
| org.forgerock.opendj.config.client.ldap |
LDAP configuration transport implementation.
|
| org.forgerock.opendj.config.client.spi |
Client side driver implementation interfaces.
|
| org.forgerock.opendj.config.conditions |
Logical conditions for defining constraints.
|
| org.forgerock.opendj.config.dsconfig |
This package contains the DS config.
|
| org.forgerock.opendj.config.schema |
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.
|
| org.forgerock.opendj.config.server |
Server-side administration interface.
|
| org.forgerock.opendj.config.server.spi |
Contains a number of API declarations for use throughout the
Directory Server.
|
| org.forgerock.opendj.discovery |
Contains the Service Discovery Mechanisms and APIs.
|
| org.forgerock.opendj.io |
Classes and interfaces providing I/O functionality.
|
| org.forgerock.opendj.io.rx |
Classes and interfaces providing Reactive Streams I/O transports.
|
| org.forgerock.opendj.ldap |
Classes and interfaces for core types including connections, entries, and
attributes.
|
| org.forgerock.opendj.ldap.controls |
Classes and interfaces for common LDAP controls.
|
| org.forgerock.opendj.ldap.messages |
Classes and interfaces for core LDAP requests/responses.
|
| org.forgerock.opendj.ldap.schema |
Classes and interfaces for constructing and querying LDAP schemas.
|
| org.forgerock.opendj.ldif |
Classes and interfaces for reading and writing LDIF.
|
| org.forgerock.opendj.rest2ldap |
APIs for implementing REST to LDAP gateways.
|
| org.forgerock.opendj.rest2ldap.authz |
This package contains
Filter to authenticate and authorize LDAP connections. |
| org.forgerock.opendj.rest2ldap.schema |
This package contains LDAP schema syntaxes and matching rules for JSON based attributes.
|
| org.forgerock.opendj.security |
An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based
KeyStore service. |
| org.forgerock.opendj.server.config.client |
Provides client-side interfaces for querying and managing the Core
directory server administrative components.
|
| org.forgerock.opendj.server.config.meta |
Provides introspection interfaces for the Core directory server
administrative components.
|
| org.forgerock.opendj.server.config.server |
Provides server-side interfaces for accessing the Core directory
server administrative components.
|
| org.forgerock.opendj.server.core |
Classes implementing core server APIs.
|
| org.forgerock.opendj.server.embedded |
Provides support for an embedded directory server.
|
| org.forgerock.opendj.setup.cli |
Contains code of the setup command line interface tool.
|
| org.forgerock.opendj.setup.model |
Contains code of the opendj setup model.
|
| org.forgerock.opendj.tools.dsrepl |
Contains code of the dsrepl command line interface tool.
|
| org.forgerock.secrets |
Provides a unified API for accessing secrets of various kinds.
|
| org.forgerock.secrets.keys |
Contains cryptographic key related API objects.
|
| org.forgerock.secrets.propertyresolver |
Provides a
SecretStore implementation that loads secrets from a Common Configuration
PropertyResolver and then decodes it with a
SecretPropertyFormat. |
| org.forgerock.security.keystore |
This package contains classes that load, initialize, and access a managed keystore.
|
| org.forgerock.tokenhandler |
Provides token handler definition.
|
| org.forgerock.util |
Provides common interfaces and classes.
|
| org.forgerock.util.annotations |
Provides common annotations.
|
| org.forgerock.util.crypto |
Provides common crypto constants and classes.
|
| org.forgerock.util.encode |
Provides fast and memory efficient Base64, Base64Url, and Hex decoding and encoding.
|
| org.forgerock.util.generator |
Provides an abstraction of identifiers generators.
|
| org.forgerock.util.i18n |
Utility classes for dealing with internationalization (i18n).
|
| org.forgerock.util.promise |
An implementation of the
Promise API in Java. |
| org.forgerock.util.query |
Provides a mechanism for implementing query filters.
|
| org.forgerock.util.thread |
Provides a mechanism for handling shutdown of ExecutorService instances.
|
| org.forgerock.util.thread.listener |
Provides interfaces for handling shutdown.
|
| org.forgerock.util.time |
Provides a time service abstraction.
|
| org.forgerock.util.xml |
Provides utilities for reading and processing XML.
|
| org.opends.messages |
Defines all the messages that may be used in the Directory Server and tools.
|
| 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.api.plugin |
Defines the Directory Server plugin API.
|
| 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.authorization.policy |
Contains the policy based access control handler implementation.
|
| org.opends.server.backends |
Contains various Directory Server backend implementations.
|
| 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.backends.pluggable |
Contains the code for implementing Directory Server pluggable storage backends.
|
| 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.backup |
Classes related to backup and restore.
|
| 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.extensions |
Contains various implementations of Directory Server APIs that are not appropriate for other packages.
|
| org.opends.server.loggers |
Contains implementations of Directory Server access, error, and debug loggers.
|
| org.opends.server.loggers.slf4j |
Contains classes exported in opendj-slf4j-adapter osgi bundle.
|
| org.opends.server.monitors |
Contains various Directory Server monitor provider implementations.
|
| org.opends.server.plugins |
Contains the implementation for various Directory Server plugins.
|
| 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.protocols.http |
Contains the implementation for the Directory Server connection handler that is responsible for interacting with
clients using HTTP.
|
| org.opends.server.protocols.http.authz |
Contains factories to build the authorization stage of the HTTP request processing.
|
| org.opends.server.protocols.http.rest2ldap |
Contains the implementation for the HTTPEndpoint that is responsible for providing a REST interface to this LDAP
server.
|
| 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.replication.common |
This package contains utilities that can are used by all the packages below org.opends.server.replication.
|
| 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.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.replication.server |
This package contains the code for the Replication Server part of the Multimaster replication feature.
|
| org.opends.server.replication.server.changelog.api |
This package contains the API for the changelog database.
|
| org.opends.server.replication.server.changelog.file |
This package contains a file-based log implementation for the changelog database API.
|
| 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.schema |
Contains implementations of various Directory Server schema elements.
|
| 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.tasks |
Contains implementations for various Directory Server tasks.
|
| org.opends.server.tools |
Contains various Directory Server tool implementations.
|
| org.opends.server.tools.dsbackup |
Classes related to dsbackup tool.
|
| org.opends.server.tools.status |
Defines the classes that are you used by the status command line.
|
| org.opends.server.tools.supportextract |
Contains the classes that are used by the supportextract tool.
|
| org.opends.server.tools.tasks |
This package contains classes that support client tool interaction with the tasks backend.
|
| org.opends.server.tools.upgrade |
Defines the specific classes that are used by the upgrade tool.
|
| 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.
|
| org.slf4j.impl |
Classes needed by SLF4J to choose actual implementation of SLF4J API.
|