org.apache.directory.server.core.shared.partition

Class DefaultPartitionNexus

java.lang.Object

org.apache.directory.server.core.api.partition.AbstractPartition

org.apache.directory.server.core.shared.partition.DefaultPartitionNexus

All Implemented Interfaces:

Partition, PartitionNexus

public class DefaultPartitionNexus
extends AbstractPartition
implements PartitionNexus

A root Partition that contains all other partitions, and routes all operations to the child partition that matches to its base suffixes. It also provides some extended operations such as accessing rootDSE and listing base suffixes.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	ASF the vendorName string proudly set to: Apache Software Foundation
private DirectoryService	directoryService The DirectoryService instance
private static java.lang.String	ID the fixed id: 'NEXUS'
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG A logger for this class
private java.util.List<org.apache.directory.api.ldap.model.entry.Modification>	mods
private org.apache.directory.api.ldap.util.tree.DnNode<Partition>	partitionLookupTree A structure to hold all the partitions
private java.util.Map<java.lang.String,Partition>	partitions the partitions keyed by normalized suffix strings
private org.apache.directory.api.ldap.model.entry.Entry	rootDse the read only rootDSE attributes
private org.apache.directory.api.ldap.model.name.Dn	subschemSubentryDn The cn=schema Dn

Fields inherited from class org.apache.directory.server.core.api.partition.AbstractPartition

cacheService, contextEntry, ctxCsnChanged, dnFactory, id, initialized, schemaManager, suffixDn

Fields inherited from interface org.apache.directory.server.core.api.partition.PartitionNexus

ADMIN_PASSWORD_BYTES, ADMIN_PASSWORD_STRING, ADMIN_UID

Fields inherited from interface org.apache.directory.server.core.api.partition.Partition

DEFAULT_ID, ROOT_ID

Constructor Summary

Constructors

Constructor and Description
DefaultPartitionNexus(org.apache.directory.api.ldap.model.entry.Entry rootDse) Creates the root nexus singleton of the entire system.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Adds an entry to this ContextPartition.
void	addContextPartition(Partition partition) Add a partition to the server.
boolean	compare(CompareOperationContext compareContext)
private void	createContextCsnModList()
org.apache.directory.api.ldap.model.entry.Entry	delete(DeleteOperationContext deleteContext) Deletes a leaf entry from this ContextPartition: non-leaf entries cannot be deleted until this operation has been applied to their children.
protected void	doDestroy() Override this method to put your initialization code.
protected void	doInit() Override this method to put your initialization code.
java.lang.String	getContextCsn()
DirectoryService	getDirectoryService()
Partition	getPartition(org.apache.directory.api.ldap.model.name.Dn dn) Get's the partition corresponding to a distinguished name.
org.apache.directory.api.ldap.model.entry.Entry	getRootDse(GetRootDseOperationContext getRootDseContext) Get's the RootDSE entry for the DSA.
org.apache.directory.api.ldap.model.entry.Value<?>	getRootDseValue(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Get's the RootDSE value associated with an AttributeType
org.apache.directory.api.ldap.model.name.Dn	getSuffixDn(org.apache.directory.api.ldap.model.name.Dn dn) Finds the distinguished name of the suffix that would hold an entry with the supplied distinguished name parameter.
boolean	hasEntry(HasEntryOperationContext hasEntryContext) Fast operation to check and see if a particular entry exists.
java.util.Set<java.lang.String>	listSuffixes() Gets an iteration over the Name suffixes of the partitions managed by this DefaultPartitionNexus.
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext) Looks up an entry by distinguished/absolute name.
void	modify(ModifyOperationContext modifyContext) Modifies an entry by adding, removing or replacing a set of attributes.
void	move(MoveOperationContext moveContext) Transplants a child entry, to a position in the namespace under a new parent entry.
void	moveAndRename(MoveAndRenameOperationContext moveAndRenameContext) Transplants a child entry, to a position in the namespace under a new parent entry and changes the RN of the child entry which can optionally have its old RN attributes removed.
void	registerSupportedExtensions(java.util.Set<java.lang.String> extensionOids) Adds a set of supportedExtension (OID Strings) to the RootDSE.
void	registerSupportedSaslMechanisms(java.util.Set<java.lang.String> supportedSaslMechanisms) Adds a set of supportedSaslMechanisms (OID Strings) to the RootDSE.
void	removeContextPartition(org.apache.directory.api.ldap.model.name.Dn partitionDn) Remove a partition from the server.
void	rename(RenameOperationContext renameContext) Modifies an entry by changing its relative name.
void	saveContextCsn() saves the context CSN value in the context entry of the partition
EntryFilteringCursor	search(SearchOperationContext searchContext) Conducts a search against this ContextPartition.
private EntryFilteringCursor	searchFromRoot(SearchOperationContext searchContext) Do a search from the root of the DIT.
private EntryFilteringCursor	searchRootDse(SearchOperationContext searchContext)
void	setDirectoryService(DirectoryService directoryService)
void	setId(java.lang.String id) Sets the unique identifier for this partition.
void	setSuffixDn(org.apache.directory.api.ldap.model.name.Dn suffix) Sets the suffix Dn, must be normalized.
void	sync() Flushes any changes made to this partition now.
void	unbind(UnbindOperationContext unbindContext) Represents an unbind operation issued by an authenticated client.
private void	unregister(Partition partition) Unregisters an ContextPartition with this BackendManager.

