org.apache.directory.server.config

Class ReadOnlyConfigurationPartition

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.config.ReadOnlyConfigurationPartition

All Implemented Interfaces:

Partition, Store

public class ReadOnlyConfigurationPartition
extends AbstractLdifPartition

This class implements a read-only configuration partition.

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.InputStream	inputStream The input stream

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
ReadOnlyConfigurationPartition(java.io.InputStream inputStream, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Creates a new instance of ReadOnlyConfigurationPartition.

Method Summary

Modifier and Type	Method and Description
void	add(AddOperationContext arg0) Adds an entry to this ContextPartition.
private void	addMandatoryOpAt(org.apache.directory.api.ldap.model.entry.Entry entry) Adds the CSN and UUID attributes to the entry if they are not present.
org.apache.directory.api.ldap.model.entry.Entry	delete(DeleteOperationContext deleteContext) Deletes a leaf entry from this ContextPartition: non-leaf entries cannot be deleted until this operation has been applied to their children.
org.apache.directory.api.ldap.model.entry.Entry	delete(java.lang.String id) Delete the entry associated with a given Id
protected void	doInit() Override this method to put your initialization code.
private void	loadLdifEntries() Loads the LDIF entries from the input stream.
void	modify(ModifyOperationContext arg0) Modifies an entry by adding, removing or replacing a set of attributes.
void	move(MoveOperationContext arg0) Transplants a child entry, to a position in the namespace under a new parent entry.
void	moveAndRename(MoveAndRenameOperationContext arg0) 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 arg0) 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, 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

inputStream

private java.io.InputStream inputStream

The input stream

Constructor Detail

ReadOnlyConfigurationPartition

public ReadOnlyConfigurationPartition(java.io.InputStream inputStream,
                                      org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Creates a new instance of ReadOnlyConfigurationPartition.

Parameters:

inputStream - the input stream

schemaManager - the schema manager

Method Detail

doInit

protected void doInit()
               throws javax.naming.InvalidNameException,
                      java.lang.Exception

Override this method to put your initialization code.

Overrides:

doInit in class AvlPartition

Throws:

java.lang.Exception

javax.naming.InvalidNameException

loadLdifEntries

private void loadLdifEntries()
                      throws java.lang.Exception

Loads the LDIF entries from the input stream.

Throws:

java.lang.Exception

addMandatoryOpAt

private void addMandatoryOpAt(org.apache.directory.api.ldap.model.entry.Entry entry)
                       throws org.apache.directory.api.ldap.model.exception.LdapException

Adds the CSN and UUID attributes to the entry if they are not present.

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

add

public void add(AddOperationContext arg0)
         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:

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

delete

public org.apache.directory.api.ldap.model.entry.Entry delete(DeleteOperationContext deleteContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Deletes a leaf entry from this ContextPartition: non-leaf entries cannot be deleted until this operation has been applied to their children.

Specified by:

delete in interface Partition

Overrides:

delete in class AbstractBTreePartition

Parameters:

deleteContext - the context of the entry to delete from this ContextPartition.

Returns:

The delete Entry, if found

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

modify

public void modify(ModifyOperationContext arg0)
            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:

arg0 - 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 arg0)
          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:

arg0 - The context containing the DNs to move

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

moveAndRename

public void moveAndRename(MoveAndRenameOperationContext arg0)
                   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:

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

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

rename

public void rename(RenameOperationContext arg0)
            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:

arg0 - the modify Dn context

Throws:

org.apache.directory.api.ldap.model.exception.LdapException