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

Class JdbmPartition

java.lang.Object

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

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

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

All Implemented Interfaces:

Partition, Store

public class JdbmPartition
extends AbstractBTreePartition

A Partition that stores entries in JDBM database.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.io.FilenameFilter	DB_FILTER
private net.sf.ehcache.Cache	entryCache the entry cache
private static java.lang.String	JDBM_DB_FILE_EXTN
private static org.slf4j.Logger	LOG static logger
private jdbm.RecordManager	recMan the JDBM record manager used by this database

Fields inherited from class org.apache.directory.server.core.partition.impl.btree.AbstractBTreePartition

ADD_CHILD, administrativeRoleAT, adminRoleIdx, aliasCache, aliasedObjectNameAT, aliasIdx, cacheSize, contextCsnAT, DEFAULT_CACHE_SIZE, entryCsnAT, entryCsnIdx, entryDnAT, entryUuidAT, isSyncOnWrite, master, objectClassAT, objectClassIdx, oneAliasIdx, optimizerEnabled, partitionPath, piarCache, presenceIdx, rdnIdx, REMOVE_CHILD, subAliasIdx, systemIndices, 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

Constructor and Description
JdbmPartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, DnFactory dnFactory) Creates a store based on JDBM B+Trees.

Method Summary

Modifier and Type	Method and Description
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
private void	buildUserIndex(java.util.List<Index<?,java.lang.String>> indices) Builds user defined indexes on a attributes by browsing all the entries present in master db Note: if the given list of indices contains any system index that will be skipped.
protected Index<?,java.lang.String>	convertAndInit(Index<?,java.lang.String> index) Convert and initialize an index for a specific store implementation.
protected Index	createSystemIndex(java.lang.String oid, java.net.URI path, boolean withReverse) Create a new Index for a given OID
private void	deleteUnusedIndexFiles(java.util.List<java.lang.String> allIndices, java.io.File[] dbFiles) removes any unused/removed attribute index files present under the partition's working directory
protected void	doDestroy() Override this method to put your initialization code.
protected void	doInit() Override this method to put your initialization code.
java.lang.String	getDefaultId() }
java.lang.String	getRootId()
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
void	sync() This method is called when the synch thread is waking up, to write the modified data.
void	updateCache(OperationContext opCtx) updates the cache based on the type of OperationContext

Methods inherited from class org.apache.directory.server.core.partition.impl.btree.AbstractBTreePartition

add, addAliasIndices, addIndex, addIndexedAttributes, buildEntryDn, count, delete, delete, dropAliasIndices, dropMovedAliasIndices, dumpIndex, dumpRdnIdx, fetch, fetch, getAdministrativeRoleIndex, getAliasCache, getAliasIndex, getCacheSize, getChildCount, getContextCsn, getEntryCsnIndex, getEntryDn, getEntryId, getIndex, getIndexedAttributes, getMasterTable, getObjectClassIndex, getOneAliasIndex, getOptimizer, getParentId, getPartitionPath, getPresenceIndex, getRdnIndex, getReadWriteLock, getSearchEngine, getSubAliasIndex, getSuffixId, getSystemIndex, getSystemIndices, getUserIndex, getUserIndices, hasEntry, hasIndexOn, hasSystemIndexOn, hasUserIndexOn, isOptimizerEnabled, isSyncOnWrite, loadContextCsn, lookup, modify, modify, move, move, moveAndRename, moveAndRename, rename, rename, saveContextCsn, search, setCacheSize, setIndexedAttributes, setOptimizer, setOptimizerEnabled, setPartitionPath, setSearchEngine, setSyncOnWrite, setupSystemIndices, setupUserIndices, toString, unbind, updateRdnIdx

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

static logger

JDBM_DB_FILE_EXTN

private static final java.lang.String JDBM_DB_FILE_EXTN

See Also:

Constant Field Values

DB_FILTER

private static final java.io.FilenameFilter DB_FILTER

recMan

private jdbm.RecordManager recMan

the JDBM record manager used by this database

entryCache

private net.sf.ehcache.Cache entryCache

the entry cache

Constructor Detail

JdbmPartition

public JdbmPartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                     DnFactory dnFactory)

Creates a store based on JDBM B+Trees.

Method Detail

doInit

protected void doInit()
               throws java.lang.Exception

Description copied from class: AbstractBTreePartition

Override this method to put your initialization code.

Overrides:

doInit in class AbstractBTreePartition

Throws:

java.lang.Exception

getDefaultId

public java.lang.String getDefaultId()

}

getRootId

public java.lang.String getRootId()

sync

public void sync()
          throws java.lang.Exception

This method is called when the synch thread is waking up, to write the modified data.

Throws:

java.lang.Exception - on failures to sync database files to disk

buildUserIndex

private void buildUserIndex(java.util.List<Index<?,java.lang.String>> indices)
                     throws java.lang.Exception

Builds user defined indexes on a attributes by browsing all the entries present in master db Note: if the given list of indices contains any system index that will be skipped. WARN: MUST be called after calling super.doInit()

Parameters:

indices - then selected indexes that need to be built

Throws:

java.lang.Exception - in case of any problems while building the index

deleteUnusedIndexFiles

private void deleteUnusedIndexFiles(java.util.List<java.lang.String> allIndices,
                                    java.io.File[] dbFiles)

removes any unused/removed attribute index files present under the partition's working directory

convertAndInit

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

Convert and initialize an index for a specific store implementation.

Specified by:

convertAndInit in class AbstractBTreePartition

Parameters:

index - the index

Returns:

the converted and initialized index

Throws:

java.lang.Exception

doDestroy

protected void doDestroy()
                  throws java.lang.Exception

Override this method to put your initialization code.

Overrides:

doDestroy in class AbstractBTreePartition

Throws:

java.lang.Exception

createSystemIndex

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

Create a new Index for a given OID

Specified by:

createSystemIndex in class AbstractBTreePartition

Parameters:

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

updateCache

public void updateCache(OperationContext opCtx)

Description copied from class: AbstractBTreePartition

updates the cache based on the type of OperationContext

Overrides:

updateCache in class AbstractBTreePartition

Parameters:

opCtx - the operation's context

lookupCache

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

Description copied from class: AbstractBTreePartition

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

Overrides:

lookupCache in class AbstractBTreePartition

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)

Description copied from class: AbstractBTreePartition

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

Overrides:

addToCache in class AbstractBTreePartition

Parameters:

id - ID of the entry

entry - the Entry