org.apache.directory.server.core.partition.impl.btree

Class AbstractBTreePartition

java.lang.Object

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

org.apache.directory.server.core.partition.impl.btree.AbstractBTreePartition

All Implemented Interfaces:

Partition, Store

Direct Known Subclasses:

AvlPartition, JdbmPartition, MavibotPartition

public abstract class AbstractBTreePartition
extends AbstractPartition
implements Store

An abstract Partition that uses general BTree operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ADD_CHILD
protected org.apache.directory.api.ldap.model.schema.AttributeType	administrativeRoleAT
protected Index<java.lang.String,java.lang.String>	adminRoleIdx a system index on administrativeRole attribute
protected net.sf.ehcache.Cache	aliasCache The alias cache
protected org.apache.directory.api.ldap.model.schema.AttributeType	aliasedObjectNameAT
protected Index<org.apache.directory.api.ldap.model.name.Dn,java.lang.String>	aliasIdx a system index on aliasedObjectName attribute
protected int	cacheSize The Entry cache size for this partition
protected org.apache.directory.api.ldap.model.schema.AttributeType	contextCsnAT
private java.util.concurrent.Semaphore	ctxCsnSemaphore a semaphore to serialize the writes on context entry while updating contextCSN attribute
static int	DEFAULT_CACHE_SIZE The default cache size is set to 10 000 objects
protected org.apache.directory.api.ldap.model.schema.AttributeType	entryCsnAT
protected Index<java.lang.String,java.lang.String>	entryCsnIdx a system index on entryCSN attribute
protected org.apache.directory.api.ldap.model.schema.AttributeType	entryDnAT
private net.sf.ehcache.Cache	entryDnCache a cache to hold pairs, this is used for speeding up the buildEntryDn() method
protected org.apache.directory.api.ldap.model.schema.AttributeType	entryUuidAT
private java.util.Set<Index<?,java.lang.String>>	indexedAttributes The set of indexed attributes
protected java.util.concurrent.atomic.AtomicBoolean	isSyncOnWrite true if we sync disks on every write operation
private static org.slf4j.Logger	LOG static logger
protected MasterTable	master the master table storing entries by primary key
private static boolean	NO_REVERSE
protected org.apache.directory.api.ldap.model.schema.AttributeType	objectClassAT Cached attributes types to avoid lookup all over the code
protected Index<java.lang.String,java.lang.String>	objectClassIdx a system index on objectClass attribute
protected Index<java.lang.String,java.lang.String>	oneAliasIdx the one level scope alias index
private Optimizer	optimizer The optimizer to use during search operation
protected boolean	optimizerEnabled Tells if the Optimizer is enabled
protected java.net.URI	partitionPath The path in which this Partition stores files
protected net.sf.ehcache.Cache	piarCache The ParentIdAndRdn cache
protected Index<java.lang.String,java.lang.String>	presenceIdx the attribute presence index
protected Index<ParentIdAndRdn,java.lang.String>	rdnIdx the relative distinguished name index
protected static boolean	REMOVE_CHILD
private java.util.concurrent.locks.ReadWriteLock	rwLock A lock to protect the backend from concurrent reads/writes
private SearchEngine	searchEngine the search engine used to search the database
protected Index<java.lang.String,java.lang.String>	subAliasIdx the subtree scope alias index
private java.lang.String	suffixId The suffix UUID
protected java.util.Map<java.lang.String,Index<?,java.lang.String>>	systemIndices a map of attributeType numeric UUID to system userIndices
protected java.util.Map<java.lang.String,Index<?,java.lang.String>>	userIndices a map of attributeType numeric UUID to user userIndices
private static boolean	WITH_REVERSE

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.xdbm.Store

SYS_INDEX_OID_ARRAY, SYS_INDEX_OIDS

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

