DefaultDirectoryService

java.lang.Object
- org.apache.directory.server.core.DefaultDirectoryService

All Implemented Interfaces:

DirectoryService, ServerEntryFactory
```
public class DefaultDirectoryService
extends java.lang.Object
implements DirectoryService
```
Default implementation of DirectoryService.

Field Summary

Fields
Modifier and Type	Field and Description
`private org.apache.directory.api.ldap.util.tree.DnNode<AccessControlAdministrativePoint>`	`accessControlAPCache` The AccessControl AdministrativePoint cache
`private boolean`	`accessControlEnabled` Manage the basic access control checks
`private org.apache.directory.api.ldap.model.name.Dn`	`adminDn` the distinguished name of the administrative user
`private CoreSession`	`adminSession` session used as admin for internal operations
`private boolean`	`allowAnonymousAccess` Manage anonymous access to entries other than the RootDSE
`private AttributeTypeProvider`	`atProvider` The attribute type provider
`private CacheService`	`cacheService` the ehcache based cache service
`private ChangeLog`	`changeLog` the change log service
`private org.apache.directory.api.ldap.util.tree.DnNode<CollectiveAttributeAdministrativePoint>`	`collectiveAttributeAPCache` The CollectiveAttribute AdministrativePoint cache
`private org.apache.directory.api.ldap.model.csn.CsnFactory`	`csnFactory` The service's CSN factory
`private static long`	`DEFAULT_SYNC_PERIOD` The default delay to wait between sync on disk : 15 seconds
`private boolean`	`denormalizeOpAttrsEnabled` Manage the operational attributes denormalization
`private DnFactory`	`dnFactory` The Dn factory
`private SubtreeEvaluator`	`evaluator` The Subtree evaluator instance
`private EventService`	`eventService` The event service
`private boolean`	`exitVmOnShutdown` A flag used to shutdown the VM when stopping the server.
`private boolean`	`firstStart` whether or not server is started for the first time
`private java.lang.String`	`instanceId` The instance Id
`private InstanceLayout`	`instanceLayout` The server directory layout
`private java.util.Map<java.lang.String,Interceptor>`	`interceptorNames`
`private java.util.List<Interceptor>`	`interceptors` The list of declared interceptors
`private java.util.concurrent.locks.ReadWriteLock`	`interceptorsLock` A lock to protect the interceptors List
`private Journal`	`journal` the journal service
`private org.apache.directory.api.ldap.codec.api.LdapApiService`	`ldapCodecService` The LDAP Codec Service
`private static java.lang.String`	`LOCK_FILE_NAME`
`private java.io.RandomAccessFile`	`lockFile` lock file for directory service's working directory
`private static org.slf4j.Logger`	`LOG` The logger
`static int`	`MAX_SIZE_LIMIT_DEFAULT` The default timeLimit : 100 entries
`static int`	`MAX_TIME_LIMIT_DEFAULT` The default timeLimit : 10 seconds
`private int`	`maxPDUSize` The maximum size for an incoming PDU
`private ObjectClassProvider`	`ocProvider` The object class provider
`private java.util.Map<OperationEnum,java.util.List<java.lang.String>>`	`operationInterceptors` A map associating a list of interceptor to each operation
`private OperationManager`	`operationManager` the interface used to perform various operations on this DirectoryService
`private static java.lang.String`	`PARTIAL_IMPL_WARNING` remove me after implementation is completed
`private DefaultPartitionNexus`	`partitionNexus` the root nexus
`private java.util.Set<Partition>`	`partitions` The set of all declared partitions
`private boolean`	`passwordHidden` A flag to tell if the userPassword attribute's value must be hidden
`private java.util.concurrent.locks.Lock`	`readLock` The read and write locks
`private ReferralManager`	`referralManager` The referral manager
`private int`	`replicaId` The directory instance replication ID
`private org.apache.directory.api.ldap.model.schema.SchemaManager`	`schemaManager` A reference on the SchemaManager
`private SchemaPartition`	`schemaPartition`
`private boolean`	`shutdownHookEnabled` A flag used to indicate that a shutdown hook has been installed
`private boolean`	`started` whether or not this instance has been shutdown
`(package private) SubentryCache`	`subentryCache` The Subentry cache
`private org.apache.directory.api.ldap.util.tree.DnNode<SubschemaAdministrativePoint>`	`subschemaAPCache` The Subschema AdministrativePoint cache
`private long`	`syncPeriodMillis` The delay to wait between each sync on disk
`private Partition`	`systemPartition` The System partition
`private java.util.List<? extends org.apache.directory.api.ldap.model.ldif.LdifEntry>`	`testEntries` A list of LDIF entries to inject at startup
`private org.apache.directory.api.ldap.util.tree.DnNode<TriggerExecutionAdministrativePoint>`	`triggerExecutionAPCache` The TriggerExecution AdministrativePoint cache
`private java.lang.Thread`	`workerThread`
`private java.util.concurrent.locks.Lock`	`writeLock`

Fields inherited from interface org.apache.directory.server.core.api.DirectoryService
JNDI_KEY

Constructor Summary

Constructors
Constructor and Description

DefaultDirectoryService()
Creates a new instance of the directory service.

