org.apache.directory.server.core.partition.avl

Class AvlStore<E>

java.lang.Object

org.apache.directory.server.core.partition.avl.AvlStore<E>

All Implemented Interfaces:

Store<E,Long>

public class AvlStore<E>
extends Object
implements Store<E,Long>

A Store implementation backed by in memory AVL trees. TODO - this class is extremely like the JdbmStore implementation of the Store interface which tells us that it's best for us to have some kind of abstract class.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
AvlStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.directory.shared.ldap.entry.ServerEntry entry) Add an entry into the store.
void	addIndex(Index<? extends Object,E,Long> index) Adds a user index to the list of index for this store
int	count()
void	delete(Long id) Delete the entry associated with a given Id
void	destroy() Close the parttion : we have to close all the userIndices and the master table.
Index<String,E,Long>	getAliasIndex()
int	getCacheSize() always returns 0 (zero), cause this is a inmemory store
int	getChildCount(Long id)
Long	getDefaultId() Gets the default ID.
Index<String,E,Long>	getEntryCsnIndex()
String	getEntryDn(Long id)
Long	getEntryId(String dn)
String	getEntryUpdn(Long id)
String	getEntryUpdn(String dn)
Index<String,E,Long>	getEntryUuidIndex()
Index<?,E,Long>	getIndex(String id) Get the user or system index associated with the given name
String	getName()
Index<String,E,Long>	getNdnIndex()
Index<String,E,Long>	getObjectClassIndex()
Index<Long,E,Long>	getOneAliasIndex()
Index<Long,E,Long>	getOneLevelIndex()
Long	getParentId(Long childId)
Long	getParentId(String dn) Gets the Long id of an entry's parent using the child entry's normalized dn.
Index<String,E,Long>	getPresenceIndex()
String	getProperty(String propertyName)
Index<Long,E,Long>	getSubAliasIndex()
Index<Long,E,Long>	getSubLevelIndex()
org.apache.directory.shared.ldap.name.DN	getSuffix()
String	getSuffixDn()
Index<?,E,Long>	getSystemIndex(String id) Get the system index associated with the given name
Index<String,E,Long>	getUpdnIndex()
org.apache.directory.shared.ldap.name.DN	getUpSuffix()
Index<? extends Object,E,Long>	getUserIndex(String id) Get the user index associated with the given name
Set<Index<? extends Object,E,Long>>	getUserIndices()
File	getWorkingDirectory()
boolean	hasIndexOn(String id) Tells if an index is already present in the User's or System's index list
boolean	hasSystemIndexOn(String id) Tells if an index is already present in the System's index list
boolean	hasUserIndexOn(String id) Tells if an index is already present in the User's index list
void	init(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager) Initialize the JDBM storage system.
boolean	isInitialized() Gets whether the store is initialized.
boolean	isSyncOnWrite()
IndexCursor<Long,E,Long>	list(Long id) Gets an IndexEntry Cursor over the child nodes of an entry.
org.apache.directory.shared.ldap.entry.ServerEntry	lookup(Long id)
void	modify(org.apache.directory.shared.ldap.name.DN dn, List<org.apache.directory.shared.ldap.entry.Modification> mods)
void	modify(org.apache.directory.shared.ldap.name.DN dn, org.apache.directory.shared.ldap.entry.ModificationOperation modOp, org.apache.directory.shared.ldap.entry.ServerEntry mods)
void	modify(long entryId, List<org.apache.directory.shared.ldap.entry.Modification> mods)
void	move(org.apache.directory.shared.ldap.name.DN oldChildDn, org.apache.directory.shared.ldap.name.DN newParentDn)
void	move(org.apache.directory.shared.ldap.name.DN oldChildDn, org.apache.directory.shared.ldap.name.DN newParentDn, org.apache.directory.shared.ldap.name.RDN newRdn, boolean deleteOldRdn)
void	rename(org.apache.directory.shared.ldap.name.DN dn, org.apache.directory.shared.ldap.name.RDN newRdn, boolean deleteOldRdn) 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	setAliasIndex(Index<String,E,Long> index) Set the Alias index
void	setCacheSize(int size) Sets the cache size for this store
void	setEntryCsnIndex(Index<String,E,Long> index) Set the EntryCSN index
void	setEntryUuidIndex(Index<String,E,Long> index) Set the EntryUUID index
void	setName(String name) Sets the store's name
void	setNdnIndex(Index<String,E,Long> index) Set the NDN index
void	setObjectClassIndex(Index<String,E,Long> index) Set the ObjectClass index
void	setOneAliasIndex(Index<Long,E,Long> index) Set the OneAlias index
void	setOneLevelIndex(Index<Long,E,Long> index) Set the OneLevel index
void	setPresenceIndex(Index<String,E,Long> index) Set the Presence index
void	setProperty(String propertyName, String propertyValue)
void	setSubAliasIndex(Index<Long,E,Long> index) Set the SubAlias index
void	setSubLevelIndex(Index<Long,E,Long> index) Set the SubLevel index
void	setSuffixDn(String suffixDn)
void	setSyncOnWrite(boolean sync) Sets the flag telling the server to flush on disk when some modification has been done.
void	setUpdnIndex(Index<String,E,Long> index) Set the UpDn index
void	setUserIndices(Set<Index<? extends Object,E,Long>> userIndices) Stores the list of user index
void	setWorkingDirectory(File wkDir) Sets the working directory for the store
void	sync() This method is called when the synch thread is waking up, to write the modified data.
Iterator<String>	systemIndices() An iterator build on top of the System's index
Iterator<String>	userIndices() An iterator build on top of the User's index