DEFAULT_ID, ROOT_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBTreePartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a B-tree based context partition.
protected	AbstractBTreePartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, DnFactory dnFactory) Creates a B-tree based context partition.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Adds an entry to this ContextPartition.
protected void	addAliasIndices(java.lang.String aliasId, org.apache.directory.api.ldap.model.name.Dn aliasDn, org.apache.directory.api.ldap.model.name.Dn aliasTarget) Adds userIndices for an aliasEntry to be added to the database while checking for constrained alias constructs like alias cycles and chaining.
void	addIndex(Index<?,java.lang.String> index) Adds a (system or user) index to the list of index for this store.
void	addIndexedAttributes(Index<?,java.lang.String>... indexes) Add some new indexes
void	addToCache(java.lang.String id, org.apache.directory.api.ldap.model.entry.Entry entry) adds the given entry to cache Note: this method is not called during add operation to avoid filling the cache with all the added entries
protected org.apache.directory.api.ldap.model.name.Dn	buildEntryDn(java.lang.String id) builds the Dn of the entry identified by the given id
protected abstract Index<?,java.lang.String>	convertAndInit(Index<?,java.lang.String> index) Convert and initialize an index for a specific store implementation.
long	count() Gets the total count of entries within this store.
protected abstract Index	createSystemIndex(java.lang.String indexOid, java.net.URI path, boolean withReverse) Create a new Index for a given OID
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.
org.apache.directory.api.ldap.model.entry.Entry	delete(java.lang.String id) Delete the entry associated with a given Id
protected void	doDestroy() Override this method to put your initialization code.
protected void	doInit() Override this method to put your initialization code.
protected void	dropAliasIndices(java.lang.String aliasId) Removes the index entries for an alias before the entry is deleted from the master table.
protected void	dropMovedAliasIndices(org.apache.directory.api.ldap.model.name.Dn movedBase) For all aliases including and under the moved base, this method removes one and subtree alias index tuples for old ancestors above the moved base that will no longer be ancestors after the move.
private void	dumpAllRdnIdx()
private void	dumpIndex(java.io.OutputStream stream, Index<?,java.lang.String> index)
void	dumpIndex(java.io.OutputStream stream, java.lang.String name) Dump the requested index to a given stream
private void	dumpRdnIdx()
private void	dumpRdnIdx(java.lang.String id, int nbSibbling, java.lang.String tabs)
void	dumpRdnIdx(java.lang.String id, java.lang.String tabs)
org.apache.directory.api.ldap.model.entry.Entry	fetch(java.lang.String id) Get back an entry knowing its UUID
org.apache.directory.api.ldap.model.entry.Entry	fetch(java.lang.String id, org.apache.directory.api.ldap.model.name.Dn dn) Get back an entry knowing its UUID
Index<java.lang.String,java.lang.String>	getAdministrativeRoleIndex()
net.sf.ehcache.Cache	getAliasCache()
Index<org.apache.directory.api.ldap.model.name.Dn,java.lang.String>	getAliasIndex()
int	getCacheSize() Gets the entry cache size for this BTreePartition.
long	getChildCount(java.lang.String id) Gets the count of immediate children of the given entry UUID.
java.lang.String	getContextCsn()
Index<java.lang.String,java.lang.String>	getEntryCsnIndex()
org.apache.directory.api.ldap.model.name.Dn	getEntryDn(java.lang.String id) Gets the Entry's Dn identified by the given id.
java.lang.String	getEntryId(org.apache.directory.api.ldap.model.name.Dn dn) Gets the entry's id.
Index<?,java.lang.String>	getIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Get the user or system index associated with the given attributeType
java.util.Set<Index<?,java.lang.String>>	getIndexedAttributes()
MasterTable	getMasterTable() Expose the Master table
Index<java.lang.String,java.lang.String>	getObjectClassIndex()
Index<java.lang.String,java.lang.String>	getOneAliasIndex()
Optimizer	getOptimizer()
java.lang.String	getParentId(java.lang.String childId) Gets the UUID of an entry's parent using the child entry's UUID.
java.net.URI	getPartitionPath() Gets the path in which this Partition stores data.
Index<java.lang.String,java.lang.String>	getPresenceIndex()
Index<ParentIdAndRdn,java.lang.String>	getRdnIndex()
java.util.concurrent.locks.ReadWriteLock	getReadWriteLock()
SearchEngine	getSearchEngine() Gets the DefaultSearchEngine used by this ContextPartition to search the Database.
Index<java.lang.String,java.lang.String>	getSubAliasIndex()
protected java.lang.String	getSuffixId() Retrieve the SuffixID
Index<?,java.lang.String>	getSystemIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Get the system index associated with the given name
java.util.Iterator<java.lang.String>	getSystemIndices() An iterator build on top of the System's index
Index<?,java.lang.String>	getUserIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Get the user index associated with the given name
java.util.Iterator<java.lang.String>	getUserIndices() An iterator build on top of the User's index
boolean	hasEntry(HasEntryOperationContext entryContext) This method calls Partition.lookup(LookupOperationContext) and return true if it returns an entry by default.
boolean	hasIndexOn(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Tells if an index is already present in the User's or System's index list
boolean	hasSystemIndexOn(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Tells if an index is already present in the System's index list
boolean	hasUserIndexOn(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Tells if an index is already present in the User's index list
private void	initInstance() Intializes the instance.
boolean	isOptimizerEnabled() Tells if the Optimizer is enabled or not
boolean	isSyncOnWrite()
protected void	loadContextCsn() Loads the current context CSN present in the context entry of the partition
private void	lockRead() Acquire a Read lock
private void	lockWrite() Acquire a Write lock
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext) Looks up an entry by distinguished/absolute name.
org.apache.directory.api.ldap.model.entry.Entry	lookupCache(java.lang.String id) looks up for the entry with the given ID in the cache
org.apache.directory.api.ldap.model.entry.Entry	modify(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.entry.Modification... mods) Modify an entry applying the given list of modifications.
void	modify(ModifyOperationContext modifyContext) Modifies an entry by adding, removing or replacing a set of attributes.
private void	modifyAdd(java.lang.String id, org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.entry.Attribute mods) Adds a set of attribute values while affecting the appropriate userIndices.
private void	modifyRemove(java.lang.String id, org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.entry.Attribute mods) Completely removes the set of values for an attribute having the values supplied while affecting the appropriate userIndices.
private void	modifyReplace(java.lang.String id, org.apache.directory.api.ldap.model.entry.Entry entry, org.apache.directory.api.ldap.model.entry.Attribute mods) Completely replaces the existing set of values for an attribute with the modified values supplied affecting the appropriate userIndices.
void	move(org.apache.directory.api.ldap.model.name.Dn oldDn, org.apache.directory.api.ldap.model.name.Dn newSuperiorDn, org.apache.directory.api.ldap.model.name.Dn newDn, org.apache.directory.api.ldap.model.entry.Entry modifiedEntry) Move an entry from one place to the other.
void	move(MoveOperationContext moveContext) Transplants a child entry, to a position in the namespace under a new parent entry.
void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn oldDn, org.apache.directory.api.ldap.model.name.Dn newSuperiorDn, org.apache.directory.api.ldap.model.name.Rdn newRdn, org.apache.directory.api.ldap.model.entry.Entry modifiedEntry, boolean deleteOldRdn)
private void	moveAndRename(org.apache.directory.api.ldap.model.name.Dn oldDn, java.lang.String entryId, org.apache.directory.api.ldap.model.name.Dn newSuperior, org.apache.directory.api.ldap.model.name.Rdn newRdn, org.apache.directory.api.ldap.model.entry.Entry modifiedEntry) Moves an entry under a new parent.
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	rename(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, org.apache.directory.api.ldap.model.entry.Entry entry) Changes the relative distinguished name of an entry specified by a distinguished name with the optional removal of the old Rdn attribute value from the entry.
void	rename(RenameOperationContext renameContext) Modifies an entry by changing its relative name.
private void	rename(java.lang.String oldId, org.apache.directory.api.ldap.model.name.Rdn newRdn, boolean deleteOldRdn, org.apache.directory.api.ldap.model.entry.Entry entry) This will rename the entry, and deal with the deleteOldRdn flag.
void	saveContextCsn() saves the context CSN value in the context entry of the partition
EntryFilteringCursor	search(SearchOperationContext searchContext) Conducts a search against this ContextPartition.
void	setCacheSize(int cacheSize) Used to specify the entry cache size for a Partition.
void	setIndexedAttributes(java.util.Set<Index<?,java.lang.String>> indexedAttributes) Set the list of indexes for this partition
void	setOptimizer(Optimizer optimizer)
void	setOptimizerEnabled(boolean optimizerEnabled) Set the optimizer flag
void	setPartitionPath(java.net.URI partitionPath) Sets the path in which this Partition stores data.
private void	setRWLock(OperationContext operationContext) Set and return the ReadWrite lock we use to protect the backend against concurrent modifications
void	setSearchEngine(SearchEngine searchEngine)
void	setSyncOnWrite(boolean isSyncOnWrite) Sets the flag telling the server to flush on disk when some modification has been done.
protected void	setupSystemIndices() Sets up the system indices.
protected void	setupUserIndices() Sets up the user indices.
java.lang.String	toString()
void	unbind(UnbindOperationContext unbindContext) Represents an unbind operation issued by an authenticated client.
private void	unlockRead() Release a Read lock
private void	unlockWrite() Release a Write lock
void	updateCache(OperationContext opCtx) updates the cache based on the type of OperationContext
private void	updateCsnIndex(org.apache.directory.api.ldap.model.entry.Entry entry, java.lang.String id) updates the CSN index
protected void	updateRdnIdx(java.lang.String parentId, boolean addRemove, int nbDescendant)

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

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

Methods inherited from class java.lang.Object

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

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

sync

Field Detail

LOG

private static final org.slf4j.Logger LOG

static logger

searchEngine

private SearchEngine searchEngine

the search engine used to search the database

optimizer

private Optimizer optimizer

The optimizer to use during search operation

optimizerEnabled

protected boolean optimizerEnabled

Tells if the Optimizer is enabled

DEFAULT_CACHE_SIZE

public static final int DEFAULT_CACHE_SIZE

The default cache size is set to 10 000 objects

See Also:

Constant Field Values

cacheSize

protected int cacheSize

The Entry cache size for this partition

aliasCache

protected net.sf.ehcache.Cache aliasCache

The alias cache

piarCache

protected net.sf.ehcache.Cache piarCache

The ParentIdAndRdn cache

isSyncOnWrite

protected java.util.concurrent.atomic.AtomicBoolean isSyncOnWrite

true if we sync disks on every write operation

suffixId

private volatile java.lang.String suffixId

The suffix UUID

partitionPath

protected java.net.URI partitionPath

The path in which this Partition stores files

indexedAttributes

private java.util.Set<Index<?,java.lang.String>> indexedAttributes

The set of indexed attributes

master

protected MasterTable master

the master table storing entries by primary key

userIndices

protected java.util.Map<java.lang.String,Index<?,java.lang.String>> userIndices

a map of attributeType numeric UUID to user userIndices

systemIndices

protected java.util.Map<java.lang.String,Index<?,java.lang.String>> systemIndices

a map of attributeType numeric UUID to system userIndices

rdnIdx

protected Index<ParentIdAndRdn,java.lang.String> rdnIdx

the relative distinguished name index

objectClassIdx

protected Index<java.lang.String,java.lang.String> objectClassIdx

a system index on objectClass attribute

presenceIdx

protected Index<java.lang.String,java.lang.String> presenceIdx

the attribute presence index

entryCsnIdx

protected Index<java.lang.String,java.lang.String> entryCsnIdx

a system index on entryCSN attribute

aliasIdx

protected Index<org.apache.directory.api.ldap.model.name.Dn,java.lang.String> aliasIdx

a system index on aliasedObjectName attribute

subAliasIdx

protected Index<java.lang.String,java.lang.String> subAliasIdx

the subtree scope alias index

oneAliasIdx

protected Index<java.lang.String,java.lang.String> oneAliasIdx

the one level scope alias index

adminRoleIdx

protected Index<java.lang.String,java.lang.String> adminRoleIdx

a system index on administrativeRole attribute

objectClassAT

protected org.apache.directory.api.ldap.model.schema.AttributeType objectClassAT

Cached attributes types to avoid lookup all over the code

entryCsnAT

protected org.apache.directory.api.ldap.model.schema.AttributeType entryCsnAT

entryDnAT

protected org.apache.directory.api.ldap.model.schema.AttributeType entryDnAT

entryUuidAT

protected org.apache.directory.api.ldap.model.schema.AttributeType entryUuidAT

aliasedObjectNameAT

protected org.apache.directory.api.ldap.model.schema.AttributeType aliasedObjectNameAT

administrativeRoleAT

protected org.apache.directory.api.ldap.model.schema.AttributeType administrativeRoleAT

contextCsnAT

protected org.apache.directory.api.ldap.model.schema.AttributeType contextCsnAT

NO_REVERSE

private static final boolean NO_REVERSE

WITH_REVERSE

private static final boolean WITH_REVERSE

ADD_CHILD

protected static final boolean ADD_CHILD

See Also:

Constant Field Values

REMOVE_CHILD

protected static final boolean REMOVE_CHILD

See Also:

Constant Field Values

rwLock

private java.util.concurrent.locks.ReadWriteLock rwLock

A lock to protect the backend from concurrent reads/writes

entryDnCache

private net.sf.ehcache.Cache entryDnCache

a cache to hold pairs, this is used for speeding up the buildEntryDn() method

ctxCsnSemaphore

private java.util.concurrent.Semaphore ctxCsnSemaphore

a semaphore to serialize the writes on context entry while updating contextCSN attribute

Constructor Detail

AbstractBTreePartition

protected AbstractBTreePartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Creates a B-tree based context partition.

Parameters:

schemaManager - the schema manager

AbstractBTreePartition

protected AbstractBTreePartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                 DnFactory dnFactory)