Constructors
Constructor and Description
`DefaultDirectoryService()` Creates a new instance of the directory service.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAfter(java.lang.String interceptorName, Interceptor interceptor)` Add an interceptor after a given interceptor in the interceptor list.
`void`	`addFirst(Interceptor interceptor)` Add an interceptor in the first position in the interceptor list.
`private void`	`addInterceptor(Interceptor interceptor, int position)` Add an interceptor to the list of interceptors to call for each operation
`void`	`addLast(Interceptor interceptor)` Add an interceptor in the last position in the interceptor list.
`void`	`addPartition(Partition partition)`
`private boolean`	`createBootstrapEntries()` Returns true if we had to create the bootstrap entries on the first start of the server.
`private void`	`createTestEntries()` Adds test entries into the core.
`private void`	`gatherInterceptors(Interceptor interceptor, java.lang.Class<?> interceptorClz, OperationEnum operation, java.util.List<java.lang.String> selectedInterceptorList)` Recursively checks if the given interceptor can be added to the list of interceptors for a given operation and adds to the list of interceptors if it implements the respective operation
`org.apache.directory.api.ldap.util.tree.DnNode<AccessControlAdministrativePoint>`	`getAccessControlAPCache()`
`CoreSession`	`getAdminSession()`
`AttributeTypeProvider`	`getAtProvider()` Gets the `AttributeTypeProvider`.
`CacheService`	`getCacheService()`
`ChangeLog`	`getChangeLog()` Gets the ChangeLog service for this DirectoryService used for tracking changes (revisions) to the server and using them to revert the server to earlier revisions.
`org.apache.directory.api.ldap.util.tree.DnNode<CollectiveAttributeAdministrativePoint>`	`getCollectiveAttributeAPCache()`
`org.apache.directory.api.ldap.model.csn.Csn`	`getCSN()` Get a new CSN
`DnFactory`	`getDnFactory()` Gets the Dn factory.
`SubtreeEvaluator`	`getEvaluator()`
`EventService`	`getEventService()`
`java.lang.String`	`getInstanceId()`
`InstanceLayout`	`getInstanceLayout()` Returns the instance layout which contains the path for various directories
`Interceptor`	`getInterceptor(java.lang.String interceptorName)` Get an Interceptor instance from its name
`java.util.List<Interceptor>`	`getInterceptors()` Returns interceptors in the server.
`java.util.List<java.lang.String>`	`getInterceptors(OperationEnum operation)` Returns interceptors in the server for a given operation.
`Journal`	`getJournal()` Gets the Journal service for this DirectoryService used for tracking changes to the server.
`org.apache.directory.api.ldap.codec.api.LdapApiService`	`getLdapCodecService()`
`int`	`getMaxPDUSize()`
`ObjectClassProvider`	`getOcProvider()` Gets the `ObjectClassProvider`.
`OperationManager`	`getOperationManager()` Gets the operation manager.
`DefaultPartitionNexus`	`getPartitionNexus()`
`java.util.Set<? extends Partition>`	`getPartitions()` Gets the `Partition`s used by this DirectoryService.
`ReferralManager`	`getReferralManager()`
`int`	`getReplicaId()`
`org.apache.directory.api.ldap.model.schema.SchemaManager`	`getSchemaManager()`
`SchemaPartition`	`getSchemaPartition()`
`CoreSession`	`getSession()` Get back an anonymous session
`CoreSession`	`getSession(org.apache.directory.api.ldap.model.name.Dn principalDn, byte[] credentials)` Get back a session for the give user and credentials bound with Simple Bind
`CoreSession`	`getSession(org.apache.directory.api.ldap.model.name.Dn principalDn, byte[] credentials, java.lang.String saslMechanism, java.lang.String saslAuthId)` Get back a session for a given user bound with SASL Bind
`CoreSession`	`getSession(LdapPrincipal principal)` Get back a session for a given principal
`SubentryCache`	`getSubentryCache()`
`org.apache.directory.api.ldap.util.tree.DnNode<SubschemaAdministrativePoint>`	`getSubschemaAPCache()`
`long`	`getSyncPeriodMillis()`
`Partition`	`getSystemPartition()`
`java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry>`	`getTestEntries()` Returns test directory entries(`LdifEntry`) to be loaded while bootstrapping.
`org.apache.directory.api.ldap.util.tree.DnNode<TriggerExecutionAdministrativePoint>`	`getTriggerExecutionAPCache()`
`private void`	`initialize()` Kicks off the initialization of the entire system.
`private void`	`initializeSystemPartition()`
`private void`	`initInterceptors()` Initialize the interceptors
`private void`	`initOperationsList()` Compute the list of to call for each operation
`boolean`	`isAccessControlEnabled()` Returns `true` if access control checks are enabled.
`boolean`	`isAllowAnonymousAccess()` Returns `true` if anonymous access is allowed on entries besides the RootDSE.
`boolean`	`isDenormalizeOpAttrsEnabled()` return true if the operational attributes must be normalized when returned
`boolean`	`isExitVmOnShutdown()`
`boolean`	`isFirstStart()`
`boolean`	`isPasswordHidden()` Returns `true` if the service requires the userPassword attribute to be masked.
`boolean`	`isPwdPolicyEnabled()`
`boolean`	`isShutdownHookEnabled()` Checks to see if this DirectoryService has registered a JVM shutdown hook to flush caches and synchronize to disk safely.
`boolean`	`isStarted()` Returns `true` if this service is started.
`private void`	`lockWorkDir()` checks if the working directory is already in use by some other directory service, if yes then throws a runtime exception else will obtain the lock on the working directory
`private void`	`moddn(org.apache.directory.api.ldap.model.name.Dn oldDn, org.apache.directory.api.ldap.model.name.Dn newDn, boolean delOldRdn)` We handle the ModDN/ModRDN operation for the revert here.
`org.apache.directory.api.ldap.model.entry.Entry`	`newEntry(org.apache.directory.api.ldap.model.name.Dn dn)` Creates a new ServerEntry which has not yet been added to the directory.
`org.apache.directory.api.ldap.model.entry.Entry`	`newEntry(java.lang.String ldif, java.lang.String dn)` Create a new Entry
`private org.apache.directory.api.ldap.model.entry.Entry`	`readEntry(java.lang.String text)` Read an entry (without Dn)
`void`	`remove(java.lang.String interceptorName)` Remove an interceptor from the list of interceptors
`private void`	`removeOperationsList(java.lang.String interceptorName)` Remove an interceptor to the list of interceptors to call for each operation
`void`	`removePartition(Partition partition)`
`long`	`revert()` Reverts the server's state to the latest tagged snapshot if one was taken.
`long`	`revert(long revision)` Reverts the server's state to an earlier revision.
`void`	`setAccessControlEnabled(boolean accessControlEnabled)` Sets whether to enable basic access control checks or not.
`void`	`setAllowAnonymousAccess(boolean enableAnonymousAccess)` Sets whether to allow anonymous access to entries other than the RootDSE.
`void`	`setCacheService(CacheService cacheService)` Sets the CacheService
`void`	`setChangeLog(ChangeLog changeLog)` Sets the ChangeLog service for this DirectoryService used for tracking changes (revisions) to the server and using them to revert the server to earlier revisions.
`private void`	`setDefaultInterceptorConfigurations()` Define a default list of interceptors that has to be used if no other configuration is defined.
`void`	`setDenormalizeOpAttrsEnabled(boolean denormalizeOpAttrsEnabled)` Sets whether the operational attributes are denormalized when returned
`void`	`setDnFactory(DnFactory dnFactory)` Sets the Dn factory.
`void`	`setEventService(EventService eventService)`
`void`	`setExitVmOnShutdown(boolean exitVmOnShutdown)`
`void`	`setInstanceId(java.lang.String instanceId)`
`void`	`setInstanceLayout(InstanceLayout instanceLayout)` Sets the InstanceLayout used by the DirectoryService to store the files
`void`	`setInterceptors(java.util.List<Interceptor> interceptors)` Sets the interceptors in the server.
`void`	`setJournal(Journal journal)` Sets the journal in the server.
`void`	`setMaxPDUSize(int maxPDUSize)` Set the maximum allowed size for an incoming PDU
`void`	`setPartitions(java.util.Set<? extends Partition> partitions)` Sets `Partition`s used by this DirectoryService.
`void`	`setPasswordHidden(boolean passwordHidden)` Sets whether the userPassword attribute is readable, or hidden.
`void`	`setReferralManager(ReferralManager referralManager)` Set the referralManager
`void`	`setReplicaId(int replicaId)`
`void`	`setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)` Set the SchemaManager instance.
`void`	`setSchemaPartition(SchemaPartition schemaPartition)` Set the SchemaPartition
`void`	`setShutdownHookEnabled(boolean shutdownHookEnabled)` Sets the shutdown hook flag which controls whether or not this DirectoryService registers a JVM shutdown hook to flush caches and synchronize to disk safely.
`void`	`setSyncPeriodMillis(long syncPeriodMillis)` the time interval at which the DirectoryService's data is flushed to disk
`void`	`setSystemPartition(Partition systemPartition)`
`void`	`setTestEntries(java.util.List<? extends org.apache.directory.api.ldap.model.ldif.LdifEntry> testEntries)` Sets test directory entries(`Attributes`) to be loaded while bootstrapping.
`protected void`	`showSecurityWarnings()` Displays security warning messages if any possible secutiry issue is found.
`void`	`shutdown()` Shuts down this service.
`void`	`startup()` Starts up this service.
`void`	`sync()` Calls `Partition.sync()` for all registered `Partition`s.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
    The logger
  - schemaPartition
```
private SchemaPartition schemaPartition
```
  - schemaManager
```
private org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager
```
    A reference on the SchemaManager
  - ldapCodecService
```
private org.apache.directory.api.ldap.codec.api.LdapApiService ldapCodecService
```
    The LDAP Codec Service
  - partitionNexus
```
private DefaultPartitionNexus partitionNexus
```
    the root nexus
  - firstStart
```
private boolean firstStart
```
    whether or not server is started for the first time
  - started
```
private boolean started
```
    whether or not this instance has been shutdown
  - changeLog
```
private ChangeLog changeLog
```
    the change log service
  - journal
```
private Journal journal
```
    the journal service
  - operationManager
```
private OperationManager operationManager
```
    the interface used to perform various operations on this DirectoryService
  - adminDn
```
private org.apache.directory.api.ldap.model.name.Dn adminDn
```
    the distinguished name of the administrative user
  - adminSession
```
private CoreSession adminSession
```
    session used as admin for internal operations
  - referralManager
```
private ReferralManager referralManager
```
    The referral manager
  - passwordHidden
```
private boolean passwordHidden
```
    A flag to tell if the userPassword attribute's value must be hidden
  - csnFactory
```
private org.apache.directory.api.ldap.model.csn.CsnFactory csnFactory
```
    The service's CSN factory
  - replicaId
```
private int replicaId
```
    The directory instance replication ID
  - PARTIAL_IMPL_WARNING
```
private static final java.lang.String PARTIAL_IMPL_WARNING
```
    remove me after implementation is completed
    
    See Also:
    
    Constant Field Values
  - syncPeriodMillis
```
private long syncPeriodMillis
```
    The delay to wait between each sync on disk
  - DEFAULT_SYNC_PERIOD
```
private static final long DEFAULT_SYNC_PERIOD
```
    The default delay to wait between sync on disk : 15 seconds
    
    See Also:
    
    Constant Field Values
  - workerThread
```
private java.lang.Thread workerThread
```
  - MAX_SIZE_LIMIT_DEFAULT
```
public static final int MAX_SIZE_LIMIT_DEFAULT
```
    The default timeLimit : 100 entries
    
    See Also:
    
    Constant Field Values
  - MAX_TIME_LIMIT_DEFAULT
```
public static final int MAX_TIME_LIMIT_DEFAULT
```
    The default timeLimit : 10 seconds
    
    See Also:
    
    Constant Field Values
  - instanceId
```
private java.lang.String instanceId
```
    The instance Id
  - instanceLayout
```
private InstanceLayout instanceLayout
```
    The server directory layout
  - exitVmOnShutdown
```
private boolean exitVmOnShutdown
```
    A flag used to shutdown the VM when stopping the server. Useful when the server is standalone. If the server is embedded, we don't want to shutdown the VM
  - shutdownHookEnabled
```
private boolean shutdownHookEnabled
```
    A flag used to indicate that a shutdown hook has been installed
  - allowAnonymousAccess
```
private boolean allowAnonymousAccess
```
    Manage anonymous access to entries other than the RootDSE
  - accessControlEnabled
```
private boolean accessControlEnabled
```
    Manage the basic access control checks
  - denormalizeOpAttrsEnabled
```
private boolean denormalizeOpAttrsEnabled
```
    Manage the operational attributes denormalization
  - interceptors
```
private java.util.List<Interceptor> interceptors
```
    The list of declared interceptors
  - interceptorNames
```
private java.util.Map<java.lang.String,Interceptor> interceptorNames
```
  - interceptorsLock
```
private java.util.concurrent.locks.ReadWriteLock interceptorsLock
```
    A lock to protect the interceptors List
  - readLock
```
private java.util.concurrent.locks.Lock readLock
```
    The read and write locks
  - writeLock
```
private java.util.concurrent.locks.Lock writeLock
```
  - operationInterceptors
```
private java.util.Map<OperationEnum,java.util.List<java.lang.String>> operationInterceptors
```
    A map associating a list of interceptor to each operation
  - systemPartition
```
private Partition systemPartition
```
    The System partition
  - partitions
```
private java.util.Set<Partition> partitions
```
    The set of all declared partitions
  - testEntries
```
private java.util.List<? extends org.apache.directory.api.ldap.model.ldif.LdifEntry> testEntries
```
    A list of LDIF entries to inject at startup
  - eventService
```
private EventService eventService
```
    The event service
  - maxPDUSize
```
private int maxPDUSize
```
    The maximum size for an incoming PDU
  - lockFile
```
private java.io.RandomAccessFile lockFile
```
    lock file for directory service's working directory
  - LOCK_FILE_NAME
```
private static final java.lang.String LOCK_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - cacheService
```
private CacheService cacheService
```
    the ehcache based cache service
  - accessControlAPCache