Methods inherited from class org.apache.directory.server.core.api.partition.AbstractPartition

checkInitialized, destroy, dumpIndex, getContextEntry, getId, getSchemaManager, getSuffixDn, initialize, isInitialized, setCacheService, setContextCsn, setContextEntry, setSchemaManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.server.core.api.partition.Partition

destroy, dumpIndex, getId, getSchemaManager, getSuffixDn, initialize, isInitialized, setCacheService, setSchemaManager

Field Detail

LOG

private static final org.slf4j.Logger LOG

A logger for this class

ID

private static final java.lang.String ID

the fixed id: 'NEXUS'

See Also:

Constant Field Values

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

ASF

private static final java.lang.String ASF

the vendorName string proudly set to: Apache Software Foundation

See Also:

Constant Field Values

rootDse

private final org.apache.directory.api.ldap.model.entry.Entry rootDse

the read only rootDSE attributes

directoryService

private DirectoryService directoryService

The DirectoryService instance

partitions

private java.util.Map<java.lang.String,Partition> partitions

the partitions keyed by normalized suffix strings

partitionLookupTree

private org.apache.directory.api.ldap.util.tree.DnNode<Partition> partitionLookupTree

A structure to hold all the partitions

mods

private final java.util.List<org.apache.directory.api.ldap.model.entry.Modification> mods

subschemSubentryDn

private org.apache.directory.api.ldap.model.name.Dn subschemSubentryDn

The cn=schema Dn

Constructor Detail

DefaultPartitionNexus

public DefaultPartitionNexus(org.apache.directory.api.ldap.model.entry.Entry rootDse)
                      throws java.lang.Exception

Creates the root nexus singleton of the entire system. The root DSE has several attributes that are injected into it besides those that may already exist. As partitions are added to the system more namingContexts attributes are added to the rootDSE.

Parameters:

rootDse - the root entry for the DSA

Throws:

javax.naming.Exception - on failure to initialize

java.lang.Exception

See Also:

Vendor Information

Method Detail

doInit

protected void doInit()
               throws java.lang.Exception

Description copied from class: AbstractPartition

Override this method to put your initialization code.

Specified by:

doInit in class AbstractPartition

Throws:

java.lang.Exception

doDestroy

protected void doDestroy()

Description copied from class: AbstractPartition

Override this method to put your initialization code.

Specified by:

doDestroy in class AbstractPartition

setId

public void setId(java.lang.String id)

Sets the unique identifier for this partition.

Specified by:

setId in interface Partition

Overrides:

setId in class AbstractPartition

Parameters:

id - the unique identifier for this partition

setSuffixDn

public void setSuffixDn(org.apache.directory.api.ldap.model.name.Dn suffix)

Sets the suffix Dn, must be normalized.

Specified by:

setSuffixDn in interface Partition

Overrides:

setSuffixDn in class AbstractPartition

Parameters:

suffix - the new suffix Dn

sync

public void sync()
          throws java.lang.Exception

Description copied from interface: Partition

Flushes any changes made to this partition now.

Specified by:

sync in interface Partition

Throws:

java.lang.Exception - if buffers cannot be flushed to disk

add

