org.apache.directory.server.core.api.schema

Class SchemaPartition

java.lang.Object

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

org.apache.directory.server.core.api.schema.SchemaPartition

All Implemented Interfaces:

Partition

public final class SchemaPartition
extends AbstractPartition

A special partition designed to contain the portion of the DIT where schema information for the server is stored. In an effort to make sure that all Partition implementations are equal citizens to ApacheDS we want to be able to swap in and out any kind of Partition to store schema. This also has the added advantage of making sure the core, and hence the server is not dependent on any specific partition, which reduces coupling in the server's modules. The SchemaPartition achieves this by not really being a backing store itself for the schema entries. It instead delegates to another Partition via containment. It delegates all calls to this contained Partition. While doing so it also manages certain things:

1. Checks that schema changes are valid.
2. Updates the schema Registries on valid schema changes making sure the schema on disk is in sync with the schema in memory.
3. Will eventually manage transaction based changes to schema where between some sequence of operations the schema may be inconsistent.
4. Delegates read/write operations to contained Partition.
5. Responsible for initializing schema for the entire server. ApacheDS cannot start up other partitions until this Partition is started without having access to the Registries. This Partition supplies the Registries on initialization for the server. That's one of it's core responsibilities.
So by containing another Partition, we abstract the storage mechanism away from the management responsibilities while decoupling the server from a specific partition implementation and removing complexity in the Schema interceptor service which before managed synchronization.

Author:

Apache Directory Project

Field Summary

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.core.api.partition.Partition

DEFAULT_ID, ROOT_ID

Constructor Summary

Constructors

Constructor and Description
SchemaPartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

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(DeleteOperationContext deleteContext) Deletes a leaf entry from this ContextPartition: non-leaf entries cannot be deleted until this operation has been applied to their children.
protected void	doDestroy() Override this method to put your initialization code.
protected void	doInit() Override this method to put your initialization code.
int	getChildCount(DeleteOperationContext deleteContext)
String	getContextCsn()
Partition	getWrappedPartition() Gets the Partition being wrapped.
boolean	hasEntry(HasEntryOperationContext hasEntryContext) Fast operation to check and see if a particular entry exists.
org.apache.directory.api.ldap.model.entry.Entry	lookup(LookupOperationContext lookupContext) Looks up an entry by distinguished/absolute name.
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.
void	saveContextCsn() saves the context CSN value in the context entry of the partition
EntryFilteringCursor	search(SearchOperationContext searchContext) Conducts a search against this ContextPartition.
void	setCacheService(CacheService cacheService) set the Cache service
void	setId(String id) Has no affect: the id is fixed at SCHEMA_ID: 'schema'.
void	setWrappedPartition(Partition wrapped) Sets the wrapped Partition which must be supplied or Partition.initialize() will fail with a NullPointerException.
void	sync() Flushes any changes made to this partition now.
String	toString()
void	unbind(UnbindOperationContext unbindContext) Represents an unbind operation issued by an authenticated client.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaPartition

public SchemaPartition(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Method Detail

setWrappedPartition

public void setWrappedPartition(Partition wrapped)

Sets the wrapped Partition which must be supplied or Partition.initialize() will fail with a NullPointerException.

Parameters:

wrapped - the Partition being wrapped

getWrappedPartition

public Partition getWrappedPartition()

Gets the Partition being wrapped.

Returns:

the wrapped Partition

setId

public void setId(String id)

Has no affect: the id is fixed at SCHEMA_ID: 'schema'. A warning is logged.

Specified by:

setId in interface Partition

Overrides:

setId in class AbstractPartition

Parameters:

id - the unique identifier for this partition

sync

public void sync()
          throws Exception

Flushes any changes made to this partition now.

Throws:

Exception - if buffers cannot be flushed to disk

doInit

protected void doInit()
               throws Exception

Override this method to put your initialization code.

Specified by:

doInit in class AbstractPartition

Throws:

Exception

doDestroy

protected void doDestroy()

Override this method to put your initialization code.

Specified by:

doDestroy in class AbstractPartition

add

public void add(AddOperationContext addContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Adds an entry to this ContextPartition.

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

getChildCount

public int getChildCount(DeleteOperationContext deleteContext)
                  throws org.apache.directory.api.ldap.model.exception.LdapException

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.

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

hasEntry

public boolean hasEntry(HasEntryOperationContext hasEntryContext)
                 throws org.apache.directory.api.ldap.model.exception.LdapException

Fast operation to check and see if a particular entry exists.

Parameters:

hasEntryContext - The context used to pass informations

Returns:

true if the entry exists, false if it does not

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.

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.

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.

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.

Parameters:

renameContext - the modify Dn context

Throws:

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

search

public EntryFilteringCursor search(SearchOperationContext searchContext)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Conducts a search against this ContextPartition. Namespace specific parameters for search are contained within the environment using namespace specific keys into the hash. For example in the LDAP namespace a ContextPartition implementation may look for search Controls using a namespace specific or implementation specific key for the set of LDAP Controls.

Parameters:

searchContext - The context containing the information used by the operation

Returns:

a NamingEnumeration containing objects of type

Throws:

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

unbind

public void unbind(UnbindOperationContext unbindContext)
            throws org.apache.directory.api.ldap.model.exception.LdapException

Represents an unbind operation issued by an authenticated client. Partitions need not support this operation. This operation is here to enable those interested in implementing virtual directories with ApacheDS.

Parameters:

unbindContext - the context used to unbind

Throws:

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

lookup

public org.apache.directory.api.ldap.model.entry.Entry lookup(LookupOperationContext lookupContext)
                                                       throws org.apache.directory.api.ldap.model.exception.LdapException

Looks up an entry by distinguished/absolute name. This is a simplified version of the search operation used to point read an entry used for convenience. Depending on the context parameters, we my look for a simple entry, or for a restricted set of attributes for this entry

Parameters:

lookupContext - The context containing the parameters

Returns:

an Attributes object representing the entry

Throws:

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

getContextCsn

public String getContextCsn()

Description copied from class: AbstractPartition

Specified by:

getContextCsn in interface Partition

Overrides:

getContextCsn in class AbstractPartition

Returns:

the current highest committed CSN value

saveContextCsn

public void saveContextCsn()
                    throws Exception

Description copied from interface: Partition

saves the context CSN value in the context entry of the partition

Throws:

Exception

setCacheService

public void setCacheService(CacheService cacheService)

Description copied from class: AbstractPartition

set the Cache service

Specified by:

setCacheService in interface Partition

Overrides:

setCacheService in class AbstractPartition

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()