```
private org.apache.directory.api.ldap.util.tree.DnNode<AccessControlAdministrativePoint> accessControlAPCache
```
    The AccessControl AdministrativePoint cache
  - collectiveAttributeAPCache
```
private org.apache.directory.api.ldap.util.tree.DnNode<CollectiveAttributeAdministrativePoint> collectiveAttributeAPCache
```
    The CollectiveAttribute AdministrativePoint cache
  - subschemaAPCache
```
private org.apache.directory.api.ldap.util.tree.DnNode<SubschemaAdministrativePoint> subschemaAPCache
```
    The Subschema AdministrativePoint cache
  - triggerExecutionAPCache
```
private org.apache.directory.api.ldap.util.tree.DnNode<TriggerExecutionAdministrativePoint> triggerExecutionAPCache
```
    The TriggerExecution AdministrativePoint cache
  - dnFactory
```
private DnFactory dnFactory
```
    The Dn factory
  - subentryCache
```
SubentryCache subentryCache
```
    The Subentry cache
  - evaluator
```
private SubtreeEvaluator evaluator
```
    The Subtree evaluator instance
  - atProvider
```
private AttributeTypeProvider atProvider
```
    The attribute type provider
  - ocProvider
```
private ObjectClassProvider ocProvider
```
    The object class provider