Creates a B-tree based context partition.

Parameters:

schemaManager - the schema manager

dnFactory - the DN factory

Method Detail

initInstance

private void initInstance()

Intializes the instance.

getCacheSize

public int getCacheSize()

Gets the entry cache size for this BTreePartition.

Specified by:

getCacheSize in interface Store

Returns:

the maximum size of the cache as the number of entries maximum before paging out

setCacheSize

public void setCacheSize(int cacheSize)

Used to specify the entry cache size for a Partition. Various Partition implementations may interpret this value in different ways: i.e. total cache size limit verses the number of entries to cache.

Specified by:

setCacheSize in interface Store

Parameters:

cacheSize - the maximum size of the cache in the number of entries

isOptimizerEnabled

public boolean isOptimizerEnabled()

Tells if the Optimizer is enabled or not

Returns:

true if the optimizer is enabled

setOptimizerEnabled

public void setOptimizerEnabled(boolean optimizerEnabled)

Set the optimizer flag

Parameters:

optimizerEnabled - The flag

setPartitionPath

public void setPartitionPath(java.net.URI partitionPath)

Sets the path in which this Partition stores data. This may be an URL to a file or directory, or an JDBC URL.

Specified by:

setPartitionPath in interface Store

Parameters:

partitionDir - the path in which this Partition stores data.

