org.apache.ldap.server.configuration
Class DirectoryPartitionConfiguration

java.lang.Object
  extended by org.apache.ldap.server.configuration.DirectoryPartitionConfiguration
Direct Known Subclasses:
MutableDirectoryPartitionConfiguration

public class DirectoryPartitionConfiguration
extends java.lang.Object

A configuration for DirectoryPartition.

Version:
$Rev: 307079 $, $Date: 2005-10-07 06:38:21 -0400 (Fri, 07 Oct 2005) $
Author:
Apache Directory Project

Field Summary
static java.lang.String SYSTEM_PARTITION_NAME
          The name of reserved system partition
 
Constructor Summary
protected DirectoryPartitionConfiguration()
          Creates a new instance.
 
Method Summary
 javax.naming.directory.Attributes getContextEntry()
          Returns root entry that will be added to the DirectoryPartition after it is initialized.
 DirectoryPartition getContextPartition()
          Returns the DirectoryPartition that this configuration configures.
 java.util.Set getIndexedAttributes()
          Returns the set of attribute type strings to create an index on.
 java.lang.String getName()
          Returns user-defined name of the DirectoryPartition that this configuration configures.
 javax.naming.Name getNormalizedSuffix(MatchingRuleRegistry matchingRuleRegistry)
          Returns the normalized suffix of the DirectoryPartition.
 javax.naming.Name getNormalizedSuffix(org.apache.ldap.common.schema.Normalizer normalizer)
          Returns the normalized suffix of the DirectoryPartition.
 java.lang.String getSuffix()
          Returns the suffix of the DirectoryPartition.
protected  void setContextEntry(javax.naming.directory.Attributes rootEntry)
          Sets root entry that will be added to the DirectoryPartition after it is initialized.
protected  void setContextPartition(DirectoryPartition partition)
          Sets the DirectoryPartition that this configuration configures.
protected  void setIndexedAttributes(java.util.Set indexedAttributes)
          Sets the set of attribute type strings to create an index on.
protected  void setName(java.lang.String name)
          Sets user-defined name of the DirectoryPartition that this configuration configures.
protected  void setSuffix(java.lang.String suffix)
          Sets the suffix of the DirectoryPartition.
 void validate()
          Validates this configuration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SYSTEM_PARTITION_NAME

public static final java.lang.String SYSTEM_PARTITION_NAME
The name of reserved system partition

See Also:
Constant Field Values
Constructor Detail

DirectoryPartitionConfiguration

protected DirectoryPartitionConfiguration()
Creates a new instance.

Method Detail

getName

public java.lang.String getName()
Returns user-defined name of the DirectoryPartition that this configuration configures.


setName

protected void setName(java.lang.String name)
Sets user-defined name of the DirectoryPartition that this configuration configures.


getIndexedAttributes

public java.util.Set getIndexedAttributes()
Returns the set of attribute type strings to create an index on.


setIndexedAttributes

protected void setIndexedAttributes(java.util.Set indexedAttributes)
Sets the set of attribute type strings to create an index on.


getContextPartition

public DirectoryPartition getContextPartition()
Returns the DirectoryPartition that this configuration configures.


setContextPartition

protected void setContextPartition(DirectoryPartition partition)
Sets the DirectoryPartition that this configuration configures.


getContextEntry

public javax.naming.directory.Attributes getContextEntry()
Returns root entry that will be added to the DirectoryPartition after it is initialized.


setContextEntry

protected void setContextEntry(javax.naming.directory.Attributes rootEntry)
Sets root entry that will be added to the DirectoryPartition after it is initialized.


getSuffix

public java.lang.String getSuffix()
Returns the suffix of the DirectoryPartition.


getNormalizedSuffix

public javax.naming.Name getNormalizedSuffix(MatchingRuleRegistry matchingRuleRegistry)
                                      throws javax.naming.NamingException
Returns the normalized suffix of the DirectoryPartition.

Throws:
javax.naming.NamingException

getNormalizedSuffix

public javax.naming.Name getNormalizedSuffix(org.apache.ldap.common.schema.Normalizer normalizer)
                                      throws javax.naming.NamingException
Returns the normalized suffix of the DirectoryPartition.

Throws:
javax.naming.NamingException

setSuffix

protected void setSuffix(java.lang.String suffix)
Sets the suffix of the DirectoryPartition.


validate

public void validate()
Validates this configuration.

Throws:
ConfigurationException - if this configuration is not valid