- Constructor Detail
  - DefaultDirectoryService
```
public DefaultDirectoryService()
                        throws java.lang.Exception
```
    Creates a new instance of the directory service.
    
    Throws:
    
    java.lang.Exception
- Method Detail
  - setInstanceId
```
public void setInstanceId(java.lang.String instanceId)
```
    Specified by:
    
    setInstanceId in interface DirectoryService
  - getInstanceId
```
public java.lang.String getInstanceId()
```
    Specified by:
    
    getInstanceId in interface DirectoryService
  - getPartitions
```
public java.util.Set<? extends Partition> getPartitions()
```
    Gets the Partitions used by this DirectoryService.
    
    Specified by:
    
    getPartitions in interface DirectoryService
    
    Returns:
    
    the set of partitions used
  - setPartitions
```
public void setPartitions(java.util.Set<? extends Partition> partitions)
```
    Sets Partitions used by this DirectoryService.
    
    Specified by:
    
    setPartitions in interface DirectoryService
    
    Parameters:
    
    partitions - the partitions to used
  - isAccessControlEnabled
```
public boolean isAccessControlEnabled()
```
    Returns true if access control checks are enabled.
    
    Specified by:
    
    isAccessControlEnabled in interface DirectoryService
    
    Returns:
    
    true if access control checks are enabled, false otherwise
  - setAccessControlEnabled
```
public void setAccessControlEnabled(boolean accessControlEnabled)
```
    Sets whether to enable basic access control checks or not.
    
    Specified by:
    
    setAccessControlEnabled in interface DirectoryService
    
    Parameters:
    
    accessControlEnabled - true to enable access control checks, false otherwise
  - isAllowAnonymousAccess
```
public boolean isAllowAnonymousAccess()
```
    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.
    
    Specified by:
    
    isAllowAnonymousAccess in interface DirectoryService
    
    Returns:
    
    true if anonymous access is allowed on entries besides the RootDSE, false if anonymous access is allowed to all entries.
  - setAllowAnonymousAccess
```
public void setAllowAnonymousAccess(boolean enableAnonymousAccess)
```
    Sets whether to allow anonymous access to entries other than 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.
    
    Specified by:
    
    setAllowAnonymousAccess in interface DirectoryService
    
    Parameters:
    
    enableAnonymousAccess - true to enable anonymous access, false to disable it
  - getInterceptors
```
public java.util.List<Interceptor> getInterceptors()
```
    Returns interceptors in the server.
    
    Specified by:
    
    getInterceptors in interface DirectoryService
    
    Returns:
    
    the interceptors in the server.
  - getInterceptors
```
public java.util.List<java.lang.String> getInterceptors(OperationEnum operation)
```
    Returns interceptors in the server for a given operation.
    
    Specified by:
    
    getInterceptors in interface DirectoryService
    
    Returns:
    
    the interceptors in the server for the given operation.
  - initOperationsList