isSyncOnWrite

public boolean isSyncOnWrite()

Specified by:

isSyncOnWrite in interface Store

Returns:

true if we write to disk for every modification

setSyncOnWrite

public void setSyncOnWrite(boolean isSyncOnWrite)

Sets the flag telling the server to flush on disk when some modification has been done.

Specified by:

setSyncOnWrite in interface Store

Parameters:

isSyncOnWrite - A boolean set to true if we have to flush on disk when a modification occurs

setupSystemIndices

protected void setupSystemIndices()
                           throws java.lang.Exception

Sets up the system indices.

Throws:

java.lang.Exception

setupUserIndices

protected void setupUserIndices()
                         throws java.lang.Exception

Sets up the user indices.

Throws:

java.lang.Exception

getSearchEngine

public SearchEngine getSearchEngine()

Gets the DefaultSearchEngine used by this ContextPartition to search the Database.

Returns:

the search engine

convertAndInit

protected abstract Index<?,java.lang.String> convertAndInit(Index<?,java.lang.String> index)
                                                     throws java.lang.Exception

Convert and initialize an index for a specific store implementation.

Parameters:

index - the index

Returns:

the converted and initialized index

Throws:

java.lang.Exception

getPartitionPath

public java.net.URI getPartitionPath()

Gets the path in which this Partition stores data.

Specified by:

getPartitionPath in interface Store

