org.apache.directory.server.core

Class DefaultDirectoryService

java.lang.Object

org.apache.directory.server.core.DefaultDirectoryService

All Implemented Interfaces:

DirectoryService, ServerEntryFactory

public class DefaultDirectoryService
extends Object
implements DirectoryService

Default implementation of DirectoryService.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SIZE_LIMIT_DEFAULT The default timeLimit : 100 entries
static int	MAX_TIME_LIMIT_DEFAULT The default timeLimit : 10 seconds

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

JNDI_KEY

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addPartition(Partition partition)
CoreSession	getAdminSession()
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.shared.ldap.csn.Csn	getCSN() Get a new CSN
EventService	getEventService()
String	getInstanceId()
Interceptor	getInterceptor(String interceptorName) Get an Interceptor instance from its name
InterceptorChain	getInterceptorChain()
List<Interceptor>	getInterceptors() Returns interceptors in the server.
Journal	getJournal() Gets the Journal service for this DirectoryService used for tracking changes to the server.
int	getMaxPDUSize()
OperationManager	getOperationManager() Gets the operation manager.
DefaultPartitionNexus	getPartitionNexus()
Set<? extends Partition>	getPartitions() Gets the Partitions used by this DirectoryService.
ReferralManager	getReferralManager()
int	getReplicaId()
ReplicationConfiguration	getReplicationConfiguration()
org.apache.directory.shared.ldap.schema.SchemaManager	getSchemaManager()
SchemaService	getSchemaService()
CoreSession	getSession() Gets a logical session to perform operations on this DirectoryService as the anonymous user.
CoreSession	getSession(org.apache.directory.shared.ldap.name.DN principalDn, byte[] credentials) Gets a logical session to perform operations on this DirectoryService as a specific user with a separate authorization principal.
CoreSession	getSession(org.apache.directory.shared.ldap.name.DN principalDn, byte[] credentials, String saslMechanism, String saslAuthId) Gets a logical session to perform operations on this DirectoryService as a specific user with a separate authorization principal.
CoreSession	getSession(LdapPrincipal principal) Gets a logical session to perform operations on this DirectoryService as a specific user.
long	getSyncPeriodMillis()
Partition	getSystemPartition()
List<org.apache.directory.shared.ldap.ldif.LdifEntry>	getTestEntries() Returns test directory entries(LdifEntry) to be loaded while bootstrapping.
File	getWorkingDirectory() Returns working directory (counterpart of var/lib) where partitions are stored by default.
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	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.
org.apache.directory.shared.ldap.entry.ServerEntry	newEntry(org.apache.directory.shared.ldap.name.DN dn) Creates a new ServerEntry which has not yet been added to the directory.
org.apache.directory.shared.ldap.entry.ServerEntry	newEntry(String ldif, String dn) Create a new ServerEntry
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	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.
void	setDenormalizeOpAttrsEnabled(boolean denormalizeOpAttrsEnabled) Sets whether the operational attributes are denormalized when returned
void	setEventService(EventService eventService)
void	setExitVmOnShutdown(boolean exitVmOnShutdown)
void	setInstanceId(String instanceId)
void	setInterceptors(List<Interceptor> interceptors) Sets the interceptors in the server.
void	setJournal(Journal journal)
void	setMaxPDUSize(int maxPDUSize) Set the maximum allowed size for an incoming PDU
void	setPartitions(Set<? extends Partition> partitions) Sets Partitions 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	setReplicationConfiguration(ReplicationConfiguration replicationConfig) Sets the replication configuration in the server.
void	setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager) Set the SchemaManager instance.
void	setSchemaService(SchemaService schemaService)
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)
void	setSystemPartition(Partition systemPartition)
void	setTestEntries(List<? extends org.apache.directory.shared.ldap.ldif.LdifEntry> testEntries) Sets test directory entries(Attributes) to be loaded while bootstrapping.
void	setWorkingDirectory(File workingDirectory) Sets working directory (counterpart of var/lib) where partitions are stored by default.
void	shutdown() Shuts down this service.
void	startup() Starts up this service.
void	sync() Calls Partition.sync() for all registered Partitions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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

Constructor Detail

DefaultDirectoryService

public DefaultDirectoryService()
                        throws Exception

Creates a new instance of the directory service.

Throws:

Exception

Method Detail

setInstanceId

public void setInstanceId(String instanceId)

Specified by:

setInstanceId in interface DirectoryService

getInstanceId

public String getInstanceId()

Specified by:

getInstanceId in interface DirectoryService

getPartitions

