public class DefaultDirectoryService extends Object implements DirectoryService
DirectoryService.| 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
|
JNDI_KEY| Constructor and Description |
|---|
DefaultDirectoryService()
Creates a new instance of the directory service.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addAfter(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.
|
void |
addLast(Interceptor interceptor)
Add an interceptor in the last position in the interceptor list.
|
void |
addPartition(Partition partition) |
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() |
String |
getInstanceId() |
InstanceLayout |
getInstanceLayout()
Returns the instance layout which contains the path for various directories
|
Interceptor |
getInterceptor(String interceptorName)
Get an Interceptor instance from its name
|
List<Interceptor> |
getInterceptors()
Returns interceptors in the server.
|
List<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() |
Set<? extends Partition> |
getPartitions()
Gets the
Partitions 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,
String saslMechanism,
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() |
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() |
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.
|
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(String ldif,
String dn)
Create a new Entry
|
void |
remove(String interceptorName)
Remove an interceptor from the list of interceptors
|
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.
|
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(String instanceId) |
void |
setInstanceLayout(InstanceLayout instanceLayout)
Sets the InstanceLayout used by the DirectoryService to store the files
|
void |
setInterceptors(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(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 |
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(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 Partitions. |
public static final int MAX_SIZE_LIMIT_DEFAULT
public static final int MAX_TIME_LIMIT_DEFAULT
public void setInstanceId(String instanceId)
setInstanceId in interface DirectoryServicepublic String getInstanceId()
getInstanceId in interface DirectoryServicepublic Set<? extends Partition> getPartitions()
Partitions used by this DirectoryService.getPartitions in interface DirectoryServicepublic void setPartitions(Set<? extends Partition> partitions)
Partitions used by this DirectoryService.setPartitions in interface DirectoryServicepartitions - the partitions to usedpublic boolean isAccessControlEnabled()
isAccessControlEnabled in interface DirectoryServicepublic void setAccessControlEnabled(boolean accessControlEnabled)
setAccessControlEnabled in interface DirectoryServiceaccessControlEnabled - true to enable access control checks, false otherwisepublic boolean isAllowAnonymousAccess()
isAllowAnonymousAccess in interface DirectoryServicepublic void setAllowAnonymousAccess(boolean enableAnonymousAccess)
setAllowAnonymousAccess in interface DirectoryServiceenableAnonymousAccess - true to enable anonymous access, false to disable itpublic List<Interceptor> getInterceptors()
getInterceptors in interface DirectoryServicepublic List<String> getInterceptors(OperationEnum operation)
getInterceptors in interface DirectoryServicepublic void setInterceptors(List<Interceptor> interceptors)
setInterceptors in interface DirectoryServiceinterceptors - the interceptors to be used in the server.public List<org.apache.directory.api.ldap.model.ldif.LdifEntry> getTestEntries()
LdifEntry) to be loaded while
bootstrapping.getTestEntries in interface DirectoryServicepublic void setTestEntries(List<? extends org.apache.directory.api.ldap.model.ldif.LdifEntry> testEntries)
Attributes) to be loaded while
bootstrapping.setTestEntries in interface DirectoryServicetestEntries - the test entries to load while bootstrappingpublic InstanceLayout getInstanceLayout()
getInstanceLayout in interface DirectoryServicepublic void setInstanceLayout(InstanceLayout instanceLayout) throws IOException
setInstanceLayout in interface DirectoryServiceinstanceLayout - The InstanceLayout to setIOException - If the layout could not be createdpublic void setShutdownHookEnabled(boolean shutdownHookEnabled)
DirectoryServicesetShutdownHookEnabled in interface DirectoryServiceshutdownHookEnabled - true to enable the shutdown hook, false to disablepublic boolean isShutdownHookEnabled()
DirectoryServiceisShutdownHookEnabled in interface DirectoryServicepublic void setExitVmOnShutdown(boolean exitVmOnShutdown)
setExitVmOnShutdown in interface DirectoryServicepublic boolean isExitVmOnShutdown()
isExitVmOnShutdown in interface DirectoryServicepublic void setSystemPartition(Partition systemPartition)
setSystemPartition in interface DirectoryServicepublic Partition getSystemPartition()
getSystemPartition in interface DirectoryServicepublic boolean isDenormalizeOpAttrsEnabled()
isDenormalizeOpAttrsEnabled in interface DirectoryServicepublic void setDenormalizeOpAttrsEnabled(boolean denormalizeOpAttrsEnabled)
setDenormalizeOpAttrsEnabled in interface DirectoryServicedenormalizeOpAttrsEnabled - The flag valuepublic ChangeLog getChangeLog()
getChangeLog in interface DirectoryServicepublic Journal getJournal()
getJournal in interface DirectoryServicepublic void setChangeLog(ChangeLog changeLog)
setChangeLog in interface DirectoryServicechangeLog - the change log service to setpublic void setJournal(Journal journal)
setJournal in interface DirectoryServicejournal - the journal to be used in the server.public void addPartition(Partition partition) throws Exception
addPartition in interface DirectoryServiceExceptionpublic void removePartition(Partition partition) throws Exception
removePartition in interface DirectoryServiceExceptionpublic CoreSession getAdminSession()
getAdminSession in interface DirectoryServicepublic CoreSession getSession()
getSession in interface DirectoryServicepublic CoreSession getSession(LdapPrincipal principal)
getSession in interface DirectoryServicepublic CoreSession getSession(org.apache.directory.api.ldap.model.name.Dn principalDn, byte[] credentials) throws org.apache.directory.api.ldap.model.exception.LdapException
getSession in interface DirectoryServiceorg.apache.directory.api.ldap.model.exception.LdapExceptionpublic CoreSession getSession(org.apache.directory.api.ldap.model.name.Dn principalDn, byte[] credentials, String saslMechanism, String saslAuthId) throws Exception
getSession in interface DirectoryServiceExceptionpublic long revert()
throws org.apache.directory.api.ldap.model.exception.LdapException
DirectoryServicerevert in interface DirectoryServiceorg.apache.directory.api.ldap.model.exception.LdapExceptionpublic long revert(long revision)
throws org.apache.directory.api.ldap.model.exception.LdapException
DirectoryServicerevert in interface DirectoryServicerevision - the revision number to revert toorg.apache.directory.api.ldap.model.exception.LdapExceptionpublic OperationManager getOperationManager()
DirectoryServicegetOperationManager in interface DirectoryServicepublic void startup()
throws Exception
DirectoryServicestartup in interface DirectoryServiceException - if the LDAP server cannot be startedpublic void sync()
throws Exception
DirectoryServicePartition.sync() for all registered Partitions.sync in interface DirectoryServiceException - if synchronization failedpublic void shutdown()
throws Exception
DirectoryServiceshutdown in interface DirectoryServiceException - if failed to shut downpublic ReferralManager getReferralManager()
getReferralManager in interface DirectoryServicepublic void setReferralManager(ReferralManager referralManager)
setReferralManager in interface DirectoryServicereferralManager - The initialized referralManagerpublic org.apache.directory.api.ldap.model.schema.SchemaManager getSchemaManager()
getSchemaManager in interface DirectoryServicepublic void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)
setSchemaManager in interface DirectoryServiceschemaManager - The server schemaManagerpublic org.apache.directory.api.ldap.codec.api.LdapApiService getLdapCodecService()
getLdapCodecService in interface DirectoryServicepublic SchemaPartition getSchemaPartition()
getSchemaPartition in interface DirectoryServicepublic void setSchemaPartition(SchemaPartition schemaPartition)
setSchemaPartition in interface DirectoryServiceschemaPartition - the SchemaPartition instancepublic DefaultPartitionNexus getPartitionNexus()
getPartitionNexus in interface DirectoryServicepublic boolean isFirstStart()
public boolean isStarted()
DirectoryServiceisStarted in interface DirectoryServicepublic org.apache.directory.api.ldap.model.entry.Entry newEntry(org.apache.directory.api.ldap.model.name.Dn dn)
ServerEntryFactorynewEntry in interface ServerEntryFactoryprotected void showSecurityWarnings()
throws Exception
Exception - if there are failures parsing and accessing internal structurespublic org.apache.directory.api.ldap.model.entry.Entry newEntry(String ldif, String dn)
newEntry in interface DirectoryServiceldif - The String representing the attributes, as a LDIF filedn - The Dn for this new entrypublic EventService getEventService()
getEventService in interface DirectoryServicepublic void setEventService(EventService eventService)
setEventService in interface DirectoryServicepublic boolean isPasswordHidden()
isPasswordHidden in interface DirectoryServicepublic void setPasswordHidden(boolean passwordHidden)
setPasswordHidden in interface DirectoryServicepasswordHidden - true to enable hide the userPassword attribute, false otherwisepublic int getMaxPDUSize()
getMaxPDUSize in interface DirectoryServicepublic void setMaxPDUSize(int maxPDUSize)
setMaxPDUSize in interface DirectoryServicemaxPDUSize - A positive number of bytes for the PDU. A negative or
null value will be transformed to Integer.MAX_VALUEpublic Interceptor getInterceptor(String interceptorName)
getInterceptor in interface DirectoryServiceinterceptorName - The interceptor's name for which we want the instancepublic void addFirst(Interceptor interceptor) throws org.apache.directory.api.ldap.model.exception.LdapException
addFirst in interface DirectoryServiceinterceptor - The added interceptororg.apache.directory.api.ldap.model.exception.LdapExceptionpublic void addLast(Interceptor interceptor) throws org.apache.directory.api.ldap.model.exception.LdapException
addLast in interface DirectoryServiceinterceptor - The added interceptororg.apache.directory.api.ldap.model.exception.LdapExceptionpublic void addAfter(String interceptorName, Interceptor interceptor)
addAfter in interface DirectoryServiceinterceptorName - The interceptor name to findinterceptor - The added interceptorpublic void remove(String interceptorName)
remove in interface DirectoryServiceinterceptorName - The interceptor to removepublic org.apache.directory.api.ldap.model.csn.Csn getCSN()
getCSN in interface DirectoryServicepublic int getReplicaId()
getReplicaId in interface DirectoryServicepublic void setReplicaId(int replicaId)
setReplicaId in interface DirectoryServicereplicaId - the replicaId to setpublic long getSyncPeriodMillis()
getSyncPeriodMillis in interface DirectoryServicepublic void setSyncPeriodMillis(long syncPeriodMillis)
setSyncPeriodMillis in interface DirectoryServicesyncPeriodMillis - the syncPeriodMillis to setpublic CacheService getCacheService()
getCacheService in interface DirectoryServicepublic org.apache.directory.api.ldap.util.tree.DnNode<AccessControlAdministrativePoint> getAccessControlAPCache()
getAccessControlAPCache in interface DirectoryServicepublic org.apache.directory.api.ldap.util.tree.DnNode<CollectiveAttributeAdministrativePoint> getCollectiveAttributeAPCache()
getCollectiveAttributeAPCache in interface DirectoryServicepublic org.apache.directory.api.ldap.util.tree.DnNode<SubschemaAdministrativePoint> getSubschemaAPCache()
getSubschemaAPCache in interface DirectoryServicepublic org.apache.directory.api.ldap.util.tree.DnNode<TriggerExecutionAdministrativePoint> getTriggerExecutionAPCache()
getTriggerExecutionAPCache in interface DirectoryServicepublic boolean isPwdPolicyEnabled()
isPwdPolicyEnabled in interface DirectoryServicepublic DnFactory getDnFactory()
getDnFactory in interface DirectoryServicepublic void setDnFactory(DnFactory dnFactory)
setDnFactory in interface DirectoryServicepublic SubentryCache getSubentryCache()
getSubentryCache in interface DirectoryServicepublic SubtreeEvaluator getEvaluator()
getEvaluator in interface DirectoryServicepublic void setCacheService(CacheService cacheService)
setCacheService in interface DirectoryServicecacheService - the cache servicepublic AttributeTypeProvider getAtProvider()
AttributeTypeProvider.getAtProvider in interface DirectoryServiceAttributeTypeProviderpublic ObjectClassProvider getOcProvider()
ObjectClassProvider.getOcProvider in interface DirectoryServiceObjectClassProviderCopyright © 2021. All rights reserved.