Returns:

the path in which this Partition stores data.

doDestroy

protected void doDestroy()
                  throws org.apache.directory.api.ldap.model.exception.LdapException,
                         java.lang.Exception

Override this method to put your initialization code.

Specified by:

doDestroy in class AbstractPartition

Throws:

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

java.lang.Exception

doInit

protected void doInit()
               throws java.lang.Exception

Override this method to put your initialization code.

Specified by:

doInit in class AbstractPartition

Throws:

java.lang.Exception

dumpAllRdnIdx

private void dumpAllRdnIdx()
                    throws java.lang.Exception

Throws:

java.lang.Exception

dumpRdnIdx

private void dumpRdnIdx()
                 throws java.lang.Exception

Throws:

java.lang.Exception

dumpRdnIdx

public void dumpRdnIdx(java.lang.String id,
                       java.lang.String tabs)
                throws java.lang.Exception

Throws:

java.lang.Exception

dumpRdnIdx

private void dumpRdnIdx(java.lang.String id,
                        int nbSibbling,
                        java.lang.String tabs)
                 throws java.lang.Exception

Throws:

java.lang.Exception

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

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

updateRdnIdx

protected void updateRdnIdx(java.lang.String parentId,
                            boolean addRemove,
                            int nbDescendant)
                     throws java.lang.Exception

Throws:

java.lang.Exception

delete

public org.apache.directory.api.ldap.model.entry.Entry delete(java.lang.String id)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Delete the entry associated with a given Id

Specified by:

delete in interface Store

Parameters:

id - The id of the entry to delete

Returns:

the deleted entry if found

Throws:

java.lang.Exception - If the deletion failed

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

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

fetch

public org.apache.directory.api.ldap.model.entry.Entry fetch(java.lang.String id)
                                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Get back an entry knowing its UUID

Specified by:

fetch in interface Store

Parameters:

id - The Entry UUID we want to get back

Returns:

The found Entry, or null if not found

Throws:

java.lang.Exception - If the lookup failed for any reason (except a not found entry)

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

fetch

public org.apache.directory.api.ldap.model.entry.Entry fetch(java.lang.String id,
                                                             org.apache.directory.api.ldap.model.name.Dn dn)
                                                      throws org.apache.directory.api.ldap.model.exception.LdapException

Get back an entry knowing its UUID

Specified by:

fetch in interface Store

Parameters:

id - The Entry UUID we want to get back

dn - The entry DN when we have it

Returns:

The found Entry, or null if not found

Throws:

java.lang.Exception - If the lookup failed for any reason (except a not found entry)

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

modify

public final org.apache.directory.api.ldap.model.entry.Entry modify(org.apache.directory.api.ldap.model.name.Dn dn,
                                                                    org.apache.directory.api.ldap.model.entry.Modification... mods)
                                                             throws java.lang.Exception

Modify an entry applying the given list of modifications.

Specified by:

modify in interface Store

Parameters:

dn - The Entry's Dn

mods - The list of modifications

Returns:

The modified entry

Throws:

java.lang.Exception - If the modification failed

modifyAdd

private void modifyAdd(java.lang.String id,
                       org.apache.directory.api.ldap.model.entry.Entry entry,
                       org.apache.directory.api.ldap.model.entry.Attribute mods)
                throws java.lang.Exception

Adds a set of attribute values while affecting the appropriate userIndices. The entry is not persisted: it is only changed in anticipation for a put into the master table.

Parameters:

id - the primary key of the entry

entry - the entry to alter

mods - the attribute and values to add

Throws:

java.lang.Exception - if index alteration or attribute addition fails

modifyReplace

private void modifyReplace(java.lang.String id,
                           org.apache.directory.api.ldap.model.entry.Entry entry,
                           org.apache.directory.api.ldap.model.entry.Attribute mods)
                    throws java.lang.Exception

Completely replaces the existing set of values for an attribute with the modified values supplied affecting the appropriate userIndices. The entry is not persisted: it is only changed in anticipation for a put into the master table.

Parameters:

id - the primary key of the entry

entry - the entry to alter

mods - the replacement attribute and values

Throws:

java.lang.Exception - if index alteration or attribute modification fails.

modifyRemove

private void modifyRemove(java.lang.String id,
                          org.apache.directory.api.ldap.model.entry.Entry entry,
                          org.apache.directory.api.ldap.model.entry.Attribute mods)
                   throws java.lang.Exception

Completely removes the set of values for an attribute having the values supplied while affecting the appropriate userIndices. The entry is not persisted: it is only changed in anticipation for a put into the master table. Note that an empty attribute w/o values will remove all the values within the entry where as an attribute w/ values will remove those attribute values it contains.

Parameters:

id - the primary key of the entry

entry - the entry to alter

mods - the attribute and its values to delete

Throws:

java.lang.Exception - if index alteration or attribute modification fails.

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

move

public final void move(org.apache.directory.api.ldap.model.name.Dn oldDn,
                       org.apache.directory.api.ldap.model.name.Dn newSuperiorDn,
                       org.apache.directory.api.ldap.model.name.Dn newDn,
                       org.apache.directory.api.ldap.model.entry.Entry modifiedEntry)
                throws java.lang.Exception