Methods inherited from class java.lang.Object

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

Constructor Detail

AvlStore

public AvlStore()

Method Detail

add

public void add(org.apache.directory.shared.ldap.entry.ServerEntry entry)
         throws Exception

Add an entry into the store.

Specified by:

add in interface Store<E,Long>

Parameters:

entry - The entry to add

Throws:

Exception - If the addition failed.

addIndex

public void addIndex(Index<? extends Object,E,Long> index)
              throws Exception

Adds a user index to the list of index for this store

Specified by:

addIndex in interface Store<E,Long>

Parameters:

index - The index to add

Throws:

Exception - If the addition failed

count

public int count()
          throws Exception

Specified by:

count in interface Store<E,Long>

Throws:

Exception

delete

public void delete(Long id)
            throws Exception

Delete the entry associated with a given Id

Specified by:

delete in interface Store<E,Long>

Parameters:

id - The id of the entry to delete

Throws:

Exception - If the deletion failed

destroy

public void destroy()
             throws Exception

Close the parttion : we have to close all the userIndices and the master table.

Specified by:

destroy in interface Store<E,Long>

Throws:

Exception - lazily thrown on any closer failures to avoid leaving open files

getAliasIndex

public Index<String,E,Long> getAliasIndex()

Specified by:

getAliasIndex in interface Store<E,Long>

Returns:

The Alias system index

getChildCount

public int getChildCount(Long id)
                  throws Exception

Specified by:

getChildCount in interface Store<E,Long>

Throws:

Exception

getEntryDn

public String getEntryDn(Long id)
                  throws Exception

Specified by:

getEntryDn in interface Store<E,Long>

Throws:

Exception

getEntryId

public Long getEntryId(String dn)
                throws Exception

Specified by:

getEntryId in interface Store<E,Long>

Throws:

Exception

getEntryUpdn

public String getEntryUpdn(Long id)
                    throws Exception

Specified by:

getEntryUpdn in interface Store<E,Long>

Throws:

Exception

getEntryUpdn

public String getEntryUpdn(String dn)
                    throws Exception

Specified by:

getEntryUpdn in interface Store<E,Long>

Throws:

Exception

getName

public String getName()

Specified by:

getName in interface Store<E,Long>

Returns:

The store's name

getNdnIndex

public Index<String,E,Long> getNdnIndex()

Specified by:

getNdnIndex in interface Store<E,Long>

Returns:

The Ndn system index

getOneAliasIndex

public Index<Long,E,Long> getOneAliasIndex()

Specified by:

getOneAliasIndex in interface Store<E,Long>

Returns:

The OneAlias system index

getOneLevelIndex