```
private void initOperationsList()
```
    Compute the list of to call for each operation
  - gatherInterceptors
```
private void gatherInterceptors(Interceptor interceptor,
                                java.lang.Class<?> interceptorClz,
                                OperationEnum operation,
                                java.util.List<java.lang.String> selectedInterceptorList)
```
    Recursively checks if the given interceptor can be added to the list of interceptors for a given operation and adds to the list of interceptors if it implements the respective operation
    
    Parameters:
    
    interceptor - the instance of the interceptor
    
    interceptorClz - the class of the interceptor
    
    operation - type of operation
    
    selectedInterceptorList - the list of selected interceptors
  - addInterceptor
```
private void addInterceptor(Interceptor interceptor,
                            int position)
                     throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Add an interceptor to the list of interceptors to call for each operation
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - removeOperationsList
```
private void removeOperationsList(java.lang.String interceptorName)
```
    Remove an interceptor to the list of interceptors to call for each operation
  - setInterceptors
```
public void setInterceptors(java.util.List<Interceptor> interceptors)
```
    Sets the interceptors in the server.
    
    Specified by:
    
    setInterceptors in interface DirectoryService
    
    Parameters:
    
    interceptors - the interceptors to be used in the server.
  - initInterceptors
```
private void initInterceptors()
                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Initialize the interceptors
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getTestEntries
```
public java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> getTestEntries()
```
    Returns test directory entries(LdifEntry) to be loaded while bootstrapping.
    
    Specified by:
    
    getTestEntries in interface DirectoryService
    
    Returns:
    
    test entries to load during bootstrapping
  - setTestEntries
```
public void setTestEntries(java.util.List<? extends org.apache.directory.api.ldap.model.ldif.LdifEntry> testEntries)
```
    Sets test directory entries(Attributes) to be loaded while bootstrapping.
    
    Specified by:
    
    setTestEntries in interface DirectoryService
    
    Parameters:
    
    testEntries - the test entries to load while bootstrapping
  - getInstanceLayout
```
public InstanceLayout getInstanceLayout()
```
    Returns the instance layout which contains the path for various directories
    
    Specified by:
    
    getInstanceLayout in interface DirectoryService
    
    Returns:
    
    the InstanceLayout for this directory service.
  - setInstanceLayout
```
public void setInstanceLayout(InstanceLayout instanceLayout)
                       throws java.io.IOException
```
    Sets the InstanceLayout used by the DirectoryService to store the files
    
    Specified by:
    
    setInstanceLayout in interface DirectoryService
    
    Parameters:
    
    instanceLayout - The InstanceLayout to set
    
    Throws:
    
    java.io.IOException - If the layout could not be created
  - setShutdownHookEnabled
```
public void setShutdownHookEnabled(boolean shutdownHookEnabled)
```
    Description copied from interface: DirectoryService
    
    Sets the shutdown hook flag which controls whether or not this DirectoryService registers a JVM shutdown hook to flush caches and synchronize to disk safely. This is enabled by default.
    
    Specified by:
    
    setShutdownHookEnabled in interface DirectoryService
    
    Parameters:
    
    shutdownHookEnabled - true to enable the shutdown hook, false to disable
  - isShutdownHookEnabled
```
public boolean isShutdownHookEnabled()
```
    Description copied from interface: DirectoryService
    
    Checks to see if this DirectoryService has registered a JVM shutdown hook to flush caches and synchronize to disk safely. This is enabled by default.
    
    Specified by:
    
    isShutdownHookEnabled in interface DirectoryService
    
    Returns:
    
    true if a shutdown hook is registered, false if it is not
  - setExitVmOnShutdown
```
public void setExitVmOnShutdown(boolean exitVmOnShutdown)
```
    Specified by:
    
    setExitVmOnShutdown in interface DirectoryService
  - isExitVmOnShutdown
```
public boolean isExitVmOnShutdown()
```
    Specified by:
    
    isExitVmOnShutdown in interface DirectoryService
  - setSystemPartition
```
public void setSystemPartition(Partition systemPartition)
```
    Specified by:
    
    setSystemPartition in interface DirectoryService
  - getSystemPartition
```
public Partition getSystemPartition()
```
    Specified by:
    
    getSystemPartition in interface DirectoryService
  - isDenormalizeOpAttrsEnabled
```
public boolean isDenormalizeOpAttrsEnabled()
```
    return true if the operational attributes must be normalized when returned
    
    Specified by:
    
    isDenormalizeOpAttrsEnabled in interface DirectoryService
  - setDenormalizeOpAttrsEnabled
```
public void setDenormalizeOpAttrsEnabled(boolean denormalizeOpAttrsEnabled)
```
    Sets whether the operational attributes are denormalized when returned
    
    Specified by:
    
    setDenormalizeOpAttrsEnabled in interface DirectoryService
    
    Parameters:
    
    denormalizeOpAttrsEnabled - The flag value
  - getChangeLog
```
public ChangeLog getChangeLog()
```
    Gets the ChangeLog service for this DirectoryService used for tracking changes (revisions) to the server and using them to revert the server to earlier revisions.
    
    Specified by:
    
    getChangeLog in interface DirectoryService
    
    Returns:
    
    the change log service
  - getJournal
```
public Journal getJournal()
```
    Gets the Journal service for this DirectoryService used for tracking changes to the server.
    
    Specified by:
    
    getJournal in interface DirectoryService
    
    Returns:
    
    the journal service
  - setChangeLog
```
public void setChangeLog(ChangeLog changeLog)
```
    Sets the ChangeLog service for this DirectoryService used for tracking changes (revisions) to the server and using them to revert the server to earlier revisions.
    
    Specified by:
    
    setChangeLog in interface DirectoryService
    
    Parameters:
    
    changeLog - the change log service to set
  - setJournal
