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

Class AbstractPartition

java.lang.Object

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

All Implemented Interfaces:

Partition

Direct Known Subclasses:

AbstractBTreePartition, DefaultPartitionNexus, RootPartition, SchemaPartition

public abstract class AbstractPartition
extends Object
implements Partition

A Partition that helps users to implement their own partition. Most methods are implemented by default. Please look at the description of each methods for the detail of implementations.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.directory.api.ldap.model.entry.Entry	contextEntry The partition ContextEntry
protected boolean	ctxCsnChanged a flag to detect the change in context CSN
protected DnFactory	dnFactory The DnFactory to use to create DN
protected String	id The partition ID
protected boolean	initialized true if and only if this partition is initialized.
protected org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The SchemaManager instance
protected org.apache.directory.api.ldap.model.name.Dn	suffixDn The root Dn for this partition

Fields inherited from interface org.apache.directory.server.core.api.partition.Partition

DEFAULT_ID, ROOT_ID

Constructor Summary

Constructors

Constructor and Description
AbstractPartition()

Method Summary

Modifier and Type	Method and Description
protected void	checkInitialized(String property) Check that the operation is done on an initialized store
void	destroy(PartitionTxn partitionTxn) Calls doDestroy() where you have to put your destroy code in, and clears default properties.
protected abstract void	doDestroy(PartitionTxn partitionTxn) Override this method to put your initialization code.
protected abstract void	doInit() Override this method to put your initialization code.
protected abstract void	doRepair() Override this method to implement a repair method
void	dumpIndex(PartitionTxn partitionTxn, OutputStream stream, String name) Dump the requested index to a given stream
String	getContextCsn(PartitionTxn partitionTxn) Get the contextCSN
org.apache.directory.api.ldap.model.entry.Entry	getContextEntry()
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.
void	initialize() Initializes this partition.
boolean	isInitialized() Checks to see if this partition is initialized or not.
void	repair() Repair this partition.
protected void	setContextCsn(String csn) Replaces the current context CSN with the given CSN value if they are not same and sets the ctxCsnChanged flag to true.
void	setContextEntry(org.apache.directory.api.ldap.model.entry.Entry contextEntry)
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.server.core.api.partition.Partition

add, beginReadTransaction, beginWriteTransaction, delete, getSubordinates, hasEntry, lookup, modify, move, moveAndRename, rename, saveContextCsn, search, unbind

Field Detail

initialized

protected boolean initialized

true if and only if this partition is initialized.

contextEntry

protected org.apache.directory.api.ldap.model.entry.Entry contextEntry

The partition ContextEntry

schemaManager

protected org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager

The SchemaManager instance

dnFactory

protected DnFactory dnFactory

The DnFactory to use to create DN

id

protected String id

The partition ID

suffixDn

protected org.apache.directory.api.ldap.model.name.Dn suffixDn

The root Dn for this partition

ctxCsnChanged

protected volatile boolean ctxCsnChanged

a flag to detect the change in context CSN

Constructor Detail

AbstractPartition

public AbstractPartition()

Method Detail

initialize

public 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.

Specified by:

initialize in interface Partition

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if initialization fails in any way

repair

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

Repair this partition.

Specified by:

repair in interface Partition

Throws:

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

doDestroy

protected abstract void doDestroy(PartitionTxn partitionTxn)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

Override this method to put your initialization code.

Parameters:

partitionTxn - The transaction to use

Throws:

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

doInit

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

Override this method to put your initialization code.

Throws:

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

InvalidNameException - If the initialization failed

doRepair

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

Override this method to implement a repair method

Throws:

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

destroy

public final void destroy(PartitionTxn partitionTxn)
                   throws org.apache.directory.api.ldap.model.exception.LdapException

Calls doDestroy() where you have to put your destroy code in, and clears default properties. Once this method is invoked, isInitialized() will return false.

Specified by:

destroy in interface Partition

Parameters:

partitionTxn - The transaction to use

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If we can't destroy the partition

isInitialized

public final boolean isInitialized()

Checks to see if this partition is initialized or not.

Specified by:

isInitialized in interface Partition

Returns:

true if the partition is initialized, false otherwise

setSchemaManager

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

Sets the schema manager assigned to this Partition.

Specified by:

setSchemaManager in interface Partition

Parameters:

schemaManager - The SchemaManager instance

getSchemaManager

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

Gets the schema manager assigned to this Partition.

Specified by:

getSchemaManager in interface Partition

Returns:

the schema manager

getId

public final String getId()

Gets the unique identifier for this partition.

Specified by:

getId in interface Partition

Returns:

the unique identifier for this partition

setId

public void setId(String id)

Sets the unique identifier for this partition.

Specified by:

setId in interface Partition

Parameters:

id - the unique identifier for this partition

getSuffixDn

public final 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.

Specified by:

getSuffixDn in interface Partition

Returns:

the suffix for this Partition.

setSuffixDn

public 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.

Specified by:

setSuffixDn in interface Partition

Parameters:

suffixDn - the new suffix Dn

Throws:

org.apache.directory.api.ldap.model.exception.LdapInvalidDnException - If the Dn is invalid

dumpIndex

public void dumpIndex(PartitionTxn partitionTxn,
                      OutputStream stream,
                      String name)
               throws IOException

Dump the requested index to a given stream

Specified by:

dumpIndex in interface Partition

Parameters:

partitionTxn - The transaction to use

stream - The Stream used to dump the index

name - The index to dump to stdout

Throws:

IOException - if we can't write the data

checkInitialized

protected void checkInitialized(String property)

Check that the operation is done on an initialized store

Parameters:

property - The property that was initialized

getContextEntry

public org.apache.directory.api.ldap.model.entry.Entry getContextEntry()

Returns:

the contextEntry

setContextEntry

public void setContextEntry(org.apache.directory.api.ldap.model.entry.Entry contextEntry)

Parameters:

contextEntry - the contextEntry to set

getContextCsn

public String getContextCsn(PartitionTxn partitionTxn)

Get the contextCSN

Specified by:

getContextCsn in interface Partition

Parameters:

partitionTxn - The transaction to use

Returns:

the current highest committed CSN value

setContextCsn

protected void setContextCsn(String csn)

Replaces the current context CSN with the given CSN value if they are not same and sets the ctxCsnChanged flag to true.

Parameters:

csn - the CSN value

sync

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

Flushes any changes made to this partition now.

Specified by:

sync in interface Partition

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - if buffers cannot be flushed to disk