org.apache.directory.server.config

Class ConfigWriter

java.lang.Object

org.apache.directory.server.config.ConfigWriter

public class ConfigWriter
extends Object

This class implements a writer for ApacheDS Configuration.

It can be used either:

• write the configuration to an LDIF
• get the list of LDIF entries from the configuration

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
ConfigWriter(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, ConfigBean configBean) Creates a new instance of ConfigWriter.

Method Summary

Modifier and Type	Method and Description
List<org.apache.directory.api.ldap.model.ldif.LdifEntry>	getConvertedLdifEntries() Gets the converted LDIF entries from the configuration bean.
void	writeToFile(File file) Writes the configuration bean as LDIF to the given file.
void	writeToPath(String path) Writes the configuration bean as LDIF to the given file.
String	writeToString() Writes the configuration to a String object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigWriter

public ConfigWriter(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                    ConfigBean configBean)

Creates a new instance of ConfigWriter.

Parameters:

schemaManager - the schema manager

configBean - the configuration bean

Method Detail

writeToPath

public void writeToPath(String path)
                 throws ConfigurationException,
                        IOException

Writes the configuration bean as LDIF to the given file.

Parameters:

path - the output file path

Throws:

ConfigurationException - if an error occurs during the conversion to LDIF

IOException - if an error occurs when writing the file

writeToFile

public void writeToFile(File file)
                 throws ConfigurationException,
                        IOException

Writes the configuration bean as LDIF to the given file.

Parameters:

file - the output file

Throws:

ConfigurationException - if an error occurs during the conversion to LDIF

IOException - if an error occurs when writing the file

writeToString

public String writeToString()
                     throws ConfigurationException

Writes the configuration to a String object.

Returns:

a String containing the LDIF representation of the configuration

Throws:

ConfigurationException - if an error occurs during the conversion to LDIF

getConvertedLdifEntries

public List<org.apache.directory.api.ldap.model.ldif.LdifEntry> getConvertedLdifEntries()
                                                                                 throws ConfigurationException

Gets the converted LDIF entries from the configuration bean.

Returns:

the list of converted LDIF entries

Throws:

ConfigurationException - if an error occurs during the conversion to LDIF