```
public void setJournal(Journal journal)
```
    Sets the journal in the server.
    
    Specified by:
    
    setJournal in interface DirectoryService
    
    Parameters:
    
    journal - the journal to be used in the server.
  - addPartition
```
public void addPartition(Partition partition)
                  throws java.lang.Exception
```
    Specified by:
    
    addPartition in interface DirectoryService
    
    Throws:
    
    java.lang.Exception
  - removePartition
```
public void removePartition(Partition partition)
                     throws java.lang.Exception
```
    Specified by:
    
    removePartition in interface DirectoryService
    
    Throws:
    
    java.lang.Exception
  - setDefaultInterceptorConfigurations
```
private void setDefaultInterceptorConfigurations()
```
    Define a default list of interceptors that has to be used if no other configuration is defined.
  - getAdminSession
```
public CoreSession getAdminSession()
```
    Specified by:
    
    getAdminSession in interface DirectoryService
    
    Returns:
    
    The Admin session
  - getSession
```
public CoreSession getSession()
```
    Get back an anonymous session
    
    Specified by:
    
    getSession in interface DirectoryService
    
    Returns:
    
    a logical session as the anonymous user
  - getSession
```
public CoreSession getSession(LdapPrincipal principal)
```
    Get back a session for a given principal
    
    Specified by:
    
    getSession in interface DirectoryService
    
    Returns:
    
    a logical session as a specific user
  - getSession
```
public CoreSession getSession(org.apache.directory.api.ldap.model.name.Dn principalDn,
                              byte[] credentials)
                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Get back a session for the give user and credentials bound with Simple Bind
    
    Specified by:
    
    getSession in interface DirectoryService
    
    Returns:
    
    a logical session as a specific user
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getSession
```
public CoreSession getSession(org.apache.directory.api.ldap.model.name.Dn principalDn,
                              byte[] credentials,
                              java.lang.String saslMechanism,
                              java.lang.String saslAuthId)
                       throws java.lang.Exception
```
    Get back a session for a given user bound with SASL Bind
    
    Specified by:
    
    getSession in interface DirectoryService
    
    Returns:
    
    a logical session as a specific user
    
    Throws:
    
    java.lang.Exception
  - revert
```
public long revert()
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Description copied from interface: DirectoryService
    
    Reverts the server's state to the latest tagged snapshot if one was taken. If there is no tag a illegal state exception will result. If the latest revision is not earlier than the current revision (both are same), then no changes were made to the directory to be reverted. In this case we return the current revision and do nothing logging the fact that we ignored the request to revert.
    
    Specified by:
    
    revert in interface DirectoryService
    
    Returns:
    
    the new revision reached by applying all changes needed to revert to the new state or the same version before this call if no revert actually took place
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - moddn
```
private void moddn(org.apache.directory.api.ldap.model.name.Dn oldDn,
                   org.apache.directory.api.ldap.model.name.Dn newDn,
                   boolean delOldRdn)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    We handle the ModDN/ModRDN operation for the revert here.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - revert
```
public long revert(long revision)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Description copied from interface: DirectoryService
    
    Reverts the server's state to an earlier revision. Note that the revsion number still increases to revert back even though the state reverted to is the same. Note that implementations may lock the server from making changes or searching the directory until this operation has completed.
    
    Specified by:
    
    revert in interface DirectoryService
    
    Parameters:
    
    revision - the revision number to revert to
    
    Returns:
    
    the new revision reached by applying all changes needed to revert to the original state
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getOperationManager
```
public OperationManager getOperationManager()
```
    Description copied from interface: DirectoryService
    
    Gets the operation manager.
    
    Specified by:
    
    getOperationManager in interface DirectoryService
  - startup
```
public void startup()
             throws java.lang.Exception
```
    Description copied from interface: DirectoryService
    
    Starts up this service.
    
    Specified by:
    
    startup in interface DirectoryService
    
    Throws:
    
    java.lang.Exception - if the LDAP server cannot be started
  - sync
```
public void sync()
          throws java.lang.Exception
```
    Description copied from interface: DirectoryService
    
    Calls Partition.sync() for all registered Partitions.
    
    Specified by:
    
    sync in interface DirectoryService
    
    Throws:
    
    java.lang.Exception - if synchronization failed
  - shutdown
```
public void shutdown()
              throws java.lang.Exception
```
    Description copied from interface: DirectoryService
    
    Shuts down this service.
    
    Specified by:
    
    shutdown in interface DirectoryService
    
    Throws:
    
    java.lang.Exception - if failed to shut down
  - getReferralManager
```
public ReferralManager getReferralManager()
```
    Specified by:
    
    getReferralManager in interface DirectoryService
    
    Returns:
    
    The referral manager
  - setReferralManager
```
public void setReferralManager(ReferralManager referralManager)
```
    Set the referralManager
    
    Specified by:
    
    setReferralManager in interface DirectoryService
    
    Parameters:
    
    referralManager - The initialized referralManager
  - getSchemaManager
```
public org.apache.directory.api.ldap.model.schema.SchemaManager getSchemaManager()
```
    Specified by:
    
    getSchemaManager in interface DirectoryService
    
    Returns:
    
    the SchemaManager
  - setSchemaManager
```
public void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
```
    Set the SchemaManager instance.
    
    Specified by:
    
    setSchemaManager in interface DirectoryService
    
    Parameters:
    
    schemaManager - The server schemaManager
  - getLdapCodecService
```
public org.apache.directory.api.ldap.codec.api.LdapApiService getLdapCodecService()
```
    Specified by:
    
    getLdapCodecService in interface DirectoryService
    
    Returns:
    
    The LDAP codec service.
  - getSchemaPartition
```
public SchemaPartition getSchemaPartition()
```
    Specified by:
    
    getSchemaPartition in interface DirectoryService
    
    Returns:
    
    The schema partition
  - setSchemaPartition
