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

Interface PartitionNexus

All Superinterfaces:

Partition

All Known Implementing Classes:

DefaultPartitionNexus

public interface PartitionNexus
extends Partition

A root Partition that contains all other partitions, and routes all operations to the child partition that matches to its base suffixes. It also provides some extended operations such as accessing rootDSE and listing base suffixes.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	ADMIN_PASSWORD_BYTES
static String	ADMIN_PASSWORD_STRING the initial admin passwd set on startup
static String	ADMIN_UID the admin super user uid

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

DEFAULT_ID, ROOT_ID

Method Summary

Modifier and Type	Method and Description
void	addContextPartition(Partition partition) Add a partition to the server.
boolean	compare(CompareOperationContext compareContext)
Partition	getPartition(org.apache.directory.api.ldap.model.name.Dn dn) Get's the partition corresponding to a distinguished name.
org.apache.directory.api.ldap.model.entry.Entry	getRootDse(GetRootDseOperationContext getRootDseContext) Get's the RootDSE entry for the DSA.
org.apache.directory.api.ldap.model.entry.Value<?>	getRootDseValue(org.apache.directory.api.ldap.model.schema.AttributeType attributeType) Get's the RootDSE value associated with an AttributeType
org.apache.directory.api.ldap.model.name.Dn	getSuffixDn(org.apache.directory.api.ldap.model.name.Dn dn) Finds the distinguished name of the suffix that would hold an entry with the supplied distinguished name parameter.
Set<String>	listSuffixes() Gets an iteration over the Name suffixes of the partitions managed by this DefaultPartitionNexus.
void	registerSupportedExtensions(Set<String> extensionOids) Adds a set of supportedExtension (OID Strings) to the RootDSE.
void	registerSupportedSaslMechanisms(Set<String> supportedSaslMechanisms) Adds a set of supportedSaslMechanisms (OID Strings) to the RootDSE.
void	removeContextPartition(org.apache.directory.api.ldap.model.name.Dn partitionDn) Remove a partition from the server.

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

add, delete, destroy, dumpIndex, getContextCsn, getId, getSchemaManager, getSuffixDn, hasEntry, initialize, isInitialized, lookup, modify, move, moveAndRename, rename, saveContextCsn, search, setCacheService, setId, setSchemaManager, setSuffixDn, sync, unbind

Field Detail

ADMIN_UID

static final String ADMIN_UID

the admin super user uid

See Also:

Constant Field Values

ADMIN_PASSWORD_STRING

static final String ADMIN_PASSWORD_STRING

the initial admin passwd set on startup

See Also:

Constant Field Values

ADMIN_PASSWORD_BYTES

static final byte[] ADMIN_PASSWORD_BYTES

Method Detail

getRootDse

org.apache.directory.api.ldap.model.entry.Entry getRootDse(GetRootDseOperationContext getRootDseContext)

Get's the RootDSE entry for the DSA.

Returns:

the attributes of the RootDSE

getRootDseValue

org.apache.directory.api.ldap.model.entry.Value<?> getRootDseValue(org.apache.directory.api.ldap.model.schema.AttributeType attributeType)

Get's the RootDSE value associated with an AttributeType

Parameters:

attributeType - The attribute type for which we want a value

Returns:

the values associated with the given attributeType

addContextPartition

void addContextPartition(Partition partition)
                  throws org.apache.directory.api.ldap.model.exception.LdapException

Add a partition to the server.

Parameters:

Partition - The Partition to add

Throws:

Exception - If the addition can't be done

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

removeContextPartition

void removeContextPartition(org.apache.directory.api.ldap.model.name.Dn partitionDn)
                     throws org.apache.directory.api.ldap.model.exception.LdapException

Remove a partition from the server.

Parameters:

partitionDn - the partition Dn

Throws:

Exception - If the removal can't be done

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

getPartition

Partition getPartition(org.apache.directory.api.ldap.model.name.Dn dn)
                throws org.apache.directory.api.ldap.model.exception.LdapException

Get's the partition corresponding to a distinguished name. This name need not be the name of the partition suffix. When used in conjunction with get suffix this can properly find the partition associated with the Dn. Make sure to use the normalized Dn.

Parameters:

dn - the normalized distinguished name to get a partition for

Returns:

the partition containing the entry represented by the dn

Throws:

Exception - if there is no partition for the dn

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

getSuffixDn

org.apache.directory.api.ldap.model.name.Dn getSuffixDn(org.apache.directory.api.ldap.model.name.Dn dn)
                                                 throws org.apache.directory.api.ldap.model.exception.LdapException

Finds the distinguished name of the suffix that would hold an entry with the supplied distinguished name parameter. If the Dn argument does not fall under a partition suffix then the empty string Dn is returned.

Parameters:

The - Dn we want to find the suffix from

Returns:

the suffix portion of dn, or the valid empty string Dn if no naming context was found for dn.

Throws:

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

listSuffixes

Set<String> listSuffixes()
                  throws org.apache.directory.api.ldap.model.exception.LdapException

Gets an iteration over the Name suffixes of the partitions managed by this DefaultPartitionNexus.

Returns:

Iteration over ContextPartition suffix names as Names.

Throws:

Exception - if there are any problems

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

registerSupportedExtensions

void registerSupportedExtensions(Set<String> extensionOids)
                          throws org.apache.directory.api.ldap.model.exception.LdapException

Adds a set of supportedExtension (OID Strings) to the RootDSE.

Parameters:

extensionOids - a set of OID strings to add to the supportedExtension attribute in the RootDSE

Throws:

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

registerSupportedSaslMechanisms

void registerSupportedSaslMechanisms(Set<String> supportedSaslMechanisms)
                              throws org.apache.directory.api.ldap.model.exception.LdapException

Adds a set of supportedSaslMechanisms (OID Strings) to the RootDSE.

Parameters:

extensionOids - a set of OID strings to add to the supportedSaslMechanisms attribute in the RootDSE

Throws:

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

compare

boolean compare(CompareOperationContext compareContext)
         throws org.apache.directory.api.ldap.model.exception.LdapException

Throws:

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