Move an entry from one place to the other. The Rdn remains unchanged, the parent Dn changes

We have to update some of the index when moving an entry. Assuming that the target destination does not exist, the following index must be updated :

• oneLevel index
• subLevel index

If the moved entry is an alias, then we also have to update the following index :

• oneAlias index
• subAlias index

The Alias index is not updated, as the entry UUID won't change.

We have a few check we must do before moving the entry :

• The destination must not exist
• The moved entry must exist (this has already been checked)
• The moved entry must not inherit from a referral (already checked)

Specified by:

move in interface Store

Parameters:

oldDn - The previous entry Dn

newSuperiorDn - The new superior Dn

newDn - The new Dn

modifiedEntry - The entry to move

Throws:

java.lang.Exception - If the move failed

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

moveAndRename

public final void moveAndRename(org.apache.directory.api.ldap.model.name.Dn oldDn,
                                org.apache.directory.api.ldap.model.name.Dn newSuperiorDn,
                                org.apache.directory.api.ldap.model.name.Rdn newRdn,
                                org.apache.directory.api.ldap.model.entry.Entry modifiedEntry,
                                boolean deleteOldRdn)
                         throws java.lang.Exception

Specified by:

moveAndRename in interface Store

Throws:

java.lang.Exception

moveAndRename

private void moveAndRename(org.apache.directory.api.ldap.model.name.Dn oldDn,
                           java.lang.String entryId,
                           org.apache.directory.api.ldap.model.name.Dn newSuperior,
                           org.apache.directory.api.ldap.model.name.Rdn newRdn,
                           org.apache.directory.api.ldap.model.entry.Entry modifiedEntry)
                    throws java.lang.Exception

Moves an entry under a new parent. The operation causes a shift in the parent child relationships between the old parent, new parent and the child moved. All other descendant entries under the child never change their direct parent child relationships. Hence after the parent child relationship changes are broken at the old parent and set at the new parent a modifyDn operation is conducted to handle name changes propagating down through the moved child and its descendants.

Parameters:

oldDn - the normalized dn of the child to be moved

childId - the id of the child being moved

newRdn - the normalized dn of the new parent for the child

modifiedEntry - the modified entry

Throws:

java.lang.Exception - if something goes wrong

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

rename

private void rename(java.lang.String oldId,
                    org.apache.directory.api.ldap.model.name.Rdn newRdn,
                    boolean deleteOldRdn,
                    org.apache.directory.api.ldap.model.entry.Entry entry)
             throws java.lang.Exception

This will rename the entry, and deal with the deleteOldRdn flag. If set to true, we have to remove the AVA which are not part of the new RDN from the entry. If this flag is set to false, we have to take care of the special case of an AVA which attributeType is SINGLE-VALUE : in this case, we remove the old value.

Throws:

java.lang.Exception

rename

public final void rename(org.apache.directory.api.ldap.model.name.Dn dn,
                         org.apache.directory.api.ldap.model.name.Rdn newRdn,
                         boolean deleteOldRdn,
                         org.apache.directory.api.ldap.model.entry.Entry entry)
                  throws java.lang.Exception

Changes the relative distinguished name of an entry specified by a distinguished name with the optional removal of the old Rdn attribute value from the entry. Name changes propagate down as dn changes to the descendants of the entry where the Rdn changed. An Rdn change operation does not change parent child relationships. It merely propagates a name change at a point in the DIT where the Rdn is changed. The change propagates down the subtree rooted at the distinguished name specified.

Specified by:

rename in interface Store

Parameters:

dn - the normalized distinguished name of the entry to alter

newRdn - the new Rdn to set

deleteOldRdn - whether or not to remove the old Rdn attr/val

entry - the modified entry

Throws:

java.lang.Exception - if there are any errors propagating the name changes

unbind

public final 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

hasEntry

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

This method calls Partition.lookup(LookupOperationContext) and return true if it returns an entry by default. Please override this method if there is more effective way for your implementation.

Specified by:

hasEntry in interface Partition

Parameters:

entryContext - 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

updateCsnIndex

private void updateCsnIndex(org.apache.directory.api.ldap.model.entry.Entry entry,
                            java.lang.String id)
                     throws java.lang.Exception

updates the CSN index

Parameters:

entry - the entry having entryCSN attribute

id - UUID of the entry

Throws:

java.lang.Exception

buildEntryDn

protected org.apache.directory.api.ldap.model.name.Dn buildEntryDn(java.lang.String id)
                                                            throws java.lang.Exception

builds the Dn of the entry identified by the given id

Parameters:

id - the entry's id

Returns:

the normalized Dn of the entry

Throws:

java.lang.Exception

count

public long count()
           throws java.lang.Exception

Gets the total count of entries within this store.

Specified by:

count in interface Store

Returns:

the total count of entries within this store

Throws:

java.lang.Exception - on failures to access the underlying store

getChildCount

public final long getChildCount(java.lang.String id)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Gets the count of immediate children of the given entry UUID.

Specified by:

getChildCount in interface Store

Parameters:

id - the entry UUID

Returns:

the child count

Throws:

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

getEntryDn

public final org.apache.directory.api.ldap.model.name.Dn getEntryDn(java.lang.String id)
                                                             throws java.lang.Exception

Gets the Entry's Dn identified by the given id.

Specified by:

getEntryDn in interface Store

Parameters:

id - the entry's id

Returns:

the entry's Dn

Throws:

java.lang.Exception

getEntryId

public final java.lang.String getEntryId(org.apache.directory.api.ldap.model.name.Dn dn)
                                  throws org.apache.directory.api.ldap.model.exception.LdapException

Gets the entry's id. Returns null if the Dn doesn't exist in this store. Note that the Dn must be normalized!

Specified by:

getEntryId in interface Store

Parameters:

dn - the normalized entry Dn

Returns:

the entry's id, or null if the Dn doesn't exists

Throws:

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

getParentId

public java.lang.String getParentId(java.lang.String childId)
                             throws java.lang.Exception

Gets the UUID of an entry's parent using the child entry's UUID. Note that the suffix entry returns 0, which does not map to any entry.

Specified by:

getParentId in interface Store

Parameters:

childId - the UUID of the entry

Returns:

the id of the parent entry or zero if the suffix entry UUID is used

Throws:

java.lang.Exception - on failures to access the underlying store

getSuffixId

protected java.lang.String getSuffixId()
                                throws java.lang.Exception

Retrieve the SuffixID

Throws:

java.lang.Exception

addIndex

public void addIndex(Index<?,java.lang.String> index)
              throws java.lang.Exception

Adds a (system or user) index to the list of index for this store. Note that the attribute id returned by Index.getAttributeId() must be the numeric OID.

Specified by:

addIndex in interface Store

Parameters:

index - The index to add

Throws:

java.lang.Exception - If the addition failed

addIndexedAttributes

public void addIndexedAttributes(Index<?,java.lang.String>... indexes)

Add some new indexes

Parameters:

indexes - The added indexes

setIndexedAttributes

public void setIndexedAttributes(java.util.Set<Index<?,java.lang.String>> indexedAttributes)

Set the list of indexes for this partition

Parameters:

indexedAttributes - The list of indexes

getIndexedAttributes

public java.util.Set<Index<?,java.lang.String>> getIndexedAttributes()

Returns:

The list of indexed attributes

getUserIndices

public java.util.Iterator<java.lang.String> getUserIndices()

An iterator build on top of the User's index

Specified by:

getUserIndices in interface Store

getSystemIndices

public java.util.Iterator<java.lang.String> getSystemIndices()

An iterator build on top of the System's index

Specified by:

getSystemIndices in interface Store

getIndex

public Index<?,java.lang.String> getIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                                   throws IndexNotFoundException

Get the user or system index associated with the given attributeType

Specified by:

getIndex in interface Store

Parameters:

attributeType - The index attributeType we are looking for

Returns:

The associated user or system index

Throws:

IndexNotFoundException - If the index does not exist

getUserIndex

public Index<?,java.lang.String> getUserIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                                       throws IndexNotFoundException

Get the user index associated with the given name

Specified by:

getUserIndex in interface Store

Parameters:

attributeType - The index name we are looking for

Returns:

The associated user index

Throws:

IndexNotFoundException - If the index does not exist

getSystemIndex

public Index<?,java.lang.String> getSystemIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                                         throws IndexNotFoundException

Get the system index associated with the given name

Specified by:

getSystemIndex in interface Store

Parameters:

attributeType - The index name we are looking for

Returns:

The associated system index

Throws:

IndexNotFoundException - If the index does not exist

getAliasIndex

public Index<org.apache.directory.api.ldap.model.name.Dn,java.lang.String> getAliasIndex()

Specified by:

getAliasIndex in interface Store

Returns:

The Alias system index

getOneAliasIndex

public Index<java.lang.String,java.lang.String> getOneAliasIndex()

Specified by:

getOneAliasIndex in interface Store

Returns:

The OneAlias system index

getSubAliasIndex

public Index<java.lang.String,java.lang.String> getSubAliasIndex()

Specified by:

getSubAliasIndex in interface Store

Returns:

The SubAlias system index

getObjectClassIndex

public Index<java.lang.String,java.lang.String> getObjectClassIndex()

Specified by:

getObjectClassIndex in interface Store

Returns:

The ObjectClass system index

getEntryCsnIndex

public Index<java.lang.String,java.lang.String> getEntryCsnIndex()

Specified by:

getEntryCsnIndex in interface Store

Returns:

The EntryCSN system index

getAdministrativeRoleIndex

public Index<java.lang.String,java.lang.String> getAdministrativeRoleIndex()

getPresenceIndex

public Index<java.lang.String,java.lang.String> getPresenceIndex()

Specified by:

getPresenceIndex in interface Store

Returns:

The Presence system index

getRdnIndex

public Index<ParentIdAndRdn,java.lang.String> getRdnIndex()

Specified by:

getRdnIndex in interface Store

Returns:

The Rdn system index

hasUserIndexOn

public boolean hasUserIndexOn(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Tells if an index is already present in the User's index list

Specified by:

hasUserIndexOn in interface Store

Parameters:

attributeType - The attributeType index we are looking for

Returns:

true if the index is already present in the User's index list

Throws:

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

hasSystemIndexOn

public boolean hasSystemIndexOn(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                         throws org.apache.directory.api.ldap.model.exception.LdapException

Tells if an index is already present in the System's index list

Specified by:

hasSystemIndexOn in interface Store

Parameters:

attributeType - The index we are looking for

Returns:

true if the index is already present in the System's index list

Throws:

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

hasIndexOn

public boolean hasIndexOn(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Tells if an index is already present in the User's or System's index list

Specified by:

hasIndexOn in interface Store

Returns:

true if the index is already present in the User's or System's index list

Throws:

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

addAliasIndices

protected void addAliasIndices(java.lang.String aliasId,
                               org.apache.directory.api.ldap.model.name.Dn aliasDn,
                               org.apache.directory.api.ldap.model.name.Dn aliasTarget)
                        throws java.lang.Exception

Adds userIndices for an aliasEntry to be added to the database while checking for constrained alias constructs like alias cycles and chaining.

Parameters:

aliasDn - normalized distinguished name for the alias entry

aliasTarget - the user provided aliased entry dn as a string

aliasId - the id of alias entry to add

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if index addition fails, and if the alias is not allowed due to chaining or cycle formation.

java.lang.Exception - if the wrappedCursor btrees cannot be altered

dropAliasIndices

protected void dropAliasIndices(java.lang.String aliasId)
                         throws java.lang.Exception

Removes the index entries for an alias before the entry is deleted from the master table.

Parameters:

aliasId - the id of the alias entry in the master table

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if we cannot parse ldap names

java.lang.Exception - if we cannot delete index values in the database

dropMovedAliasIndices

protected void dropMovedAliasIndices(org.apache.directory.api.ldap.model.name.Dn movedBase)
                              throws java.lang.Exception

For all aliases including and under the moved base, this method removes one and subtree alias index tuples for old ancestors above the moved base that will no longer be ancestors after the move.

Parameters:

movedBase - the base at which the move occurred - the moved node

Throws:

java.lang.Exception - if system userIndices fail

dumpIndex

private void dumpIndex(java.io.OutputStream stream,
                       Index<?,java.lang.String> index)

dumpIndex

public void dumpIndex(java.io.OutputStream stream,
                      java.lang.String name)
               throws java.io.IOException

Dump the requested index to a given stream

Specified by:

dumpIndex in interface Partition

Overrides:

dumpIndex in class AbstractPartition

name - The index to dump to stdout

Throws:

java.io.IOException - if we can't write the data

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createSystemIndex

protected abstract Index createSystemIndex(java.lang.String indexOid,
                                           java.net.URI path,
                                           boolean withReverse)
                                    throws java.lang.Exception

Create a new Index for a given OID

Parameters:

indexOid - The Attribute OID

path - The working directory where this indew will be stored

Returns:

The created index

Throws:

java.lang.Exception - If the index can't be created

getMasterTable

public MasterTable getMasterTable()

Expose the Master table

Specified by:

getMasterTable in interface Store

Returns:

The masterTable instance

lockRead

private void lockRead()

Acquire a Read lock

unlockRead

private void unlockRead()

Release a Read lock

lockWrite

private void lockWrite()

Acquire a Write lock

unlockWrite

private void unlockWrite()

Release a Write lock

updateCache

public void updateCache(OperationContext opCtx)

updates the cache based on the type of OperationContext

Parameters:

opCtx - the operation's context

lookupCache

public org.apache.directory.api.ldap.model.entry.Entry lookupCache(java.lang.String id)

looks up for the entry with the given ID in the cache

Parameters:

id - the ID of the entry

Returns:

the Entry if exists, null otherwise

addToCache

public void addToCache(java.lang.String id,
                       org.apache.directory.api.ldap.model.entry.Entry entry)

adds the given entry to cache Note: this method is not called during add operation to avoid filling the cache with all the added entries

Parameters:

id - ID of the entry

entry - the Entry

getOptimizer

public Optimizer getOptimizer()

Returns:

the optimizer

setOptimizer

public void setOptimizer(Optimizer optimizer)

Parameters:

optimizer - the optimizer to set

setSearchEngine

public void setSearchEngine(SearchEngine searchEngine)

Parameters:

searchEngine - the searchEngine to set

setRWLock

private void setRWLock(OperationContext operationContext)

Set and return the ReadWrite lock we use to protect the backend against concurrent modifications

Parameters:

operationContext - The OperationContext which contain the reference to the OperationManager

getReadWriteLock

public java.util.concurrent.locks.ReadWriteLock getReadWriteLock()

Specified by:

getReadWriteLock in interface Store

Returns:

The ReadWrite lock used to protect the server against concurrent read and writes

getAliasCache

public net.sf.ehcache.Cache getAliasCache()

Specified by:

getAliasCache in interface Store

Returns:

the Alias cache

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

loadContextCsn

protected void loadContextCsn()

Loads the current context CSN present in the context entry of the partition

Throws:

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

saveContextCsn

public void saveContextCsn()
                    throws org.apache.directory.api.ldap.model.exception.LdapException

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

Specified by:

saveContextCsn in interface Partition

Throws:

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