org.apache.directory.server.core.configuration
Class Configuration

java.lang.Object
  org.apache.directory.server.core.configuration.Configuration

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

AddPartitionConfiguration, RemovePartitionConfiguration, ServiceConfiguration, ShutdownConfiguration, StartupConfiguration, SyncConfiguration

public abstract class Configuration
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

A configuration that provides required, optional, or default properties to configure DirectoryService.

Version:

$Rev: 438383 $, $Date: 2006-08-30 08:03:05 +0200 (Wed, 30 Aug 2006) $

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

static java.lang.String	DEFAULT_INSTANCE_ID The default ID of DirectoryService that is used when no instance ID is specified.
static java.lang.String	JNDI_KEY A JNDI environment key that configuration instance is put on.

Constructor Summary

protected

Configuration() Creates a new instance.

Method Summary

java.lang.Object	clone()
java.lang.String	getInstanceId() Returns the ID of DirectoryService instance to configure.
protected void	setInstanceId(java.lang.String instanceId) Sets the ID of DirectoryService instance to configure.
static Configuration	toConfiguration(java.util.Hashtable jndiEnvironment) Gets Configuration instance from the specified JNDI environment Hashtable.
java.util.Hashtable	toJndiEnvironment() Converts this configuration to JNDI environment Hashtable.
void	validate() Validates this configuration.

Methods inherited from class java.lang.Object

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

Field Detail

JNDI_KEY

public static final java.lang.String JNDI_KEY

A JNDI environment key that configuration instance is put on.

DEFAULT_INSTANCE_ID

public static final java.lang.String DEFAULT_INSTANCE_ID

The default ID of DirectoryService that is used when no instance ID is specified.

See Also:

Constant Field Values

Constructor Detail

Configuration

protected Configuration()

Creates a new instance.

Method Detail

toConfiguration

public static Configuration toConfiguration(java.util.Hashtable jndiEnvironment)

Gets Configuration instance from the specified JNDI environment Hashtable. If a configuration instance is not present the default StartupConfiguration is returned and injected into the environment.

Throws:

ConfigurationException - if the specified environment doesn't contain the proper configuration instance.

getInstanceId

public java.lang.String getInstanceId()

Returns the ID of DirectoryService instance to configure.

setInstanceId

protected void setInstanceId(java.lang.String instanceId)

Sets the ID of DirectoryService instance to configure.

validate

public void validate()

Validates this configuration.

Throws:

ConfigurationException - if this configuration is not valid

toJndiEnvironment

public java.util.Hashtable toJndiEnvironment()

Converts this configuration to JNDI environment Hashtable. This method simple returns a Hashtable that contains an entry whose key is JNDI_KEY and whose value is this.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object