Element Summary

Element	Description	Class
aciAuthorizationInterceptor	An ACI based authorization service.	org.apache.directory.server.core.authz.AciAuthorizationInterceptor
apacheDS	Apache Directory Server top level.	org.apache.directory.server.configuration.ApacheDS
authenticationInterceptor	An {@link Interceptor} that authenticates users.	org.apache.directory.server.core.authn.AuthenticationInterceptor
certGenerationRequestHandler	An extended handler for digital certificate generation	org.apache.directory.server.ldap.handlers.extended.CertGenerationRequestHandler
changeLogInterceptor	An interceptor which intercepts write operations to the directory and logs them with the server's ChangeLog service. Note: Adding/deleting a tag is not recorded as a change	org.apache.directory.server.core.changelog.ChangeLogInterceptor
changePasswordServer	Contains the configuration parameters for the Change Password protocol provider.	org.apache.directory.server.changepw.ChangePasswordServer
collectiveAttributeInterceptor	An interceptor based service dealing with collective attribute management. This service intercepts read operations on entries to inject collective attribute value pairs into the response based on the entires inclusion within collectiveAttributeSpecificAreas and collectiveAttributeInnerAreas.	org.apache.directory.server.core.collective.CollectiveAttributeInterceptor
cramMd5MechanismHandler	The CRAM-MD Sasl mechanism handler.	org.apache.directory.server.ldap.handlers.bind.cramMD5.CramMd5MechanismHandler
defaultAuthorizationInterceptor	An {@link Interceptor} that controls access to {@link DefaultPartitionNexus}. If a user tries to perform any operations that requires permission he or she doesn't have, {@link NoPermissionException} will be thrown and therefore the current invocation chain will terminate.	org.apache.directory.server.core.authz.DefaultAuthorizationInterceptor
defaultDirectoryService	Default implementation of {@link DirectoryService}.	org.apache.directory.server.core.DefaultDirectoryService
defaultJournalStore		org.apache.directory.server.core.journal.DefaultJournalStore
digestMd5MechanismHandler	The DIGEST-MD5 mechanism handler.	org.apache.directory.server.ldap.handlers.bind.digestMD5.DigestMd5MechanismHandler
dnsServer	Contains the configuration parameters for the DNS protocol provider.	org.apache.directory.server.dns.DnsServer
eventInterceptor	An {@link Interceptor} based service for notifying {@link DirectoryListener}s of changes to the DIT.	org.apache.directory.server.core.event.EventInterceptor
exceptionInterceptor	An {@link org.apache.directory.server.core.interceptor.Interceptor} that detects any operations that breaks integrity of {@link Partition} and terminates the current invocation chain by throwing a {@link Exception}. Those operations include when an entry already exists at a DN and is added once again to the same DN.	org.apache.directory.server.core.exception.ExceptionInterceptor
extendedOperationHandler	An extension (hook) point that enables an implementor to provide his or her own LDAP 'Extended' operation.	org.apache.directory.server.ldap.ExtendedOperationHandler
gracefulShutdownHandler		org.apache.directory.server.ldap.handlers.extended.GracefulShutdownHandler
gssapiMechanismHandler	The GSSAPI Sasl mechanism handler.	org.apache.directory.server.ldap.handlers.bind.gssapi.GssapiMechanismHandler
httpServer	Class to start the jetty http server	org.apache.directory.server.integration.http.HttpServer
jdbmIndex	A Jdbm based index implementation.	org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmIndex
jdbmPartition	A {@link Partition} that stores entries in JDBM database.	org.apache.directory.server.core.partition.impl.btree.jdbm.JdbmPartition
journalInterceptor	An interceptor which intercepts write operations to the directory and logs them into a journal.	org.apache.directory.server.core.journal.JournalInterceptor
kdcServer	Contains the configuration parameters for the Kerberos protocol provider.	org.apache.directory.server.kerberos.kdc.KdcServer
keyDerivationInterceptor	An {@link Interceptor} that creates symmetric Kerberos keys for users. When a 'userPassword' is added or modified, the 'userPassword' and 'krb5PrincipalName' are used to derive Kerberos keys. If the 'userPassword' is the special keyword 'randomKey', a random key is generated and used as the Kerberos key.	org.apache.directory.server.core.kerberos.KeyDerivationInterceptor
launchDiagnosticUiHandler		org.apache.directory.server.ldap.handlers.extended.LaunchDiagnosticUiHandler
ldapServer	An LDAP protocol provider implementation which dynamically associates handlers.	org.apache.directory.server.ldap.LdapServer
memoryChangeLogStore	A change log store that keeps it's information in memory.	org.apache.directory.server.core.changelog.MemoryChangeLogStore
normalizationInterceptor	A name normalization service. This service makes sure all relative and distinguished names are normalized before calls are made against the respective interface methods on {@link DefaultPartitionNexus}. The Filters are also normalized. If the RDN AttributeTypes are not present in the entry for an Add request, they will be added.	org.apache.directory.server.core.normalization.NormalizationInterceptor
ntlmMechanismHandler	A handler for the NTLM Sasl and GSS-SPNEGO mechanism. Note that both mechanisms require an NTLM mechanism provider which could be implemented using jCIFS or native Win32 system calls via a JNI wrapper.	org.apache.directory.server.ldap.handlers.bind.ntlm.NtlmMechanismHandler
ntpServer	Contains the configuration parameters for the NTP protocol provider.	org.apache.directory.server.ntp.NtpServer
operationalAttributeInterceptor	An {@link Interceptor} that adds or modifies the default attributes of entries. There are four default attributes for now; `'creatorsName'`, `'createTimestamp'`, `'modifiersName'`, and `'modifyTimestamp'`.	org.apache.directory.server.core.operational.OperationalAttributeInterceptor
passwordPolicyInterceptor	An {@link Interceptor} that enforces password policy for users. Add or modify operations on the 'userPassword' attribute are checked against a password policy. The password is rejected if it does not pass the password policy checks. The password MUST be passed to the core as plaintext.	org.apache.directory.server.core.kerberos.PasswordPolicyInterceptor
plainMechanismHandler	A handler for the PLAIN Sasl mechanism.	org.apache.directory.server.ldap.handlers.bind.plain.PlainMechanismHandler
referralInterceptor	An service which is responsible referral handling behavoirs. It manages referral handling behavoir when the {@link Context#REFERRAL} is implicitly or explicitly set to "ignore", when set to "throw" and when set to "follow".	org.apache.directory.server.core.referral.ReferralInterceptor
replicaPeerConfiguration	A configuration for a replica peer. We may have many replications relation set for a server, each one of them being described with this structure.	org.apache.directory.server.ldap.replication.ReplicaPeerConfiguration
replicationSystem	The replication sub-system.	org.apache.directory.server.ldap.replication.ReplicationSystem
schemaInterceptor	An {@link org.apache.directory.server.core.interceptor.Interceptor} that manages and enforces schemas.	org.apache.directory.server.core.schema.SchemaInterceptor
simpleMechanismHandler	A Dummy mechanism handler for Simple mechanism: not really used but needed for the mechanism map.	org.apache.directory.server.ldap.handlers.bind.SimpleMechanismHandler
standardThreadPool		org.apache.directory.server.protocol.shared.StandardThreadPool
startTlsHandler	Handler for the StartTLS extended operation.	org.apache.directory.server.ldap.handlers.extended.StartTlsHandler
storedProcedureExtendedOperationHandler		org.apache.directory.server.ldap.handlers.extended.StoredProcedureExtendedOperationHandler
subentryInterceptor	The Subentry interceptor service which is responsible for filtering out subentries on search operations and injecting operational attributes	org.apache.directory.server.core.subtree.SubentryInterceptor
tcpTransport		org.apache.directory.server.protocol.shared.transport.TcpTransport
triggerInterceptor	The Trigger Service based on the Trigger Specification.	org.apache.directory.server.core.trigger.TriggerInterceptor
udpTransport		org.apache.directory.server.protocol.shared.transport.UdpTransport
webApp	A class to configure a web application	org.apache.directory.server.integration.http.WebApp

Element Detail

Element: aciAuthorizationInterceptor

Element: apacheDS

Attribute	Type	Description
ldifDirectory	xs:string	Get the directory where
synchPeriodMillis	xs:long

Element	Type	Description
ldapServer	ldapServer

Element: authenticationInterceptor

Element	Type	Description
authenticators	(<spring:bean/>)*

Element: certGenerationRequestHandler

Element	Type	Description
ldapServer	ldapServer

Element: changeLogInterceptor

Element: changePasswordServer

Attribute	Type	Description
allowableClockSkew	xs:long	Returns the allowable clock skew.
catelogBased	xs:boolean	Gets true if this service uses a catalog for searching different regions of the DIT for its data.
emptyAddressesAllowed	xs:boolean	Returns whether empty addresses are allowed.
enabled	xs:boolean	{@inheritDoc}
policyCategoryCount	xs:integer	Sets the policy category count - what's this?
policyPasswordLength	xs:integer	Sets the policy's minimum?? password length.
policyTokenSize	xs:integer	Sets the policy token size - what's this?
primaryRealm	xs:string	Returns the primary realm.
searchBaseDn	xs:string	Returns the search base DN.
servicePrincipal	xs:string	Returns the Change Password service principal.

Element	Type	Description
encryptionTypes	(<spring:bean/>)*	Returns the encryption types.
transports	tcpTransport \| udpTransport	Set the underlying transports

Element: collectiveAttributeInterceptor

Element: cramMd5MechanismHandler

Element: defaultAuthorizationInterceptor

Element: defaultDirectoryService

Attribute	Type	Description
accessControlEnabled	xs:boolean	Returns `true` if access control checks are enabled.
allowAnonymousAccess	xs:boolean	Returns `true` if anonymous access is allowed on entries besides the RootDSE. If the access control subsystem is enabled then access to some entries may not be allowed even when full anonymous access is enabled.
denormalizeOpAttrsEnabled	xs:boolean	return true if the operational attributes must be normalized when returned
exitVmOnShutdown	xs:boolean
instanceId	xs:string
maxPDUSize	xs:integer	Set the maximum allowed size for an incoming PDU
passwordHidden	xs:boolean	{@inheritDoc}
replicaId	xs:integer
shutdownHookEnabled	xs:boolean
syncPeriodMillis	xs:long
workingDirectory	xs:string	Returns working directory (counterpart of `var/lib`) where partitions are stored by default.

Element	Type	Description
changeLog	<spring:bean/>	{@inheritDoc}
eventService	<spring:bean/>
interceptors	(<spring:bean/>)*	Returns interceptors in the server.
journal	<spring:bean/>	{@inheritDoc}
partitions	(<spring:bean/>)*	Gets the {@link Partition}s used by this DirectoryService.
referralManager	<spring:bean/>	Set the referralManager
replicationConfiguration	<spring:bean/>
schemaManager	<spring:bean/>	Set the SchemaManager instance.
schemaService	<spring:bean/>
systemPartition	jdbmPartition
testEntries	(<spring:bean/>)*	Returns test directory entries({@link LdifEntry}) to be loaded while bootstrapping.

Element: defaultJournalStore

Attribute	Type	Description
fileName	xs:string
workingDirectory	xs:string	{@inheritDoc}

Element: digestMd5MechanismHandler

Element: dnsServer

Attribute	Type	Description
catelogBased	xs:boolean	Gets true if this service uses a catalog for searching different regions of the DIT for its data.
enabled	xs:boolean	{@inheritDoc}
searchBaseDn	xs:string	Returns the search base DN.

Element	Type	Description
transports	tcpTransport \| udpTransport	Set the underlying transports

Element: eventInterceptor

Element: exceptionInterceptor

Element: extendedOperationHandler

Element	Type	Description
ldapServer	ldapServer	Sets the LDAP server for this extendedOperation handler.

Element: gracefulShutdownHandler

Element	Type	Description
ldapServer	ldapServer

Element: gssapiMechanismHandler

Element: httpServer

Attribute	Type	Description
confFile	xs:string
port	xs:integer

Element	Type	Description
webApps	(<spring:bean/>)*

Element: jdbmIndex

Attribute	Type	Description
attributeId	xs:string	Gets the attribute identifier set at configuration time for this index which may not be the OID but an alias name for the attributeType associated with this Index
cacheSize	xs:integer	Gets the size of the index cache in terms of the number of index entries to be cached.
numDupLimit	xs:integer	Gets the threshold at which point duplicate keys use btree indirection to store their values.
wkDirPath	xs:string	Gets the working directory path to something other than the default. Sometimes more performance is gained by locating indices on separate disk spindles.

Element: jdbmPartition

Attribute	Type	Description
cacheSize	xs:integer
id	xs:string
optimizerEnabled	xs:boolean
partitionDir	xs:string
suffix	xs:string
syncOnWrite	xs:boolean

Element	Type	Description
aliasIndexOn	jdbmIndex
indexedAttributes	(<spring:bean/>)*
ndnIndexOn	jdbmIndex
oneAliasIndexOn	jdbmIndex
oneLevelIndexOn	jdbmIndex
presenceIndexOn	jdbmIndex
schemaManager	<spring:bean/>
subAliasIndexOn	jdbmIndex
updnIndexOn	jdbmIndex

Element: journalInterceptor

Element: kdcServer

Attribute	Type	Description
allowableClockSkew	xs:long	Returns the allowable clock skew.
bodyChecksumVerified	xs:boolean
catelogBased	xs:boolean	Gets true if this service uses a catalog for searching different regions of the DIT for its data.
emptyAddressesAllowed	xs:boolean
enabled	xs:boolean	{@inheritDoc}
forwardableAllowed	xs:boolean
kdcPrincipal	xs:string
maximumRenewableLifetime	xs:long
maximumTicketLifetime	xs:long
paEncTimestampRequired	xs:boolean	Returns whether pre-authentication by encrypted timestamp is required.
postdatedAllowed	xs:boolean
primaryRealm	xs:string	Returns the primary realm.
proxiableAllowed	xs:boolean
renewableAllowed	xs:boolean
searchBaseDn	xs:string	Returns the search base DN.

Element	Type	Description
encryptionTypes	(<spring:bean/>)*	Returns the encryption types.
transports	tcpTransport \| udpTransport	Set the underlying transports

Element: keyDerivationInterceptor

Element: launchDiagnosticUiHandler

Element	Type	Description
ldapServer	ldapServer

Element: ldapServer

Attribute	Type	Description
allowAnonymousAccess	xs:boolean	Returns `true` if anonymous access is allowed.
catelogBased	xs:boolean	Gets true if this service uses a catalog for searching different regions of the DIT for its data.
certificatePassword	xs:string	Set the certificate passord.
confidentialityRequired	xs:boolean	Gets whether or not TLS secured connections are required to perform operations on this LdapServer.
enabled	xs:boolean	{@inheritDoc}
keystoreFile	xs:string	Set the external keystore path
maxSizeLimit	xs:long	Returns the maximum size limit in number of entries to return for search.
maxTimeLimit	xs:integer	Returns the maximum time limit in milliseconds to conduct a search.
saslHost	xs:string	Returns the FQDN of this SASL host, validated during SASL negotiation.
saslPrincipal	xs:string	Returns the Kerberos principal name for this LDAP service, used by GSSAPI.
searchBaseDn	xs:string	Returns the search base DN.

Element	Type	Description
directoryService	defaultDirectoryService
extendedOperationHandlers	(certGenerationRequestHandler \| extendedOperationHandler \| gracefulShutdownHandler \| launchDiagnosticUiHandler \| startTlsHandler \| storedProcedureExtendedOperationHandler)*	Gets the {@link ExtendedOperationHandler}s.
replicationSystem	replicationSystem
saslMechanismHandlers	<spring:bean/>
saslRealms	(<spring:bean/>)*	Returns the realms serviced by this SASL host, used by DIGEST-MD5 and GSSAPI.
transports	tcpTransport \| udpTransport	Set the underlying transports

Element: memoryChangeLogStore

Element: normalizationInterceptor

Element: ntlmMechanismHandler

Attribute	Type	Description
ntlmProviderFqcn	xs:string

Element	Type	Description
ntlmProvider	<spring:bean/>

Element: ntpServer

Attribute	Type	Description
enabled	xs:boolean	{@inheritDoc}

Element	Type	Description
transports	tcpTransport \| udpTransport	Set the underlying transports

Element: operationalAttributeInterceptor

Element: passwordPolicyInterceptor

Element: plainMechanismHandler

Element: referralInterceptor

Element: replicaPeerConfiguration

Attribute	Type	Description
interval	xs:long	Set the delay between two RefreshOnly replication. Its given in seconds.
password	xs:string
refreshOnly	xs:boolean	Set the type of replication wanted. If false, it will default to RefreshAndPersist.

Element	Type	Description
principalDN	<spring:bean/>
producer	<spring:bean/>

Element: replicationSystem

Element	Type	Description
replicaPeers	(<spring:bean/>)*	Set the list of replica peers this server is connected to

Element: schemaInterceptor

Element: simpleMechanismHandler

Element: standardThreadPool

Attribute	Type	Description
maxThreads	xs:integer

Element: startTlsHandler

Element	Type	Description
ldapServer	ldapServer

Element: storedProcedureExtendedOperationHandler

Element	Type	Description
ldapServer	ldapServer

Element: subentryInterceptor

Element: tcpTransport

Attribute	Type	Description
address	xs:string	{@inheritDoc}
backLog	xs:integer	{@inheritDoc}
enableSSL	xs:boolean	Enable or disable SSL
nbThreads	xs:integer	{@inheritDoc}
port	xs:integer	{@inheritDoc}
tcpPort	xs:integer	The port

Element: triggerInterceptor

Element: udpTransport

Attribute	Type	Description
address	xs:string	{@inheritDoc}
backLog	xs:integer	{@inheritDoc}
enableSSL	xs:boolean	Enable or disable SSL
nbThreads	xs:integer	{@inheritDoc}
port	xs:integer	{@inheritDoc}
udpPort	xs:integer	The port

Element: webApp

Attribute	Type	Description
contextPath	xs:string
warFile	xs:string