public 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(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 List<Interceptor> getInterceptors()

Returns interceptors in the server.

Specified by:

getInterceptors in interface DirectoryService

Returns:

the interceptors in the server.

setInterceptors

public void setInterceptors(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.

getTestEntries

public List<org.apache.directory.shared.ldap.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(List<? extends org.apache.directory.shared.ldap.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

getWorkingDirectory

public File getWorkingDirectory()

Returns working directory (counterpart of var/lib) where partitions are stored by default.

Specified by:

getWorkingDirectory in interface DirectoryService

Returns:

the directory where partition's are stored.

setWorkingDirectory

public void setWorkingDirectory(File workingDirectory)

Sets working directory (counterpart of var/lib) where partitions are stored by default.

Specified by:

setWorkingDirectory in interface DirectoryService

Parameters:

workingDirectory - the directory where the server's partitions are stored by default.

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)

Specified by:

setJournal in interface DirectoryService

addPartition

public void addPartition(Partition partition)
                  throws Exception

Specified by:

addPartition in interface DirectoryService

Throws:

Exception

removePartition

public void removePartition(Partition partition)
                     throws Exception

Specified by:

removePartition in interface DirectoryService

Throws:

Exception

getAdminSession

public CoreSession getAdminSession()

Specified by:

getAdminSession in interface DirectoryService

getSession

public CoreSession getSession()

Description copied from interface: DirectoryService

Gets a logical session to perform operations on this DirectoryService as the anonymous user. This bypasses authentication without propagating a bind operation into the core.

Specified by:

getSession in interface DirectoryService

Returns:

a logical session as the anonymous user

getSession

public CoreSession getSession(LdapPrincipal principal)

Description copied from interface: DirectoryService

Gets a logical session to perform operations on this DirectoryService as a specific user. This bypasses authentication without propagating a bind operation into the core.

Specified by:

getSession in interface DirectoryService

Returns:

a logical session as a specific user

getSession

public CoreSession getSession(org.apache.directory.shared.ldap.name.DN principalDn,
                     byte[] credentials)
                       throws Exception

Description copied from interface: DirectoryService

Gets a logical session to perform operations on this DirectoryService as a specific user with a separate authorization principal. This bypasses authentication without propagating a bind operation into the core.

Specified by:

getSession in interface DirectoryService

Returns:

a logical session as a specific user

Throws:

Exception

getSession

public CoreSession getSession(org.apache.directory.shared.ldap.name.DN principalDn,
                     byte[] credentials,
                     String saslMechanism,
                     String saslAuthId)
                       throws Exception

Description copied from interface: DirectoryService

Gets a logical session to perform operations on this DirectoryService as a specific user with a separate authorization principal. This bypasses authentication without propagating a bind operation into the core.

Specified by:

getSession in interface DirectoryService

Returns:

a logical session as a specific user

Throws:

Exception

revert

public long revert()
            throws Exception

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 nothiig loggin 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:

Exception - if there are problems reverting back to the earlier state

UnsupportedOperationException - if this feature is not supported by the change log

revert

public long revert(long revision)
            throws Exception

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:

Exception - if there are problems reverting back to the earlier state

IllegalArgumentException - if the revision provided is greater than the current revision or less than 0

UnsupportedOperationException - if this feature is not supported by the change log

getOperationManager

public OperationManager getOperationManager()

Description copied from interface: DirectoryService

Gets the operation manager.

Specified by:

getOperationManager in interface DirectoryService

startup

public void startup()
             throws Exception

Description copied from interface: DirectoryService

Starts up this service.

Specified by:

startup in interface DirectoryService

Throws:

Exception - if the LDAP server cannot be started

sync

public void sync()
          throws Exception

Description copied from interface: DirectoryService

Calls Partition.sync() for all registered Partitions.

Specified by:

sync in interface DirectoryService

Throws:

Exception - if synchronization failed

shutdown

public void shutdown()
              throws Exception

Description copied from interface: DirectoryService

Shuts down this service.

Specified by:

shutdown in interface DirectoryService

Throws:

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.shared.ldap.schema.SchemaManager getSchemaManager()

Specified by:

getSchemaManager in interface DirectoryService

Returns:

the SchemaManager

setSchemaManager

public void setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)

Set the SchemaManager instance.

Specified by:

setSchemaManager in interface DirectoryService

Parameters:

schemaManager - The schemaManager

getSchemaService

public SchemaService getSchemaService()

Specified by:

getSchemaService in interface DirectoryService

setSchemaService

public void setSchemaService(SchemaService schemaService)

Specified by:

setSchemaService in interface DirectoryService

getPartitionNexus

public DefaultPartitionNexus getPartitionNexus()

Specified by:

getPartitionNexus in interface DirectoryService

getInterceptorChain

public InterceptorChain getInterceptorChain()

Specified by:

getInterceptorChain 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.shared.ldap.entry.ServerEntry newEntry(org.apache.directory.shared.ldap.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

newEntry

public org.apache.directory.shared.ldap.entry.ServerEntry newEntry(String ldif,
                                                          String dn)

Create a new ServerEntry

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(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:

getCSN

public org.apache.directory.shared.ldap.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

setReplicationConfiguration

public void setReplicationConfiguration(ReplicationConfiguration replicationConfig)

Description copied from interface: DirectoryService

Sets the replication configuration in the server.

Specified by:

setReplicationConfiguration in interface DirectoryService

getReplicationConfiguration

public ReplicationConfiguration getReplicationConfiguration()

Specified by:

getReplicationConfiguration in interface DirectoryService

Returns:

the replication configuration for this DirectoryService

getSyncPeriodMillis

public long getSyncPeriodMillis()

Returns:

the syncPeriodMillis

setSyncPeriodMillis

public void setSyncPeriodMillis(long syncPeriodMillis)

Parameters:

syncPeriodMillis - the syncPeriodMillis to set