LdifPartition

Field Summary

Fields
Modifier and Type	Field and Description
`private static boolean`	`CREATE` Flags used for the getFile() method
`private static boolean`	`DELETE`
`private java.io.FileFilter`	`dirFilter` A filter used to pick all the directories
`private java.io.FileFilter`	`entryFilter` A filter used to pick all the ldif entries
`private static org.slf4j.Logger`	`LOG` A logger for this class
`private java.io.File`	`suffixDirectory` The directory into which the entries are stored

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(AddOperationContext addContext)` Adds an entry to this ContextPartition.
`private void`	`addEntry(org.apache.directory.api.ldap.model.entry.Entry entry)` Write the new entry on disk.
`org.apache.directory.api.ldap.model.entry.Entry`	`delete(java.lang.String id)` Delete the entry associated with a given Id
`private boolean`	`deleteFile(java.io.File file)` Recursively delete an entry and all of its children.
`protected void`	`doInit()` Override this method to put your initialization code.
`private void`	`entryMoved(org.apache.directory.api.ldap.model.name.Dn oldEntryDn, org.apache.directory.api.ldap.model.entry.Entry modifiedEntry, java.lang.String entryIdOld)` rewrites the moved entry and its associated children Note that instead of moving and updating the existing files on disk this method gets the moved entry and its children and writes the LDIF files
`private java.io.File`	`getFile(org.apache.directory.api.ldap.model.name.Dn entryDn, boolean create)` Create the file name from the entry Dn.
`private java.lang.String`	`getFileName(org.apache.directory.api.ldap.model.name.Dn dn)` Compute the real name based on the Dn, assuming that depending on the underlying OS, some characters are not allowed.
`private java.lang.String`	`getFileName(org.apache.directory.api.ldap.model.name.Rdn rdn)` Compute the real name based on the Rdn, assuming that depending on the underlying OS, some characters are not allowed.
`private java.lang.String`	`getOSFileName(java.lang.String fileName)` Get a OS compatible file name.
`private void`	`loadEntries(java.io.File entryDir)` loads the configuration into the DIT from the file system Note that it assumes the presence of a directory with the partition suffix's upname under the partition's base dir for ex.
`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
convertAndInit, createSystemIndex, getCacheSize, getRootId, isSyncOnWrite, sync

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, getSuffixId, getSystemIndex, getSystemIndices, getUserIndex, getUserIndices, hasEntry, hasIndexOn, hasSystemIndexOn, hasUserIndexOn, isOptimizerEnabled, loadContextCsn, lookup, lookupCache, modify, move, moveAndRename, rename, 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, 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
```
    A logger for this class
  - suffixDirectory
```
private java.io.File suffixDirectory
```
    The directory into which the entries are stored
  - CREATE
```
private static final boolean CREATE
```
    Flags used for the getFile() method
  - DELETE
```
private static final boolean DELETE
```
  - dirFilter
```
private java.io.FileFilter dirFilter
```
    A filter used to pick all the directories
  - entryFilter
```
private java.io.FileFilter entryFilter
```
    A filter used to pick all the ldif entries
- Constructor Detail
  - LdifPartition
```
public LdifPartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                     DnFactory dnFactory)
```
    Creates a new instance of LdifPartition.
- Method Detail
  - doInit
```
protected void doInit()
               throws java.lang.Exception
```
    Override this method to put your initialization code.
    
    Overrides:
    
    doInit in class AvlPartition
    
    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
    
    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(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
    
    Overrides:
    
    delete in class AbstractBTreePartition
    
    Parameters:
    
    id - The id of the entry to delete
    
    Returns:
    
    the deleted entry if found
    
    Throws:
    
    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
    
    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
    
    See Also:
    
    DirContext, DirContext.ADD_ATTRIBUTE, DirContext.REMOVE_ATTRIBUTE, DirContext.REPLACE_ATTRIBUTE
  - 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
  - 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
  - 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
  - entryMoved
```
private void entryMoved(org.apache.directory.api.ldap.model.name.Dn oldEntryDn,
                        org.apache.directory.api.ldap.model.entry.Entry modifiedEntry,
                        java.lang.String entryIdOld)
                 throws java.lang.Exception
```
    rewrites the moved entry and its associated children Note that instead of moving and updating the existing files on disk this method gets the moved entry and its children and writes the LDIF files
    
    Parameters:
    
    oldEntryDn - the moved entry's old Dn
    
    entryId - the moved entry's master table ID
    
    deleteOldEntry - a flag to tell whether to delete the old entry files
    
    Throws:
    
    java.lang.Exception
  - loadEntries
```
private void loadEntries(java.io.File entryDir)
                  throws java.lang.Exception
```
    loads the configuration into the DIT from the file system Note that it assumes the presence of a directory with the partition suffix's upname under the partition's base dir for ex. if 'config' is the partition's id and 'ou=config' is its suffix it looks for the dir with the path /config/ou=config e.x example.com/config/ou=config NOTE: this dir setup is just to ease the testing of this partition, this needs to be replaced with some kind of bootstrapping the default config from a jar file and write to the FS in LDIF format
    
    Throws:
    
    java.lang.Exception
  - getFile
```
private java.io.File getFile(org.apache.directory.api.ldap.model.name.Dn entryDn,
                             boolean create)
                      throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Create the file name from the entry Dn.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getFileName
```
private java.lang.String getFileName(org.apache.directory.api.ldap.model.name.Rdn rdn)
                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Compute the real name based on the Rdn, assuming that depending on the underlying OS, some characters are not allowed. We don't allow filename which length is > 255 chars.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getFileName
```
private java.lang.String getFileName(org.apache.directory.api.ldap.model.name.Dn dn)
                              throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Compute the real name based on the Dn, assuming that depending on the underlying OS, some characters are not allowed. We don't allow filename which length is > 255 chars.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - getOSFileName
```
private java.lang.String getOSFileName(java.lang.String fileName)
```
    Get a OS compatible file name. We URL encode all characters that may cause trouble according to http://en.wikipedia.org/wiki/Filenames. This includes C0 control characters [0x00-0x1F] and 0x7F, see http://en.wikipedia.org/wiki/Control_characters.
  - addEntry
```
private void addEntry(org.apache.directory.api.ldap.model.entry.Entry entry)
               throws org.apache.directory.api.ldap.model.exception.LdapException
```
    Write the new entry on disk. It does not exist, as this has been checked by the ExceptionInterceptor.
    
    Throws:
    
    org.apache.directory.api.ldap.model.exception.LdapException
  - deleteFile
```
private boolean deleteFile(java.io.File file)
```
    Recursively delete an entry and all of its children. If the entry is a directory, then get into it, call the same method on each of the contained files, and delete the directory.

Class LdifPartition

Field Summary

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

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

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.partition.ldif.AbstractLdifPartition

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

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

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

Methods inherited from class java.lang.Object

Field Detail

LOG

suffixDirectory

CREATE

DELETE

dirFilter

entryFilter

Constructor Detail

LdifPartition

Method Detail

doInit

add

delete

modify

move

moveAndRename

rename

entryMoved

loadEntries

getFile

getFileName

getFileName

getOSFileName

addEntry

deleteFile