public Index<Long,E,Long> getOneLevelIndex()

Specified by:

getOneLevelIndex in interface Store<E,Long>

Returns:

The OneLevel system index

getParentId

public Long getParentId(String dn)
                 throws Exception

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

Specified by:

getParentId in interface Store<E,Long>

Parameters:

dn - the normalized distinguished name of the child

Returns:

the id of the parent entry or zero if the suffix entry the normalized suffix dn string is used

Throws:

Exception - on failures to access the underlying store

getParentId

public Long getParentId(Long childId)
                 throws Exception

Specified by:

getParentId in interface Store<E,Long>

Throws:

Exception

getPresenceIndex

public Index<String,E,Long> getPresenceIndex()

Specified by:

getPresenceIndex in interface Store<E,Long>

Returns:

The Presence system index

getProperty

public String getProperty(String propertyName)
                   throws Exception

Specified by:

getProperty in interface Store<E,Long>

Throws:

Exception

getSubAliasIndex

public Index<Long,E,Long> getSubAliasIndex()

Specified by:

getSubAliasIndex in interface Store<E,Long>

Returns:

The SubAlias system index

getSubLevelIndex

public Index<Long,E,Long> getSubLevelIndex()

Specified by:

getSubLevelIndex in interface Store<E,Long>

Returns:

The SubLevel system index

getSuffix

public org.apache.directory.shared.ldap.name.DN getSuffix()

Specified by:

getSuffix in interface Store<E,Long>

getUpSuffix

public org.apache.directory.shared.ldap.name.DN getUpSuffix()

Specified by:

getUpSuffix in interface Store<E,Long>

getSuffixDn

public String getSuffixDn()

Specified by:

getSuffixDn in interface Store<E,Long>

getSystemIndex

public Index<?,E,Long> getSystemIndex(String id)
                               throws IndexNotFoundException

Get the system index associated with the given name

Specified by:

getSystemIndex in interface Store<E,Long>

Parameters:

id - The index name we are looking for

Returns:

The associated system index

Throws:

IndexNotFoundException - If the index does not exist

getIndex

public Index<?,E,Long> getIndex(String id)
                         throws IndexNotFoundException

Get the user or system index associated with the given name

Specified by:

getIndex in interface Store<E,Long>

Parameters:

id - The index name we are looking for

Returns:

The associated user or system index

Throws:

IndexNotFoundException - If the index does not exist

getUpdnIndex

public Index<String,E,Long> getUpdnIndex()

Specified by:

getUpdnIndex in interface Store<E,Long>

Returns:

The UpDN system index

getUserIndex

public Index<? extends Object,E,Long> getUserIndex(String id)
                                            throws IndexNotFoundException

Get the user index associated with the given name

Specified by:

getUserIndex in interface Store<E,Long>

Parameters:

id - The index name we are looking for

Returns:

The associated user index

Throws:

IndexNotFoundException - If the index does not exist

getUserIndices

public Set<Index<? extends Object,E,Long>> getUserIndices()

Specified by:

getUserIndices in interface Store<E,Long>

Returns:

The list of user index

hasIndexOn

public boolean hasIndexOn(String id)
                   throws Exception

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

Specified by:

hasIndexOn in interface Store<E,Long>

Parameters:

id - The index we are looking for

Returns:

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

Throws:

Exception - If something went wrong

hasSystemIndexOn

public boolean hasSystemIndexOn(String id)
                         throws Exception

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

Specified by:

hasSystemIndexOn in interface Store<E,Long>

Parameters:

id - The index we are looking for

Returns:

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

Throws:

Exception - If something went wrong

hasUserIndexOn

public boolean hasUserIndexOn(String id)
                       throws Exception

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

Specified by:

hasUserIndexOn in interface Store<E,Long>

Parameters:

id - The index we are looking for

Returns:

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

Throws:

Exception - If something went wrong

init

public void init(org.apache.directory.shared.ldap.schema.SchemaManager schemaManager)
          throws Exception

Initialize the JDBM storage system. TODO why this and initRegistries on Store interface ???

Specified by:

init in interface Store<E,Long>

Parameters:

schemaManager - the schema schemaManager

