All Classes and Interfaces
Class
Description
Class representation of an AccessPoint.
ACIRegion: A region of the DIT which is affected by ACI.
Types for ACIRegion
Cut-down subtree specification used by access-control: i.e.
An ACI tuple, with context and references back to its source.
Authentication level enumeration.
Operations.
ACIWorld: a representation of all the ACI-related data for the
whole DIT.
Representation of an add-attribute.
An AddEntry is used to store the contents of an entry to add to the
directory.
Class representation of a Synonym value.
This class contains admin point management related utility methods.
A shadow agreement is uniquely identified with three pieces of
information, which are held in an AgreementTuple.
This class provides functions for conversion between native
Java-DSAPI types and the generated Java-ASN types.
This class provides various static methods that allow ATNds functionality.
An object which returns the result of an ATNds conversion.
Representation of an attribute.
An AttributeBlock is a way of saving a structured set of key/value pairs in a BindProfile.
Representation of an attribute type.
Representation of a single attribute value.
Thrown when an attempt is made to use a presentation address
which is invalid.
An exception thrown as a result of an attempt to use an invalid
attribute type.
A class representing an exception which can be thrown as a result of
an attempt to use an illegal Distinguished Name or Relative Distinguished
Name
A class representing an exception which can be thrown as a result
of an attempt to use an entry which is invalid for some reason, for
some particular purpose.
A class representing an exception which can be thrown as a result of
an attempt to use an illegal search filter in a search operation
Exception thrown when something is wrong with SaslID
A class representing an exception which can be thrown as a result of
an attempt to use an illegal or inappropriate syntax
A class representing an exception which can be thrown as a result of
an attempt to use an attribute with an illegal value.
BindParams is a class which wraps the DS_BindParams structure.
This class provides a way to keep track of a set of information about
a Directory to which a user might want to bind.
Convenience class used to encapsulate the result of creating and
binding to a Directory.
This class stores information about a bind profile address in the following
categories: LDAP URI, LDAPS URI, presentation address containing only a
single ITOT network address (DAP), other valid presentation addresses
(Advanced) and any other string that does not fit into the categories before
(Other).
An enumeration defining the different address types that can be used to
create a bind profile.
BindProfileCLI.
This class maintains a collection of BindProfile objects which are
stored on disk in between separate invocations of an application.
Applications which want to encrypt arbitrary data in "multisetting"
or "setting" parameters using the BPL passphrase must implement this
interface, which will be used when the BPL is loaded/stored.
The remove mode for
BindProfileList.removeBindProfile(BindProfile, RemoveMode),
indicating how it should respond if it encounters a profile that
may be referenced by another profile.Utility class which just stores information about a substring inside
another String.
Interface to be implemented by applications that want to get notified if the
Isode bind profile has been modified by an external program.
Interface to provide a method for actions that would be done post
the user's selection of the action on noticing the bind profile modification
General utility class for bind profile
Directory Bind Types.
This class contains definitions for string literals related to things
found in BindProfiles.
Used to indicate a failure in the native library when deriving keys for
encryption or decryption.
Isode chain policy.
An abstract class which acts to group the four different types of
change-entries found on an LDIF file: ModifyEntry, AddEntry,
DeleteEntry and RenameEntry.
A CommonArgs object contains a set of values, some boolean and some
integers, which may be used to specify extra information about how a
given directory operation should be performed.
ConfigEntry represents the root configuration entry (cn=config).
Stores the various configuration data.
This is a list of config data short-hands that users can use to load that
type of config data.
A class representing an exception which can be thrown as a result of a local
requested operation failing.
Utility methods.
A connection was lost during an attempt to perform a directory
operation.
Consumer agreement object.
Provides static methods to expose native encryption functionality
implemented using OpenSSL.
DataNodeDSAPIReader allows to read other than String data types
(especially DS API related data types) from DataNode.
Representation of a delete-attribute.
An exception thrown when applying a ModifyEntry to an Entry in the
case that a DeleteAttribute specifies deletion of an
attribute-value which is not present in the target Entry.
A DeleteEntry is used to represent the deletion of an entry on the
directory.
Recursive delete of a directory subtree, optionally including the
start DN.
Iterate through all entries meeting the given conditions within a
directory subtree.
Interface for iterating through directory-data, one DN or Entry or
ChangeEntry at a time.
Exception used to indicate unexpected failures in
directory-scans.
Exception used to indicate unexpected failures in
directory-scans.
Thrown when an an error is returned from the underlying DSAPI
library which indicates that an error resulted from an attempt
to perform a directory operation.
Iterate through a directory subtree, returning Entry instances one
by one, ordered with parents immediately before children.
Iterate through a directory subtree, returning DNs one by one,
ordered with parents immediately before children.
Each DirectorySession object represents a connection to a
particular directory.
Used to report the state of a session: whether and how it is bound.
A PendingOperation object keeps track of an asynchronous directory
operation.
A SessionCertificates object is used to return information about the
certificates presented by a server during a strong bind (either DAP
or LDAP/TLS negotiation).
Class representation of an DLSubmitPermission value.
Used to identify what kind of DLSubmitPermission we have
Class representing a Distinguished Name.
A class which contains a set of DNs stored in memory in a very
compact form (backed by a DS_DNIndex).
DSACreationTemplate, specifying all the data required to create and
initialise a DSA from nothing to a working configuration.
Admin point information.
DN parameter for template.
Type of DSA to be created.
Mandatory group
Naming context GDAM overrides.
Optional group
Optional rule
Limit on optional rules.
This enum stores the supported password hash schemes in the DSA -
obtained from lib/syntax/x500/passwd.c.
Password parameter.
User bind-profile to create.
This class provides miscellaneous static methods which may
be useful to Java DSAPI clients
Base class representing exception conditions that can be
thrown by Java DSAPI classes.
A utility class for DSAPI related functionality
A utility class for X.509/Crypto functions using DSAPI
DSASetup.
Class to store info about an upgraded DSA.
DSASetupCLI.
This class contains AttributeTypes that are used statically within
Java-DSAPI.
This class contains useful constants.
All knowledge entries in the DSAIT cache.
DSE type.
Enum for DSEType flags.
A class which encapsulates a normal non-change entry.
Class to represent subjectAltNames and Extensions values
derived from the Directory Entry
Class to contain DNs and (optionally) objectclasses to load up into the DIT
tree, and also to allow them to be sorted.
Utility class which can be used to keep list of Entries which in comparison
to Indication can support sorting
Boolean attribute comparator for use with EntryList class
Boolean comparator for use with EntryList class
Integer attribute comparator for use with EntryList class
Integer comparator for use with EntryList class
String attribute comparator for use with EntryList class
String comparator for use with EntryList class
Convenience class making easy to read value(s) from entry.
The EntryWriter class provides a simple way to build an Entry
object which can then to be written to a directory.
Failover agreement object.
Class representation of a FailoverContext value.
Failover entry stored in the directory session.
FailoverGroups is a class which keeps track of all application-wide
information which has been discovered about failover DSAs.
Contains information about something that's not right.
Listener which can be used for callers who wish to be notified when
the contents of the FailoverGroups have changed in some way
Failover manager manages the failover related data stored in the directory
session.
FetchTokenReq
GDAMEntry represents a GDAM database entry.
GDAM manager manages the various GDAM entries stored in the directory
session.
GDAM types.
This class stores utilities for validating an address containing a host name
& port.
An abstract class which is used to provide the framework for different types
of entries that may be encountered when interacting with directories and
processing LDIF files.
Class representation of an GlobalDomainIdentifier.
Class representation of a IdentifiedDN value.
Identity is a class which wraps the DS_Identity structure.
Class for managing a unique id value
Thrown when a read operation completes with no errors, but its
indication contains information to suggest that the read result may
not be reliable (for example, a limit error was encountered).
Incorrect version exception if DSA version is not as expected.
IndexEntry represents an index entry in a GDAM.
Index match types.
Index state.
An Indication contains information about a directory operation.
A convenience class which contains any information from
a password policy response that was returned as part of the Indication
from a directory server.
Values that may be returned from a call to getPasswordPolicyErrorCode.
Represents an error that is derived from a DS_Indication in the underlying
DSAPI code.
ISeqEntry is an interface that both SeqEntry and MapEntry
implement, covering just the SeqEntry features.
This class contains definitions and methods to allow applications to
access the "isode-wide" bind profile file.
Allows a callback to be made following the upgrading of a bindprofiles
file.
This class subclasses DirectorySession to provide extra functionality
which is specific to Isode applications, but does not need to be
part of the public java-dsapi interface.
This enum indicates the DSA version of the Isode directory or Unknown.
This is an abstract class used to help deal with syntaxes for which an
ASN definition is available in isode-asn.
A SyntaxInfo keeps track of various information that the
IsodeSyntax class uses to process string representations
of the values.This class provides methods to log messages for
the javadsapimsg facility.
This class provides a Handler which when attached to a Logger
which will cause messages to be sent to the Isode logging system
using the javadsapimsg facility.
This class wraps the LDAP Changelog entry stored in the directory session.
Decodes LDAP messages passed to the Decoder.
Exception thrown by
LDAPDecoderEngine if there
is an error decoding the message.LDAP Filter validation, querying and conversion to other formats;
see RFC4515.
Tri-state boolean for filter evaluation.
Collects LDAP and SASL related configuration specifying directory location
bind credentials and provides directory session.
LDAP Profile Exception (configuration errors).
A class which enables loading and saving of records from/to LDIF
files.
LDIF dump: for the list of DNs provided by the given
DirectoryIterator, read the entries from the directory and dump
them to the given LDIF file.
LDIF Load.
Interface for a class which allows an LDIF dump to select whether a
particular entry should be included in the dump or not.
Class representing DSA's logging configuration streams
A managed object corresponds with a logical configuration object, e.g.
MapEntry is a JNI-free representation of an entry designed for fast
random access to attributes, designed for extensively modifying an
entry in place.
Class representation of MASAP.
This class should be used when loading bind profiles for MConsole, so that
data in the bind profile which is sensitive is properly encrypted/decrypted
using the bind profile passphrase.
MESH keeps track of configuration information related to the
multimaster configuration.
Object representing per-group state.
Set of distinct MESH groups (where a group is all of the servers in
a particular MESH configuration).
Object representing per-group state.
Object representing per-server state.
Top-level object returned to callers.
MESHAgreementReport encapsulates the reported state of a MESH agreement.
MESH (multimaster) configuration entry representation.
Manages MESH (multimaster) related configuration.
MESHServerReport encapsulates the reported state of a MESH server (as
reported a particular multimaster server).
This class should be used when loading bind profiles for MLC, so that
data in the bind profile which is sensitive is properly encrypted/decrypted
using the bind profile passphrase.
A ModifyEntry is used to store a list of modifications to the
attributes within an Entry.
The MonitorMode syntax is a bit string.
Enum for MonitorMode flags.
This class stores information about a MOSAP.
An enumeration defining the different categories that can be used to
create a MOSAP.
Class representation of an MTAInfo value.
Represents the AEInfo structure inside an MTAInfo
A mutable version of an ACI tuple.
This exception will be thrown when an unrecoverable error has been detected
inside the native DSAPI library.
Utility class for creating and managing
Nettraces in dsapi.This class stores information about a network address in the following
formats: TELEX, URI and OTHER.
An enumeration defining the different address formats that can be used to
create a network address.
An enumeration defining the different address types that can be used to
create a network address.
Thrown when an attempt is made to request the next page of results
from a paged-results search operation but no further results
are available.
Thrown when an attempt is made to access a named attribute which
does not exist.
Thrown when an attempt is made to perform an operation on
a non-existent entry in the directory.
Thrown when an attempt is made to reference a pending asynchronous operation,
but the operation does not exist (either it never existed, or it did
exist but has been completed).
Thrown when a bind attempt fails, or an attempt is made
to communicate with the directory before a successful bind
has been performed, or after a connection has been lost.
An exception thrown when an attempt is made to perform an operation
that is not implemented.
This class wraps an OAuth configuration entry stored.
Representation of a set of object classes.
Class for efficiently storing a list of objectclasses, providing
various simple operations on them.
This class wraps the OCSP configuration entry.
OCSPServiceManager handles the OCSP service configuration entries.
A class representing an exception which can be thrown as a result
of a local requested operation failing.
Class representation of an O/R address.
Class representation of an ORName value.
This class contains ASN1 Encoders and Decoders for the types that are not supported by Bouncy castle.
This class encapsulates a set of settings relating to the password policy
as retrieved from the DSA.
An AccountIssue represents a problem that means an account will be locked,
and contains a LOCK_REASON as well as an Object which gives more information
about the LOCK_REASON.
Enum representing possible problems with a particular account.
Peer authentication data.
Authentication types for peer authentication, as used in attributes such as
isodeDISPAuthModeISend.
PeerEntry represents a peer DSA configuration entry.
Peer DSA manager manages the various peer DSA entries stored in the directory
session.
Convenience class that wraps information about a CertificateRequest
and associated Key in a single object representing an Identity
that the user has started to create but that he hasn't yet been
matched with a certificate from a CA.
Permission bit number enumeration and mapping to/from ASN
bit-numbers.
Class representation of an PresentationAddress value.
A class which enables random-access to LDIF files for both reading
and writing.
Class representing an RDN.
A class representing an exception which can be thrown as a result of a
database read operation failing.
Class representation of a Redirect value.
Enumerated values representing RedirectionReason.
Class representation of an RedirectFilter value.
Enumerated values representing RedirectionReason.
Class representing information extracted from a referral error or a
continuation reference.
Class representing an address returned as one of the alternative locations
to try when a directory server returns a referral.
Thrown when a directory is unable to fulfil a request but returns
a referral which includes information about what other directory servers
may be able to do so.
A RenameEntry is used to represent a modify-DN or modify-RDN change
to the directory.
Representation of a replace-attribute.
Class representation of an RoutingFilter value.
Class representation of an RTSCredentials value.
Provides static access to AttributeTypes specific to SASL.
SASL Configuration.
Exception used on errors existing in SASL configuration.
Basic SASL-related exception
Utility class to test and manage SASL ID.
SASL ID to directory mapping (non-GSSAPI - generic only).
Exception used for errors at SaslMapping.
Enum for holding various types of SASL mechanisms.
SASLParameters is a class which contains a collection of parameters that are
used for a SASL bind.
A convenience class for managing a min/max SSF (Security
Strength Factor) pair.
When stored in a BindProfile file, callback parameters will only be
written in encrypted form.
This class contains schema information relating to schema (syntax IDs,
attribute types and object classes), as well as other values that can
be initialised once-and-for-all at application startup.
Class containing a collection of objects implementing an interface
SchemaObjects.AttrWrapper to get
properties of an attribute of D3 DSA like attribute types, default values etc.Base Class for representing a schema object for an attribute type
Base class for representing an attribute type containing a value
of attribute type
Base class for representing a Boolean attribute type
Base class for representing a BER attribute type
Base class for representing a DN attribute type
Base class for representing an Integer attribute type
Base class for representing a multi-valued attribute type
Base class for representing a String attribute type
Representation of an attribute selection (used in directory
searches and reads).
Convenience enums to be used when creating a Selection object.
This class stores information about a presentation address selector in the
following formats: HEX and IA5.
An enumeration defining the different address formats that can be used to
create a selector.
SeqEntry is a JNI-free representation of an Entry designed for fast
sequential processing of attributes.
Shadow agreement object.
The codes here correspond to those defined in
apps/d3/shadow/ShadowError.h
Note: Probably this should be generated automatically but it's not clear
how to make swig generate enum types.
Shadow agreement manager manages the various entries stored in the directory
session.
Thrown when a signed operation fails.
Called to handle signature verification failures.
Representation of set of regions in the DIT.
Chop-point within a Region.
List of chop-points.
Representation of a region of the DIT.
A simple-ACI item consisting of a role, rule and area.
Simple ACI role.
Minimum authentication levels.
Representation a rule, which is a list of ACI tuples without role
or area information.
Representation of one rule tuple
Representation of all the ACI for the whole DIT using a much
simplified model compared to ACIWorld.
ACSA: Access Control Specific Area.
Type of ACSA.
Interface of code that filters a list of ACSA DNs down to the
set that should be loaded up.
List of ACSAs.
Error or warning message, with attached DN and/or exception.
Specifies an attribute value substitution
This class provides a specification of how attribute values should be
substituted when LDIF data is being loaded into the DSA.
Supplier agreement object.
This class stores information about a network address in the TELEX format.
A IsodeDirectorySession that has a Nettrace attached to it.
Thrown when an attempt is made to perform an operation using an
extension which the directory server is unwilling or unable
to support
Exception thrown by EntryReader in situation when read attribute
is not supposed to be multivalued and it is
This class stores information about a network address in the URI format.
A connection was abandoned by the library because verification of
the server's certificate failed.