org.apache.directory.server.core.partition.ldif

Class LdifPartition

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.avl.AvlPartition

org.apache.directory.server.core.partition.ldif.AbstractLdifPartition

org.apache.directory.server.core.partition.ldif.LdifPartition

All Implemented Interfaces:

Partition, Store

public class LdifPartition
extends AbstractLdifPartition

A LDIF based partition. Data are stored on disk as LDIF, following this organization :

• each entry is associated with a file, post-fixed with LDIF
• each entry having at least one child will have a directory created using its name.

The root is the partition's suffix.
So for instance, we may have on disk :

 /ou=example,ou=system.ldif
 /ou=example,ou=system/
   |
   +--> cn=test.ldif
        cn=test/
           |
           +--> cn=another test.ldif
                ...
 

In this exemple, the partition's suffix is ou=example,ou=system.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.core.partition.ldif.AbstractLdifPartition

CONF_FILE_EXTN, defaultCSNFactory

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, presenceAT, presenceIdx, rdnIdx, REMOVE_CHILD, subAliasIdx, systemIndices, userIndices

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

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
LdifPartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, DnFactory dnFactory) Creates a new instance of LdifPartition.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext addContext) Adds an entry to this ContextPartition.
org.apache.directory.api.ldap.model.entry.Entry	delete(PartitionTxn partitionTxn, String id) Delete the entry associated with a given Id
protected void	doInit() Override this method to put your initialization code.
void	modify(ModifyOperationContext modifyContext) Modifies an entry by adding, removing or replacing a set of attributes.
void	move(MoveOperationContext moveContext) Transplants a child entry, to a position in the namespace under a new parent entry.
void	moveAndRename(MoveAndRenameOperationContext moveAndRenameContext) Transplants a child entry, to a position in the namespace under a new parent entry and changes the RN of the child entry which can optionally have its old RN attributes removed.
void	rename(RenameOperationContext renameContext) Modifies an entry by changing its relative name.

Methods inherited from class org.apache.directory.server.core.partition.ldif.AbstractLdifPartition

getDefaultId, getPartitionPath, initInstance

Methods inherited from class org.apache.directory.server.core.partition.impl.avl.AvlPartition

beginReadTransaction, beginWriteTransaction, convertAndInit, createSystemIndex, doRepair, getCacheSize, getRootId, isSyncOnWrite

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LdifPartition

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

Creates a new instance of LdifPartition.

Parameters:

schemaManager - The SchemaManager instance

dnFactory - The DN factory

Method Detail

doInit

protected void doInit()
               throws org.apache.directory.api.ldap.model.exception.LdapException

Override this method to put your initialization code.

Overrides:

doInit in class AvlPartition

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the initialization failed

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

Overrides:

add in class AbstractBTreePartition

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(PartitionTxn partitionTxn,
                                                              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

Overrides:

delete in class AbstractBTreePartition

Parameters:

partitionTxn - The transaction to use

id - The id of the entry to delete

Returns:

the deleted entry if found

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the deletion failed

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

Overrides:

modify in class AbstractBTreePartition

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 - if there are any problems

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

Overrides:

move in class AbstractBTreePartition

Parameters:

moveContext - The context containing the DNs to move

Throws:

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

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

Overrides:

moveAndRename in class AbstractBTreePartition

Parameters:

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

Throws:

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

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

Overrides:

rename in class AbstractBTreePartition

Parameters:

renameContext - the modify Dn context

Throws:

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