Throws:

Exception - on failure to lookup elements in schemaManager

isInitialized

public boolean isInitialized()

Gets whether the store is initialized.

Specified by:

isInitialized in interface Store<E,Long>

Returns:

true if the partition store is initialized

list

public IndexCursor<Long,E,Long> list(Long id)
                              throws Exception

Gets an IndexEntry Cursor over the child nodes of an entry.

Specified by:

list in interface Store<E,Long>

Parameters:

id - the id of the parent entry

Returns:

an IndexEntry Cursor over the child entries

Throws:

Exception - on failures to access the underlying store

lookup

public org.apache.directory.shared.ldap.entry.ServerEntry lookup(Long id)
                                                          throws Exception

Specified by:

lookup in interface Store<E,Long>

Throws:

Exception

modify

public void modify(org.apache.directory.shared.ldap.name.DN dn,
          org.apache.directory.shared.ldap.entry.ModificationOperation modOp,
          org.apache.directory.shared.ldap.entry.ServerEntry mods)
            throws Exception

Specified by:

modify in interface Store<E,Long>

Throws:

Exception

modify

public void modify(org.apache.directory.shared.ldap.name.DN dn,
          List<org.apache.directory.shared.ldap.entry.Modification> mods)
            throws Exception

Specified by:

modify in interface Store<E,Long>

Throws:

Exception

modify

public void modify(long entryId,
          List<org.apache.directory.shared.ldap.entry.Modification> mods)
            throws Exception

Throws:

Exception

move

public void move(org.apache.directory.shared.ldap.name.DN oldChildDn,
        org.apache.directory.shared.ldap.name.DN newParentDn,
        org.apache.directory.shared.ldap.name.RDN newRdn,
        boolean deleteOldRdn)
          throws Exception

Specified by:

move in interface Store<E,Long>

Throws:

Exception

move

public void move(org.apache.directory.shared.ldap.name.DN oldChildDn,
        org.apache.directory.shared.ldap.name.DN newParentDn)
          throws Exception

Specified by:

move in interface Store<E,Long>

Throws:

Exception

rename

public void rename(org.apache.directory.shared.ldap.name.DN dn,
          org.apache.directory.shared.ldap.name.RDN newRdn,
          boolean deleteOldRdn)
            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<E,Long>

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

Throws:

Exception - if there are any errors propagating the name changes

setAliasIndex

public void setAliasIndex(Index<String,E,Long> index)
                   throws Exception

Set the Alias index

Specified by:

setAliasIndex in interface Store<E,Long>

Parameters:

index - The Alias index

Throws:

Exception - If the addition failed

setName

public void setName(String name)

Sets the store's name

Specified by:

setName in interface Store<E,Long>

Parameters:

name - The store's name

setNdnIndex

public void setNdnIndex(Index<String,E,Long> index)
                 throws Exception

Set the NDN index

Specified by:

setNdnIndex in interface Store<E,Long>

Parameters:

index - The NDN index

Throws:

Exception - If the addition failed

setOneAliasIndex

public void setOneAliasIndex(Index<Long,E,Long> index)
                      throws Exception

Set the OneAlias index

Specified by:

setOneAliasIndex in interface Store<E,Long>

Parameters:

index - The OneAlias index

Throws:

Exception - If the addition failed

setOneLevelIndex

public void setOneLevelIndex(Index<Long,E,Long> index)
                      throws Exception

Set the OneLevel index

Specified by:

setOneLevelIndex in interface Store<E,Long>

Parameters:

index - The OneLevel index

Throws:

Exception - If the addition failed

setPresenceIndex

public void setPresenceIndex(Index<String,E,Long> index)
                      throws Exception

Set the Presence index

Specified by:

setPresenceIndex in interface Store<E,Long>

Parameters:

index - The Presence index

Throws:

Exception - If the addition failed

setProperty

public void setProperty(String propertyName,
               String propertyValue)
                 throws Exception

Specified by:

setProperty in interface Store<E,Long>

Throws:

Exception

setSubAliasIndex

public void setSubAliasIndex(Index<Long,E,Long> index)
                      throws Exception

Set the SubAlias index

Specified by:

setSubAliasIndex in interface Store<E,Long>

Parameters:

index - The SubAlias index

Throws:

Exception - If the addition failed

setSubLevelIndex

public void setSubLevelIndex(Index<Long,E,Long> index)
                      throws Exception

Set the SubLevel index

Specified by:

setSubLevelIndex in interface Store<E,Long>

Parameters:

index - The SubLevel index

Throws:

Exception - If the addition failed

setSuffixDn

public void setSuffixDn(String suffixDn)

Specified by:

setSuffixDn in interface Store<E,Long>

setUpdnIndex

public void setUpdnIndex(Index<String,E,Long> index)
                  throws Exception

Set the UpDn index

Specified by:

setUpdnIndex in interface Store<E,Long>

Parameters:

index - The UpDn index

Throws:

Exception - If the addition failed

setUserIndices

public void setUserIndices(Set<Index<? extends Object,E,Long>> userIndices)

Stores the list of user index

Specified by:

setUserIndices in interface Store<E,Long>

Parameters:

userIndices - The list of user index

systemIndices

public Iterator<String> systemIndices()

An iterator build on top of the System's index

Specified by:

systemIndices in interface Store<E,Long>

userIndices

public Iterator<String> userIndices()

An iterator build on top of the User's index

Specified by:

userIndices in interface Store<E,Long>

getCacheSize

public int getCacheSize()

always returns 0 (zero), cause this is a inmemory store

Specified by:

getCacheSize in interface Store<E,Long>

Returns:

The cache size

getEntryCsnIndex

public Index<String,E,Long> getEntryCsnIndex()

Specified by:

getEntryCsnIndex in interface Store<E,Long>

Returns:

The EntryCSN system index

getEntryUuidIndex

public Index<String,E,Long> getEntryUuidIndex()

Specified by:

getEntryUuidIndex in interface Store<E,Long>

Returns:

The EntryUUID system index

getObjectClassIndex

public Index<String,E,Long> getObjectClassIndex()

Specified by:

getObjectClassIndex in interface Store<E,Long>

Returns:

The ObjectClass system index

setEntryCsnIndex

public void setEntryCsnIndex(Index<String,E,Long> index)
                      throws Exception

Description copied from interface: Store

Set the EntryCSN index

Specified by:

setEntryCsnIndex in interface Store<E,Long>

Parameters:

index - The EntryCSN index

Throws:

Exception - If the addition failed

setSyncOnWrite

public void setSyncOnWrite(boolean sync)

Description copied from interface: Store

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

Specified by:

setSyncOnWrite in interface Store<E,Long>

Parameters:

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

setWorkingDirectory

public void setWorkingDirectory(File wkDir)

Description copied from interface: Store

Sets the working directory for the store

Specified by:

setWorkingDirectory in interface Store<E,Long>

getWorkingDirectory

public File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface Store<E,Long>

Returns:

The current working directory for the store

isSyncOnWrite

public boolean isSyncOnWrite()

Specified by:

isSyncOnWrite in interface Store<E,Long>

Returns:

true if we write to disk for every modification

setCacheSize

public void setCacheSize(int size)

Description copied from interface: Store

Sets the cache size for this store

Specified by:

setCacheSize in interface Store<E,Long>

Parameters:

size - The cache size

setObjectClassIndex

public void setObjectClassIndex(Index<String,E,Long> index)

Description copied from interface: Store

Set the ObjectClass index

Specified by:

setObjectClassIndex in interface Store<E,Long>

Parameters:

index - The ObjectClass index

setEntryUuidIndex

public void setEntryUuidIndex(Index<String,E,Long> index)

Description copied from interface: Store

Set the EntryUUID index

Specified by:

setEntryUuidIndex in interface Store<E,Long>

Parameters:

index - The EntryUUID index

sync

public void sync()
          throws Exception

Description copied from interface: Store

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

Specified by:

sync in interface Store<E,Long>

Throws:

Exception - on failures to sync database files to disk

getDefaultId

public Long getDefaultId()

Description copied from interface: Store

Gets the default ID.

Specified by:

getDefaultId in interface Store<E,Long>

Returns:

the default ID.