|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DirectoryService
Provides JNDI service to AbstractContextFactory
.
Field Summary | |
---|---|
static java.lang.String |
JNDI_KEY
|
Method Summary | |
---|---|
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()
|
java.lang.String |
getInstanceId()
|
Interceptor |
getInterceptor(java.lang.String interceptorName)
Get an Interceptor instance from its name |
InterceptorChain |
getInterceptorChain()
|
java.util.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. |
PartitionNexus |
getPartitionNexus()
|
java.util.Set<? extends Partition> |
getPartitions()
Gets the Partition s 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,
java.lang.String saslMechanism,
java.lang.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. |
Partition |
getSystemPartition()
|
java.util.List<org.apache.directory.shared.ldap.ldif.LdifEntry> |
getTestEntries()
Returns test directory entries( LdifEntry ) to be loaded while
bootstrapping. |
java.io.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()
|
boolean |
isExitVmOnShutdown()
|
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(java.lang.String ldif,
java.lang.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)
|
void |
setEventService(EventService eventService)
|
void |
setExitVmOnShutdown(boolean exitVmOnShutdown)
|
void |
setInstanceId(java.lang.String instanceId)
|
void |
setInterceptors(java.util.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(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 |
setReplicationConfiguration(ReplicationConfiguration replicationConfig)
Sets the replication configuration in the server. |
void |
setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
Associates a SchemaManager to the service |
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 |
setSystemPartition(Partition systemPartition)
|
void |
setTestEntries(java.util.List<? extends org.apache.directory.shared.ldap.ldif.LdifEntry> testEntries)
Sets test directory entries( Attributes ) to be loaded while
bootstrapping. |
void |
setWorkingDirectory(java.io.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 Partition s. |
Methods inherited from interface org.apache.directory.server.core.entry.ServerEntryFactory |
---|
newEntry |
Field Detail |
---|
static final java.lang.String JNDI_KEY
Method Detail |
---|
long revert(long revision) throws java.lang.Exception
revision
- the revision number to revert to
java.lang.Exception
- if there are problems reverting back to the earlier state
java.lang.IllegalArgumentException
- if the revision provided is greater than the current
revision or less than 0
java.lang.UnsupportedOperationException
- if this feature is not supported by the
change loglong revert() throws java.lang.Exception
java.lang.Exception
- if there are problems reverting back to the earlier state
java.lang.UnsupportedOperationException
- if this feature is not supported by the
change logPartitionNexus getPartitionNexus()
InterceptorChain getInterceptorChain()
void addPartition(Partition partition) throws java.lang.Exception
java.lang.Exception
void removePartition(Partition partition) throws java.lang.Exception
java.lang.Exception
org.apache.directory.shared.ldap.schema.SchemaManager getSchemaManager()
ReferralManager getReferralManager()
void setReferralManager(ReferralManager referralManager)
referralManager
- The initialized referralManagerSchemaService getSchemaService()
void setSchemaService(SchemaService schemaService)
EventService getEventService()
void setEventService(EventService eventService)
void startup() throws java.lang.Exception
java.lang.Exception
- if failed to start upvoid shutdown() throws java.lang.Exception
java.lang.Exception
- if failed to shut downvoid sync() throws java.lang.Exception
Partition.sync()
for all registered Partition
s.
java.lang.Exception
- if synchronization failedboolean isStarted()
CoreSession getAdminSession() throws java.lang.Exception
java.lang.Exception
CoreSession getSession() throws java.lang.Exception
java.lang.Exception
CoreSession getSession(LdapPrincipal principal) throws java.lang.Exception
java.lang.Exception
CoreSession getSession(org.apache.directory.shared.ldap.name.DN principalDn, byte[] credentials) throws java.lang.Exception
java.lang.Exception
CoreSession getSession(org.apache.directory.shared.ldap.name.DN principalDn, byte[] credentials, java.lang.String saslMechanism, java.lang.String saslAuthId) throws java.lang.Exception
java.lang.Exception
void setInstanceId(java.lang.String instanceId)
java.lang.String getInstanceId()
java.util.Set<? extends Partition> getPartitions()
Partition
s used by this DirectoryService.
void setPartitions(java.util.Set<? extends Partition> partitions)
Partition
s used by this DirectoryService.
partitions
- the partitions to usedboolean isAccessControlEnabled()
void setAccessControlEnabled(boolean accessControlEnabled)
accessControlEnabled
- true to enable access control checks, false otherwiseboolean isAllowAnonymousAccess()
boolean isPasswordHidden()
void setAllowAnonymousAccess(boolean enableAnonymousAccess)
enableAnonymousAccess
- true to enable anonymous access, false to disable itvoid setPasswordHidden(boolean passwordHidden)
passwordHidden
- true to enable hide the userPassword attribute, false otherwisejava.util.List<Interceptor> getInterceptors()
void setInterceptors(java.util.List<Interceptor> interceptors)
interceptors
- the interceptors to be used in the server.void setJournal(Journal journal)
java.util.List<org.apache.directory.shared.ldap.ldif.LdifEntry> getTestEntries()
LdifEntry
) to be loaded while
bootstrapping.
void setTestEntries(java.util.List<? extends org.apache.directory.shared.ldap.ldif.LdifEntry> testEntries)
Attributes
) to be loaded while
bootstrapping.
testEntries
- the test entries to load while bootstrappingjava.io.File getWorkingDirectory()
void setWorkingDirectory(java.io.File workingDirectory)
workingDirectory
- the directory where the server's partitions are stored by default.void setShutdownHookEnabled(boolean shutdownHookEnabled)
shutdownHookEnabled
- true to enable the shutdown hook, false to disableboolean isShutdownHookEnabled()
void setExitVmOnShutdown(boolean exitVmOnShutdown)
boolean isExitVmOnShutdown()
void setSystemPartition(Partition systemPartition)
Partition getSystemPartition()
boolean isDenormalizeOpAttrsEnabled()
void setDenormalizeOpAttrsEnabled(boolean denormalizeOpAttrsEnabled)
ChangeLog getChangeLog()
Journal getJournal()
void setChangeLog(ChangeLog changeLog)
changeLog
- the change log service to setorg.apache.directory.shared.ldap.entry.ServerEntry newEntry(java.lang.String ldif, java.lang.String dn)
ldif
- the String representing the attributes, in LDIF formatdn
- the DN for this new entryOperationManager getOperationManager()
int getMaxPDUSize()
void setMaxPDUSize(int maxPDUSize)
maxPDUSize
- A positive number of bytes for the PDU. A negative or
null value will be transformed to Integer.MAX_VALUE
Interceptor getInterceptor(java.lang.String interceptorName)
interceptorName
- The interceptor's name for which we want the instance
org.apache.directory.shared.ldap.csn.Csn getCSN()
int getReplicaId()
void setReplicaId(int replicaId)
replicaId
- the replicaId to setvoid setReplicationConfiguration(ReplicationConfiguration replicationConfig)
replicationConfiguration
- the replication configuration to be used in the server.ReplicationConfiguration getReplicationConfiguration()
void setSchemaManager(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
schemaManager
- The SchemaManager to associate
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |