AbstractBTreePartition (ApacheDS Generalized (X) DBM Partition 2.0.0-M20 API)

java.lang.Object
- org.apache.directory.server.core.api.partition.AbstractPartition
- - org.apache.directory.server.core.partition.impl.btree.AbstractBTreePartition

All Implemented Interfaces:

org.apache.directory.server.core.api.partition.Partition, Store

Direct Known Subclasses:

AvlPartition
```
public abstract class AbstractBTreePartition
extends org.apache.directory.server.core.api.partition.AbstractPartition
implements Store
```
An abstract Partition that uses general BTree operations.

Author:

Apache Directory Project

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`ADD_CHILD`
`protected org.apache.directory.api.ldap.model.schema.AttributeType`	`ADMINISTRATIVE_ROLE_AT`
`protected Index<String,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`	`ALIASED_OBJECT_NAME_AT`
`protected Index<org.apache.directory.api.ldap.model.name.Dn,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`	`CONTEXT_CSN_AT`
`static int`	`DEFAULT_CACHE_SIZE` The default cache size is set to 10 000 objects
`protected org.apache.directory.api.ldap.model.schema.AttributeType`	`ENTRY_CSN_AT`
`protected org.apache.directory.api.ldap.model.schema.AttributeType`	`ENTRY_DN_AT`
`protected org.apache.directory.api.ldap.model.schema.AttributeType`	`ENTRY_UUID_AT`
`protected Index<String,String>`	`entryCsnIdx` a system index on entryCSN attribute
`protected AtomicBoolean`	`isSyncOnWrite` true if we sync disks on every write operation
`protected MasterTable`	`master` the master table storing entries by primary key
`protected org.apache.directory.api.ldap.model.schema.AttributeType`	`OBJECT_CLASS_AT` Cached attributes types to avoid lookup all over the code
`protected Index<String,String>`	`objectClassIdx` a system index on objectClass attribute
`protected Index<String,String>`	`oneAliasIdx` the one level scope alias index
`protected boolean`	`optimizerEnabled` Tells if the Optimizer is enabled
`protected URI`	`partitionPath` The path in which this Partition stores files
`protected net.sf.ehcache.Cache`	`piarCache` The ParentIdAndRdn cache
`protected Index<String,String>`	`presenceIdx` the attribute presence index
`protected Index<ParentIdAndRdn,String>`	`rdnIdx` the relative distinguished name index
`protected static boolean`	`REMOVE_CHILD`
`protected Index<String,String>`	`subAliasIdx` the subtree scope alias index
`protected Map<String,Index<?,String>>`	`systemIndices` a map of attributeType numeric UUID to system userIndices
`protected Map<String,Index<?,String>>`	`userIndices` a map of attributeType numeric UUID to user userIndices

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, org.apache.directory.server.core.api.DnFactory dnFactory)` Creates a B-tree based context partition.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(org.apache.directory.server.core.api.interceptor.context.AddOperationContext addContext)`
`protected void`	`addAliasIndices(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<?,String> index)` Adds a (system or user) index to the list of index for this store.
`void`	`addIndexedAttributes(Index<?,String>... indexes)` Add some new indexes
`void`	`addToCache(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(String id)` builds the Dn of the entry identified by the given id
`protected abstract Index<?,String>`	`convertAndInit(Index<?,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(String indexOid, URI path, boolean withReverse)` Create a new Index for a given OID
`org.apache.directory.api.ldap.model.entry.Entry`	`delete(org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext deleteContext)`
`org.apache.directory.api.ldap.model.entry.Entry`	`delete(String id)` Delete the entry associated with a given Id
`protected void`	`doDestroy()`
`protected void`	`doInit()`
`protected void`	`dropAliasIndices(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.
`void`	`dumpIndex(OutputStream stream, String name)`
`void`	`dumpRdnIdx(String id, String tabs)`
`org.apache.directory.api.ldap.model.entry.Entry`	`fetch(String id)` Get back an entry knowing its UUID
`org.apache.directory.api.ldap.model.entry.Entry`	`fetch(String id, org.apache.directory.api.ldap.model.name.Dn dn)` Get back an entry knowing its UUID
`Index<String,String>`	`getAdministrativeRoleIndex()`
`net.sf.ehcache.Cache`	`getAliasCache()`
`Index<org.apache.directory.api.ldap.model.name.Dn,String>`	`getAliasIndex()`
`int`	`getCacheSize()` Gets the entry cache size for this BTreePartition.
`long`	`getChildCount(String id)` Gets the count of immediate children of the given entry UUID.
`String`	`getContextCsn()`
`Index<String,String>`	`getEntryCsnIndex()`
`org.apache.directory.api.ldap.model.name.Dn`	`getEntryDn(String id)` Gets the Entry's Dn identified by the given id.
`String`	`getEntryId(org.apache.directory.api.ldap.model.name.Dn dn)` Gets the entry's id.
`Index<?,String>`	`getIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)` Get the user or system index associated with the given attributeType
`Set<Index<?,String>>`	`getIndexedAttributes()`
`MasterTable`	`getMasterTable()` Expose the Master table
`Index<String,String>`	`getObjectClassIndex()`
`Index<String,String>`	`getOneAliasIndex()`
`Optimizer`	`getOptimizer()`
`String`	`getParentId(String childId)` Gets the UUID of an entry's parent using the child entry's UUID.
`URI`	`getPartitionPath()` Gets the path in which this Partition stores data.
`Index<String,String>`	`getPresenceIndex()`
`Index<ParentIdAndRdn,String>`	`getRdnIndex()`
`ReadWriteLock`	`getReadWriteLock()`
`SearchEngine`	`getSearchEngine()` Gets the DefaultSearchEngine used by this ContextPartition to search the Database.
`Index<String,String>`	`getSubAliasIndex()`
`protected String`	`getSuffixId()` Retrieve the SuffixID
`Index<?,String>`	`getSystemIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)` Get the system index associated with the given name
`Iterator<String>`	`getSystemIndices()` An iterator build on top of the System's index
`Index<?,String>`	`getUserIndex(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)` Get the user index associated with the given name
`Iterator<String>`	`getUserIndices()` An iterator build on top of the User's index
`boolean`	`hasEntry(org.apache.directory.server.core.api.interceptor.context.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
`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
`org.apache.directory.api.ldap.model.entry.Entry`	`lookup(org.apache.directory.server.core.api.interceptor.context.LookupOperationContext lookupContext)`
`org.apache.directory.api.ldap.model.entry.Entry`	`lookupCache(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(org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext modifyContext)`
`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(org.apache.directory.server.core.api.interceptor.context.MoveOperationContext moveContext)`
`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)`
`void`	`moveAndRename(org.apache.directory.server.core.api.interceptor.context.MoveAndRenameOperationContext moveAndRenameContext)`
`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(org.apache.directory.server.core.api.interceptor.context.RenameOperationContext renameContext)`
`void`	`saveContextCsn()`
`org.apache.directory.server.core.api.filtering.EntryFilteringCursor`	`search(org.apache.directory.server.core.api.interceptor.context.SearchOperationContext searchContext)`
`void`	`setCacheSize(int cacheSize)` Used to specify the entry cache size for a Partition.
`void`	`setIndexedAttributes(Set<Index<?,String>> indexedAttributes)` Set the list of indexes for this partition
`void`	`setOptimizer(Optimizer optimizer)`
`void`	`setOptimizerEnabled(boolean optimizerEnabled)` Set the optimizer flag
`void`	`setPartitionPath(URI partitionPath)` Sets the path in which this Partition stores data.
`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.
`String`	`toString()`
`void`	`unbind(org.apache.directory.server.core.api.interceptor.context.UnbindOperationContext unbindContext)`
`void`	`updateCache(org.apache.directory.server.core.api.interceptor.context.OperationContext opCtx)` updates the cache based on the type of OperationContext
`protected void`	`updateRdnIdx(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
  - 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 AtomicBoolean isSyncOnWrite
```
    true if we sync disks on every write operation
  - partitionPath
```
protected URI partitionPath
```
    The path in which this Partition stores files
  - master
```
protected MasterTable master
```
    the master table storing entries by primary key
  - userIndices
```
protected Map<String,Index<?,String>> userIndices
```
    a map of attributeType numeric UUID to user userIndices
  - systemIndices
```
protected Map<String,Index<?,String>> systemIndices
```
    a map of attributeType numeric UUID to system userIndices
  - rdnIdx
```
protected Index<ParentIdAndRdn,String> rdnIdx
```
    the relative distinguished name index
  - objectClassIdx
```
protected Index<String,String> objectClassIdx
```
    a system index on objectClass attribute
  - presenceIdx
```
protected Index<String,String> presenceIdx
```
    the attribute presence index
  - entryCsnIdx
```
protected Index<String,String> entryCsnIdx
```
    a system index on entryCSN attribute
  - aliasIdx
```
protected Index<org.apache.directory.api.ldap.model.name.Dn,String> aliasIdx
```
    a system index on aliasedObjectName attribute
  - subAliasIdx
```
protected Index<String,String> subAliasIdx
```
    the subtree scope alias index
  - oneAliasIdx
```
protected Index<String,String> oneAliasIdx
```
    the one level scope alias index
  - adminRoleIdx
```
protected Index<String,String> adminRoleIdx
```
    a system index on administrativeRole attribute
  - OBJECT_CLASS_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType OBJECT_CLASS_AT
```
    Cached attributes types to avoid lookup all over the code
  - ENTRY_CSN_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType ENTRY_CSN_AT
```
  - ENTRY_DN_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType ENTRY_DN_AT
```
  - ENTRY_UUID_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType ENTRY_UUID_AT
```
  - ALIASED_OBJECT_NAME_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType ALIASED_OBJECT_NAME_AT
```
  - ADMINISTRATIVE_ROLE_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType ADMINISTRATIVE_ROLE_AT
```
  - CONTEXT_CSN_AT
```
protected org.apache.directory.api.ldap.model.schema.AttributeType CONTEXT_CSN_AT
```
  - 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
- 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,
                      org.apache.directory.server.core.api.DnFactory dnFactory)
```
    Creates a B-tree based context partition.
    
    Parameters:
    schemaManager - the schema manager
    dnFactory - the DN factory
- Method Detail
  - 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(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 Exception
```
    Sets up the system indices.
    
    Throws:
    
    Exception
  - setupUserIndices
```
protected void setupUserIndices()
                         throws Exception
```
    Sets up the user indices.
    
    Throws:
    
    Exception
  - getSearchEngine
```
public SearchEngine getSearchEngine()
```
    Gets the DefaultSearchEngine used by this ContextPartition to search the Database.
    
    Returns:
    the search engine
  - convertAndInit
```
protected abstract Index<?,String> convertAndInit(Index<?,String> index)
                                           throws Exception
```
    Convert and initialize an index for a specific store implementation.
    
    Parameters:
    index - the index
    
    Returns:
    the converted and initialized index
    
    Throws:
    
    Exception
  - getPartitionPath
```
public 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,
                         Exception
```
    Specified by:
    
    doDestroy in class org.apache.directory.server.core.api.partition.AbstractPartition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
    
    Exception
  - doInit
```
protected void doInit()
               throws Exception
```
    Specified by:
    
    doInit in class org.apache.directory.server.core.api.partition.AbstractPartition
    
    Throws:
    
    Exception
  - dumpRdnIdx
```
public void dumpRdnIdx(String id,
              String tabs)
                throws Exception
```
    Throws:
    
    Exception
  - add
```
public void add(org.apache.directory.server.core.api.interceptor.context.AddOperationContext addContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    add in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - delete
```
public org.apache.directory.api.ldap.model.entry.Entry delete(org.apache.directory.server.core.api.interceptor.context.DeleteOperationContext deleteContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    delete in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - updateRdnIdx
```
protected void updateRdnIdx(String parentId,
                boolean addRemove,
                int nbDescendant)
                     throws Exception
```
    Throws:
    
    Exception
  - delete
```
public org.apache.directory.api.ldap.model.entry.Entry delete(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:
    
    Exception - If the deletion failed
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - search
```
public org.apache.directory.server.core.api.filtering.EntryFilteringCursor search(org.apache.directory.server.core.api.interceptor.context.SearchOperationContext searchContext)
                                                                           throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    search in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - lookup
```
public org.apache.directory.api.ldap.model.entry.Entry lookup(org.apache.directory.server.core.api.interceptor.context.LookupOperationContext lookupContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    lookup in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - fetch
```
public org.apache.directory.api.ldap.model.entry.Entry fetch(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:
    
    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(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:
    
    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(org.apache.directory.server.core.api.interceptor.context.ModifyOperationContext modifyContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    modify in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - 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 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:
    
    Exception - If the modification failed
  - move
```
public void move(org.apache.directory.server.core.api.interceptor.context.MoveOperationContext moveContext)
          throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    move in interface org.apache.directory.server.core.api.partition.Partition
    
    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 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:
    
    Exception - If the move failed
  - moveAndRename
```
public void moveAndRename(org.apache.directory.server.core.api.interceptor.context.MoveAndRenameOperationContext moveAndRenameContext)
                   throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    moveAndRename in interface org.apache.directory.server.core.api.partition.Partition
    
    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 Exception
```
    Specified by:
    
    moveAndRename in interface Store
    
    Throws:
    
    Exception
  - rename
```
public void rename(org.apache.directory.server.core.api.interceptor.context.RenameOperationContext renameContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    rename in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - 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 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:
    
    Exception - if there are any errors propagating the name changes
  - unbind
```
public final void unbind(org.apache.directory.server.core.api.interceptor.context.UnbindOperationContext unbindContext)
                  throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Specified by:
    
    unbind in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - hasEntry
```
public boolean hasEntry(org.apache.directory.server.core.api.interceptor.context.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 org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - buildEntryDn
```
protected org.apache.directory.api.ldap.model.name.Dn buildEntryDn(String id)
                                                            throws 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:
    
    Exception
  - count
```
public long count()
           throws 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:
    
    Exception - on failures to access the underlying store
  - getChildCount
```
public final long getChildCount(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(String id)
                                                             throws 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:
    
    Exception
  - getEntryId
```
public final 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 String getParentId(String childId)
                   throws 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:
    
    Exception - on failures to access the underlying store
  - getSuffixId
```
protected String getSuffixId()
                      throws Exception
```
    Retrieve the SuffixID
    
    Throws:
    
    Exception
  - addIndex
```
public void addIndex(Index<?,String> index)
              throws 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:
    
    Exception - If the addition failed
  - addIndexedAttributes
```
public void addIndexedAttributes(Index<?,String>... indexes)
```
    Add some new indexes
    
    Parameters:
    indexes - The added indexes
  - setIndexedAttributes
```
public void setIndexedAttributes(Set<Index<?,String>> indexedAttributes)
```
    Set the list of indexes for this partition
    
    Parameters:
    indexedAttributes - The list of indexes
  - getIndexedAttributes
```
public Set<Index<?,String>> getIndexedAttributes()
```
    Returns:
    The list of indexed attributes
  - getUserIndices
```
public Iterator<String> getUserIndices()
```
    An iterator build on top of the User's index
    
    Specified by:
    
    getUserIndices in interface Store
  - getSystemIndices
```
public Iterator<String> getSystemIndices()
```
    An iterator build on top of the System's index
    
    Specified by:
    
    getSystemIndices in interface Store
  - getIndex
```
public Index<?,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<?,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<?,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,String> getAliasIndex()
```
    Specified by:
    
    getAliasIndex in interface Store
    
    Returns:
    The Alias system index
  - getOneAliasIndex
```
public Index<String,String> getOneAliasIndex()
```
    Specified by:
    
    getOneAliasIndex in interface Store
    
    Returns:
    The OneAlias system index
  - getSubAliasIndex
```
public Index<String,String> getSubAliasIndex()
```
    Specified by:
    
    getSubAliasIndex in interface Store
    
    Returns:
    The SubAlias system index
  - getObjectClassIndex
```
public Index<String,String> getObjectClassIndex()
```
    Specified by:
    
    getObjectClassIndex in interface Store
    
    Returns:
    The ObjectClass system index
  - getEntryCsnIndex
```
public Index<String,String> getEntryCsnIndex()
```
    Specified by:
    
    getEntryCsnIndex in interface Store
    
    Returns:
    The EntryCSN system index
  - getAdministrativeRoleIndex
```
public Index<String,String> getAdministrativeRoleIndex()
```
  - getPresenceIndex
```
public Index<String,String> getPresenceIndex()
```
    Specified by:
    
    getPresenceIndex in interface Store
    
    Returns:
    The Presence system index
  - getRdnIndex
```
public Index<ParentIdAndRdn,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(String aliasId,
                   org.apache.directory.api.ldap.model.name.Dn aliasDn,
                   org.apache.directory.api.ldap.model.name.Dn aliasTarget)
                        throws 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.
    
    Exception - if the wrappedCursor btrees cannot be altered
  - dropAliasIndices
```
protected void dropAliasIndices(String aliasId)
                         throws 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
    
    Exception - if we cannot delete index values in the database
  - dropMovedAliasIndices
```
protected void dropMovedAliasIndices(org.apache.directory.api.ldap.model.name.Dn movedBase)
                              throws 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:
    
    Exception - if system userIndices fail
  - dumpIndex
```
public void dumpIndex(OutputStream stream,
             String name)
               throws IOException
```
    Specified by:
    
    dumpIndex in interface org.apache.directory.server.core.api.partition.Partition
    
    Overrides:
    
    dumpIndex in class org.apache.directory.server.core.api.partition.AbstractPartition
    
    Throws:
    
    IOException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - createSystemIndex
```
protected abstract Index createSystemIndex(String indexOid,
                      URI path,
                      boolean withReverse)
                                    throws 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:
    
    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
  - updateCache
```
public void updateCache(org.apache.directory.server.core.api.interceptor.context.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(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(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
  - getReadWriteLock
```
public 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 String getContextCsn()
```
    Specified by:
    
    getContextCsn in interface org.apache.directory.server.core.api.partition.Partition
    
    Overrides:
    
    getContextCsn in class org.apache.directory.server.core.api.partition.AbstractPartition
  - 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
```
    Specified by:
    
    saveContextCsn in interface org.apache.directory.server.core.api.partition.Partition
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException

Class AbstractBTreePartition

Field Summary

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

Fields inherited from interface org.apache.directory.server.xdbm.Store

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

optimizerEnabled

DEFAULT_CACHE_SIZE

cacheSize

aliasCache

piarCache

isSyncOnWrite

partitionPath

master

userIndices

systemIndices

rdnIdx

objectClassIdx

presenceIdx

entryCsnIdx

aliasIdx

subAliasIdx

oneAliasIdx

adminRoleIdx

OBJECT_CLASS_AT

ENTRY_CSN_AT

ENTRY_DN_AT

ENTRY_UUID_AT

ALIASED_OBJECT_NAME_AT

ADMINISTRATIVE_ROLE_AT

CONTEXT_CSN_AT

ADD_CHILD

REMOVE_CHILD

Constructor Detail

AbstractBTreePartition

AbstractBTreePartition

Method Detail

getCacheSize

setCacheSize

isOptimizerEnabled

setOptimizerEnabled

setPartitionPath

isSyncOnWrite

setSyncOnWrite

setupSystemIndices

setupUserIndices

getSearchEngine

convertAndInit

getPartitionPath

doDestroy

doInit

dumpRdnIdx

add

delete

updateRdnIdx

delete

search

lookup

fetch

fetch

modify

modify

move

move

moveAndRename

moveAndRename

rename

rename

unbind

hasEntry

buildEntryDn

count

getChildCount

getEntryDn

getEntryId