```
public void setSchemaPartition(SchemaPartition schemaPartition)
```
    Set the SchemaPartition
    
    Specified by:
    
    setSchemaPartition in interface DirectoryService
    
    Parameters:
    
    schemaPartition - the SchemaPartition instance
  - getPartitionNexus
```
public DefaultPartitionNexus getPartitionNexus()
```
    Specified by:
    
    getPartitionNexus in interface DirectoryService
  - isFirstStart
```
public boolean isFirstStart()
```
  - isStarted
```
public boolean isStarted()
```
    Description copied from interface: DirectoryService
    
    Returns true if this service is started.
    
    Specified by:
    
    isStarted in interface DirectoryService
    
    Returns:
    
    true if the service has started, false otherwise
  - newEntry
```
public org.apache.directory.api.ldap.model.entry.Entry newEntry(org.apache.directory.api.ldap.model.name.Dn dn)
```
    Description copied from interface: ServerEntryFactory
    
    Creates a new ServerEntry which has not yet been added to the directory.
    
    Specified by:
    
    newEntry in interface ServerEntryFactory
  - createBootstrapEntries
```
private boolean createBootstrapEntries()
                                throws java.lang.Exception
```
    Returns true if we had to create the bootstrap entries on the first start of the server. Otherwise if all entries exist, meaning none had to be created, then we are not starting for the first time.
    
    Returns:
    
    true if the bootstrap entries had to be created, false otherwise
    
    Throws:
    
    java.lang.Exception - if entries cannot be created
  - showSecurityWarnings
```
protected void showSecurityWarnings()
                             throws java.lang.Exception
```
    Displays security warning messages if any possible secutiry issue is found.
    
    Throws:
    
    java.lang.Exception - if there are failures parsing and accessing internal structures
  - createTestEntries
```
private void createTestEntries()
                        throws java.lang.Exception
```
    Adds test entries into the core.
    
    Throws:
    
    java.lang.Exception - if the creation of test entries fails.
  - initializeSystemPartition
```
private void initializeSystemPartition()
                                throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - initialize
```
private void initialize()
                 throws java.lang.Exception
```
    Kicks off the initialization of the entire system.
    
    Throws:
    
    java.lang.Exception - if there are problems along the way
  - readEntry
```
private org.apache.directory.api.ldap.model.entry.Entry readEntry(java.lang.String text)
```
    Read an entry (without Dn)
    
    Parameters:
    
    text - The ldif format file
    
    Returns:
    
    An entry.
  - newEntry
```
public org.apache.directory.api.ldap.model.entry.Entry newEntry(java.lang.String ldif,
                                                                java.lang.String dn)
```
    Create a new Entry
    
    Specified by:
    
    newEntry in interface DirectoryService
    
    Parameters:
    
    ldif - The String representing the attributes, as a LDIF file
    
    dn - The Dn for this new entry
  - getEventService
```
public EventService getEventService()
```
    Specified by:
    
    getEventService in interface DirectoryService
  - setEventService
```
public void setEventService(EventService eventService)
```
    Specified by:
    
    setEventService in interface DirectoryService
  - isPasswordHidden
```
public boolean isPasswordHidden()
```
    Returns true if the service requires the userPassword attribute to be masked. It's an option in the server.xml file.
    
    Specified by:
    
    isPasswordHidden in interface DirectoryService
    
    Returns:
    
    true if the service requires that the userPassword is to be hidden
  - setPasswordHidden
```
public void setPasswordHidden(boolean passwordHidden)
```
    Sets whether the userPassword attribute is readable, or hidden.
    
    Specified by:
    
    setPasswordHidden in interface DirectoryService
    
    Parameters:
    
    passwordHidden - true to enable hide the userPassword attribute, false otherwise
  - getMaxPDUSize
```
public int getMaxPDUSize()
```
    Specified by:
    
    getMaxPDUSize in interface DirectoryService
    
    Returns:
    
    The maximum allowed size for an incoming PDU
  - setMaxPDUSize
```
public void setMaxPDUSize(int maxPDUSize)
```
    Set the maximum allowed size for an incoming PDU
    
    Specified by:
    
    setMaxPDUSize in interface DirectoryService
    
    Parameters:
    
    maxPDUSize - A positive number of bytes for the PDU. A negative or null value will be transformed to Integer.MAX_VALUE
  - getInterceptor
```
public Interceptor getInterceptor(java.lang.String interceptorName)
```
    Get an Interceptor instance from its name
    
    Specified by:
    
    getInterceptor in interface DirectoryService
    
    Parameters:
    
    interceptorName - The interceptor's name for which we want the instance
    
    Returns:
    
    the interceptor for the given name
  - addFirst
```
public void addFirst(Interceptor interceptor)
              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Add an interceptor in the first position in the interceptor list.
    
    Specified by:
    
    addFirst in interface DirectoryService
    
    Parameters:
    
    interceptor - The added interceptor
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - addLast
```
public void addLast(Interceptor interceptor)
             throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Add an interceptor in the last position in the interceptor list.
    
    Specified by:
    
    addLast in interface DirectoryService
    
    Parameters:
    
    interceptor - The added interceptor
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - addAfter
```
public void addAfter(java.lang.String interceptorName,
                     Interceptor interceptor)