public void add(AddOperationContext addContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry to this ContextPartition.

Specified by:

add in interface Partition

Parameters:

addContext - the context used to add and entry to this ContextPartition

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if there are any problems

compare

public boolean compare(CompareOperationContext compareContext)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Specified by:

compare in interface PartitionNexus

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

delete

public org.apache.directory.api.ldap.model.entry.Entry delete(DeleteOperationContext deleteContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes a leaf entry from this ContextPartition: non-leaf entries cannot be deleted until this operation has been applied to their children.

Specified by:

delete in interface Partition

Parameters:

deleteContext - the context of the entry to delete from this ContextPartition.

Returns:

The delete Entry, if found

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

hasEntry

public boolean hasEntry(HasEntryOperationContext hasEntryContext)
                 throws org.apache.directory.api.ldap.model.exception.LdapException

Fast operation to check and see if a particular entry exists.

Specified by:

hasEntry in interface Partition

Parameters:

hasEntryContext - The context used to pass informations

Returns:

true if the entry exists, false if it does not

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(LookupOperationContext lookupContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Looks up an entry by distinguished/absolute name. This is a simplified version of the search operation used to point read an entry used for convenience. Depending on the context parameters, we my look for a simple entry, or for a restricted set of attributes for this entry

Specified by:

lookup in interface Partition

Parameters:

lookupContext - The context containing the parameters

Returns:

an Attributes object representing the entry

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(ModifyOperationContext modifyContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry by adding, removing or replacing a set of attributes.

Specified by:

modify in interface Partition

Parameters:

modifyContext - The context containing the modification operation to perform on the entry which is one of constants specified by the DirContext interface: ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

See Also:

DirContext, DirContext.ADD_ATTRIBUTE, DirContext.REMOVE_ATTRIBUTE, DirContext.REPLACE_ATTRIBUTE

move

public void move(MoveOperationContext moveContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException

Transplants a child entry, to a position in the namespace under a new parent entry.

Specified by:

move in interface Partition

Parameters:

moveContext - The context containing the DNs to move

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(MoveAndRenameOperationContext moveAndRenameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Transplants a child entry, to a position in the namespace under a new parent entry and changes the RN of the child entry which can optionally have its old RN attributes removed. The removal of old RN attributes may not make sense in all namespaces. If the concept is undefined in a namespace this parameters is ignored. An example of a namespace where this parameter is significant is the LDAP namespace.

Specified by:

moveAndRename in interface Partition

Parameters:

moveAndRenameContext - The context contain all the information about the modifyDN operation

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(RenameOperationContext renameContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Modifies an entry by changing its relative name. Optionally attributes associated with the old relative name can be removed from the entry. This makes sense only in certain namespaces like LDAP and will be ignored if it is irrelevant.

Specified by:

rename in interface Partition

Parameters:

renameContext - the modify Dn context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

searchRootDse

private EntryFilteringCursor searchRootDse(SearchOperationContext searchContext)
                                    throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

search

public EntryFilteringCursor search(SearchOperationContext searchContext)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Conducts a search against this ContextPartition. Namespace specific parameters for search are contained within the environment using namespace specific keys into the hash. For example in the LDAP namespace a ContextPartition implementation may look for search Controls using a namespace specific or implementation specific key for the set of LDAP Controls.

Specified by:

search in interface Partition

Parameters:

searchContext - The context containing the information used by the operation

Returns:

a NamingEnumeration containing objects of type

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

searchFromRoot

private EntryFilteringCursor searchFromRoot(SearchOperationContext searchContext)
                                     throws org.apache.directory.api.ldap.model.exception.LdapException

Do a search from the root of the DIT. We have a few use cases to consider : A) The scope is OBJECT If the filter is (ObjectClass = *), then this is a RootDSE fetch, otherwise, we just return nothing. B) The scope is ONELEVEL We just return the contextEntries of all the existing partitions C) The scope is SUBLEVEL : In this case, we have to do a search in each of the existing partition. We will get back a list of cursors and we will wrap this list in the resulting EntryFilteringCursor.

Parameters:

searchContext -

Returns:

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unbind

public void unbind(UnbindOperationContext unbindContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Represents an unbind operation issued by an authenticated client. Partitions need not support this operation. This operation is here to enable those interested in implementing virtual directories with ApacheDS.

Specified by:

unbind in interface Partition

Parameters:

unbindContext - the context used to unbind

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getRootDse

public org.apache.directory.api.ldap.model.entry.Entry getRootDse(GetRootDseOperationContext getRootDseContext)

Get's the RootDSE entry for the DSA.

Specified by:

getRootDse in interface PartitionNexus

Returns:

the attributes of the RootDSE

getRootDseValue

public org.apache.directory.api.ldap.model.entry.Value<?> getRootDseValue(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)

Get's the RootDSE value associated with an AttributeType

Specified by:

getRootDseValue in interface PartitionNexus

Parameters:

attributeType - The attribute type for which we want a value

Returns:

the values associated with the given attributeType

addContextPartition

public void addContextPartition(Partition partition)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Add a partition to the server.

Specified by:

addContextPartition in interface PartitionNexus

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

removeContextPartition

public void removeContextPartition(org.apache.directory.api.ldap.model.name.Dn partitionDn)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Remove a partition from the server.

Specified by:

removeContextPartition in interface PartitionNexus

Parameters:

partitionDn - the partition Dn

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getPartition

public Partition getPartition(org.apache.directory.api.ldap.model.name.Dn dn)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Get's the partition corresponding to a distinguished name. This name need not be the name of the partition suffix. When used in conjunction with get suffix this can properly find the partition associated with the Dn. Make sure to use the normalized Dn.

Specified by:

getPartition in interface PartitionNexus

Parameters:

dn - the normalized distinguished name to get a partition for

Returns:

the partition containing the entry represented by the dn

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getSuffixDn

public org.apache.directory.api.ldap.model.name.Dn getSuffixDn(org.apache.directory.api.ldap.model.name.Dn dn)
                                                        throws org.apache.directory.api.ldap.model.exception.LdapException

Finds the distinguished name of the suffix that would hold an entry with the supplied distinguished name parameter. If the Dn argument does not fall under a partition suffix then the empty string Dn is returned.

Specified by:

getSuffixDn in interface PartitionNexus

Returns:

the suffix portion of dn, or the valid empty string Dn if no naming context was found for dn.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

listSuffixes

public java.util.Set<java.lang.String> listSuffixes()
                                             throws org.apache.directory.api.ldap.model.exception.LdapException

Description copied from interface: PartitionNexus

Gets an iteration over the Name suffixes of the partitions managed by this DefaultPartitionNexus.

Specified by:

listSuffixes in interface PartitionNexus

Returns:

Iteration over ContextPartition suffix names as Names.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

registerSupportedExtensions

public void registerSupportedExtensions(java.util.Set<java.lang.String> extensionOids)
                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Adds a set of supportedExtension (OID Strings) to the RootDSE.

Specified by:

registerSupportedExtensions in interface PartitionNexus

Parameters:

extensionOids - a set of OID strings to add to the supportedExtension attribute in the RootDSE

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

registerSupportedSaslMechanisms

public void registerSupportedSaslMechanisms(java.util.Set<java.lang.String> supportedSaslMechanisms)
                                     throws org.apache.directory.api.ldap.model.exception.LdapException

Adds a set of supportedSaslMechanisms (OID Strings) to the RootDSE.

Specified by:

registerSupportedSaslMechanisms in interface PartitionNexus

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

unregister

private void unregister(Partition partition)
                 throws java.lang.Exception

Unregisters an ContextPartition with this BackendManager. Called for each registered Backend right befor it is to be stopped. This prevents protocol server requests from reaching the Backend and effectively puts the ContextPartition's naming context offline. Operations against the naming context should result in an LDAP BUSY result code in the returnValue if the naming context is not online.

Parameters:

partition - ContextPartition component to unregister with this BackendNexus.

Throws:

java.lang.Exception - if there are problems unregistering the partition

getDirectoryService

public DirectoryService getDirectoryService()

Returns:

the directoryService

setDirectoryService

public void setDirectoryService(DirectoryService directoryService)

Parameters:

directoryService - the directoryService to set

createContextCsnModList

private void createContextCsnModList()
                              throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

getContextCsn

public java.lang.String getContextCsn()

Description copied from class: AbstractPartition

Specified by:

getContextCsn in interface Partition

Overrides:

getContextCsn in class AbstractPartition

Returns:

the current highest committed CSN value

saveContextCsn

public void saveContextCsn()
                    throws java.lang.Exception

Description copied from interface: Partition

saves the context CSN value in the context entry of the partition

Specified by:

saveContextCsn in interface Partition

Throws:

java.lang.Exception