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

Interface Partition

All Known Subinterfaces:

PartitionNexus

All Known Implementing Classes:

AbstractBTreePartition, AbstractLdifPartition, AbstractPartition, AvlPartition, DefaultPartitionNexus, JdbmPartition, LdifPartition, MavibotPartition, ReadOnlyConfigurationPartition, SchemaPartition, SingleFileLdifPartition

public interface Partition

Interface for entry stores containing a part of the DIB (Directory Information Base). Partitions are associated with a specific suffix, and all entries contained in the them have the same Dn suffix in common.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ID Default id used for context entry if context entry doesn't exists
static String	ROOT_ID root ID common to all partitions

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.
void	destroy() Instructs this Partition to synchronize with it's persistent store, and destroy all held resources, in preparation for a shutdown event.
void	dumpIndex(OutputStream stream, String name) Dump the requested index to a given stream
String	getContextCsn()
String	getId() Gets the unique identifier for this partition.
org.apache.directory.api.ldap.model.schema.SchemaManager	getSchemaManager() Gets the schema manager assigned to this Partition.
org.apache.directory.api.ldap.model.name.Dn	getSuffixDn() Gets the normalized suffix as an Dn for this Partition after it has been initialized.
boolean	hasEntry(HasEntryOperationContext hasEntryContext) Fast operation to check and see if a particular entry exists.
void	initialize() Initializes this partition.
boolean	isInitialized() Checks to see if this partition is initialized or not.
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) Sets the unique identifier for this partition.
void	setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager) Sets the schema manager assigned to this Partition.
void	setSuffixDn(org.apache.directory.api.ldap.model.name.Dn suffixDn) Sets the suffix Dn, must be normalized.
void	sync() Flushes any changes made to this partition now.
void	unbind(UnbindOperationContext unbindContext) Represents an unbind operation issued by an authenticated client.

Field Detail

ROOT_ID

static final String ROOT_ID

root ID common to all partitions

DEFAULT_ID

static final String DEFAULT_ID

Default id used for context entry if context entry doesn't exists

Method Detail

getId

String getId()

Gets the unique identifier for this partition.

Returns:

the unique identifier for this partition

setId

void setId(String id)

Sets the unique identifier for this partition.

Parameters:

id - the unique identifier for this partition

getSchemaManager

org.apache.directory.api.ldap.model.schema.SchemaManager getSchemaManager()

Gets the schema manager assigned to this Partition.

Returns:

the schema manager

setSchemaManager

void setSchemaManager(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager)

Sets the schema manager assigned to this Partition.

Parameters:

registries - the manager to assign to this Partition.

initialize

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

Initializes this partition. isInitialized() will return true if #doInit() returns without any errors. destroy() is called automatically as a clean-up process if #doInit() throws an exception.

Throws:

Exception - if initialization fails in any way

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

getSuffixDn

org.apache.directory.api.ldap.model.name.Dn getSuffixDn()

Gets the normalized suffix as an Dn for this Partition after it has been initialized. Attempts to get this Dn before initialization throw an IllegalStateException.

Returns:

the suffix for this Partition.

Throws:

IllegalStateException - if the Partition has not been initialized

setSuffixDn

void setSuffixDn(org.apache.directory.api.ldap.model.name.Dn suffixDn)
          throws org.apache.directory.api.ldap.model.exception.LdapInvalidDnException

Sets the suffix Dn, must be normalized.

Parameters:

suffixDn - the new suffix Dn

Throws:

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

destroy

void destroy()
      throws Exception

Instructs this Partition to synchronize with it's persistent store, and destroy all held resources, in preparation for a shutdown event.

Throws:

Exception

isInitialized

boolean isInitialized()

Checks to see if this partition is initialized or not.

Returns:

true if the partition is initialized, false otherwise

sync

void sync()
   throws Exception

Flushes any changes made to this partition now.

Throws:

Exception - if buffers cannot be flushed to disk

delete

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:

Exception - if there are any problems

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

add

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

modify

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:

Exception - if there are any problems

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

See Also:

DirContext, DirContext.ADD_ATTRIBUTE, DirContext.REMOVE_ATTRIBUTE, DirContext.REPLACE_ATTRIBUTE

search

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:

Exception - if there are any problems

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

lookup

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:

Exception - if there are any problems

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

hasEntry

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:

Exception - if there are any problems

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

rename

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:

Exception - if there are any problems

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

move

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:

Exception - if there are any problems

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

moveAndRename

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:

Exception - if there are any problems

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

unbind

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:

Exception - if something goes wrong

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

dumpIndex

void dumpIndex(OutputStream stream,
               String name)
        throws IOException

Dump the requested index to a given stream

Parameters:

name - The index to dump to stdout

Throws:

IOException - if we can't write the data

setCacheService

void setCacheService(CacheService cacheService)

set the Cache service

Parameters:

cacheService -

getContextCsn

String getContextCsn()

Returns:

the current highest committed CSN value

saveContextCsn

void saveContextCsn()
             throws Exception

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

Throws:

Exception