```
    Add an interceptor after a given interceptor in the interceptor list.
    
    Specified by:
    
    addAfter in interface DirectoryService
    
    Parameters:
    
    interceptorName - The interceptor name to find
    
    interceptor - The added interceptor
  - remove
```
public void remove(java.lang.String interceptorName)
```
    Remove an interceptor from the list of interceptors
    
    Specified by:
    
    remove in interface DirectoryService
    
    Parameters:
    
    interceptorName - The interceptor to remove
  - getCSN
```
public org.apache.directory.api.ldap.model.csn.Csn getCSN()
```
    Get a new CSN
    
    Specified by:
    
    getCSN in interface DirectoryService
    
    Returns:
    
    The CSN generated for this directory service
  - getReplicaId
```
public int getReplicaId()
```
    Specified by:
    
    getReplicaId in interface DirectoryService
    
    Returns:
    
    the replicaId
  - setReplicaId
```
public void setReplicaId(int replicaId)
```
    Specified by:
    
    setReplicaId in interface DirectoryService
    
    Parameters:
    
    replicaId - the replicaId to set
  - getSyncPeriodMillis
```
public long getSyncPeriodMillis()
```
    Specified by:
    
    getSyncPeriodMillis in interface DirectoryService
    
    Returns:
    
    the syncPeriodMillis
  - setSyncPeriodMillis
```
public void setSyncPeriodMillis(long syncPeriodMillis)
```
    the time interval at which the DirectoryService's data is flushed to disk
    
    Specified by:
    
    setSyncPeriodMillis in interface DirectoryService
    
    Parameters:
    
    syncPeriodMillis - the syncPeriodMillis to set
  - lockWorkDir
```
private void lockWorkDir()
```
    checks if the working directory is already in use by some other directory service, if yes then throws a runtime exception else will obtain the lock on the working directory
  - getCacheService
```
public CacheService getCacheService()
```
    Specified by:
    
    getCacheService in interface DirectoryService
    
    Returns:
    
    the cache service
  - getAccessControlAPCache
```
public org.apache.directory.api.ldap.util.tree.DnNode<AccessControlAdministrativePoint> getAccessControlAPCache()
```
    Specified by:
    
    getAccessControlAPCache in interface DirectoryService
    
    Returns:
    
    The AccessControl AdministrativePoint cache
  - getCollectiveAttributeAPCache
```
public org.apache.directory.api.ldap.util.tree.DnNode<CollectiveAttributeAdministrativePoint> getCollectiveAttributeAPCache()
```
    Specified by:
    
    getCollectiveAttributeAPCache in interface DirectoryService
    
    Returns:
    
    The CollectiveAttribute AdministrativePoint cache
  - getSubschemaAPCache
```
public org.apache.directory.api.ldap.util.tree.DnNode<SubschemaAdministrativePoint> getSubschemaAPCache()
```
    Specified by:
    
    getSubschemaAPCache in interface DirectoryService
    
    Returns:
    
    The Subschema AdministrativePoint cache
  - getTriggerExecutionAPCache
```
public org.apache.directory.api.ldap.util.tree.DnNode<TriggerExecutionAdministrativePoint> getTriggerExecutionAPCache()
```
    Specified by:
    
    getTriggerExecutionAPCache in interface DirectoryService
    
    Returns:
    
    The TriggerExecution AdministrativePoint cache
  - isPwdPolicyEnabled
```
public boolean isPwdPolicyEnabled()
```
    Specified by:
    
    isPwdPolicyEnabled in interface DirectoryService
    
    Returns:
    
    true if the password policy is enabled, false otherwise
  - getDnFactory
```
public DnFactory getDnFactory()
```
    Gets the Dn factory.
    
    Specified by:
    
    getDnFactory in interface DirectoryService
    
    Returns:
    
    the Dn factory
  - setDnFactory
```
public void setDnFactory(DnFactory dnFactory)
```
    Sets the Dn factory.
    
    Specified by:
    
    setDnFactory in interface DirectoryService
  - getSubentryCache
```
public SubentryCache getSubentryCache()
```
    Specified by:
    
    getSubentryCache in interface DirectoryService
    
    Returns:
    
    Returns the hash mapping the Dn of a subentry to its SubtreeSpecification/types
  - getEvaluator
```
public SubtreeEvaluator getEvaluator()
```
    Specified by:
    
    getEvaluator in interface DirectoryService
    
    Returns:
    
    Returns the subentry evaluator
  - setCacheService
```
public void setCacheService(CacheService cacheService)
```
    Sets the CacheService
    
    Specified by:
    
    setCacheService in interface DirectoryService
    
    Parameters:
    
    cacheService - the cache service
  - getAtProvider
```
public AttributeTypeProvider getAtProvider()
```
    Gets the AttributeTypeProvider.
    
    Specified by:
    
    getAtProvider in interface DirectoryService
    
    Returns:
    
    the AttributeTypeProvider
  - getOcProvider
```
public ObjectClassProvider getOcProvider()
```
    Gets the ObjectClassProvider.
    
    Specified by:
    
    getOcProvider in interface DirectoryService
    
    Returns:
    
    the ObjectClassProvider

Class DefaultDirectoryService

Field Summary

Fields inherited from interface org.apache.directory.server.core.api.DirectoryService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

schemaPartition

schemaManager

ldapCodecService

partitionNexus

firstStart

started

changeLog

journal

operationManager

adminDn

adminSession

referralManager

passwordHidden

csnFactory

replicaId

PARTIAL_IMPL_WARNING

syncPeriodMillis

DEFAULT_SYNC_PERIOD

workerThread

MAX_SIZE_LIMIT_DEFAULT

MAX_TIME_LIMIT_DEFAULT

instanceId

instanceLayout

exitVmOnShutdown

shutdownHookEnabled

allowAnonymousAccess

accessControlEnabled

denormalizeOpAttrsEnabled

interceptors

interceptorNames

interceptorsLock

readLock

writeLock

operationInterceptors

systemPartition

partitions

testEntries

eventService

maxPDUSize

lockFile

LOCK_FILE_NAME

cacheService

accessControlAPCache

collectiveAttributeAPCache

subschemaAPCache

triggerExecutionAPCache

dnFactory

subentryCache

evaluator

atProvider

ocProvider

Constructor Detail

DefaultDirectoryService

Method Detail

setInstanceId

getInstanceId

getPartitions

setPartitions

isAccessControlEnabled

setAccessControlEnabled

isAllowAnonymousAccess

setAllowAnonymousAccess

getInterceptors

getInterceptors

initOperationsList

gatherInterceptors

addInterceptor

removeOperationsList

setInterceptors

initInterceptors

getTestEntries

setTestEntries