org.apache.directory.server.config

Class ConfigWriter

java.lang.Object

org.apache.directory.server.config.ConfigWriter

public class ConfigWriter
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigBean	configBean The configuration bean
private java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry>	entries The list of entries
private org.apache.directory.api.ldap.model.schema.SchemaManager	schemaManager The schema manager

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
private void	addAttributeTypeValue(java.lang.String attributeType, java.lang.Object value, org.apache.directory.api.ldap.model.ldif.LdifEntry entry) Adds a value, either byte[] or another type (converted into a String via the Object.toString() method), to the attribute.
private void	addAttributeTypeValues(java.lang.String attributeType, java.lang.Object o, org.apache.directory.api.ldap.model.ldif.LdifEntry entry) Adds values for an attribute type to the given entry.
private void	addBean(org.apache.directory.api.ldap.model.name.Dn rootDn, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, AdsBaseBean bean, java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries) Adds a configuration bean to the list of entries.
private void	addBean(org.apache.directory.api.ldap.model.name.Dn rootDn, org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, AdsBaseBean bean, java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries, org.apache.directory.api.ldap.model.ldif.LdifEntry parentEntry, java.lang.String attributeTypeForParentEntry) Adds a configuration bean to the list of entries.
private void	addObjectClassAttribute(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, org.apache.directory.api.ldap.model.ldif.LdifEntry entry, java.lang.String objectClass) Adds the computed 'objectClass' attribute for the given entry and object class name.
private void	computeObjectClassAttributeValues(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager, java.util.Set<java.lang.String> objectClassAttributeValues, org.apache.directory.api.ldap.model.schema.ObjectClass objectClass) Recursively computes the 'objectClass' attribute values set.
private void	convertConfigurationBeanToLdifEntries() Converts the configuration bean to a list of LDIF entries.
private java.lang.String	getClassNameWithoutPackageName(java.lang.Class<?> c) Gets the class name of the given class stripped from its package name.
java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry>	getConvertedLdifEntries() Gets the converted LDIF entries from the configuration bean.
private org.apache.directory.api.ldap.model.name.Dn	getDn(org.apache.directory.api.ldap.model.name.Dn baseDn, AdsBaseBean bean) Gets the Dn associated with the configuration bean based on the given base Dn.
private java.lang.String	getObjectClassNameForBean(java.lang.Class<?> c) Gets the name of the object class to use for the given bean class.
private boolean	isMultiple(java.lang.Class<?> clazz) Indicates the given type is multiple.
void	writeToFile(java.io.File file) Writes the configuration bean as LDIF to the given file.
void	writeToPath(java.lang.String path) Writes the configuration bean as LDIF to the given file.
java.lang.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

Field Detail

schemaManager

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

The schema manager

configBean

private ConfigBean configBean

The configuration bean

entries

private java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries

The list of entries

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

convertConfigurationBeanToLdifEntries

private void convertConfigurationBeanToLdifEntries()
                                            throws ConfigurationException

Converts the configuration bean to a list of LDIF entries.

Throws:

ConfigurationException

writeToPath

public void writeToPath(java.lang.String path)
                 throws ConfigurationException,
                        java.io.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

java.io.IOException - if an error occurs when writing the file

writeToFile

public void writeToFile(java.io.File file)
                 throws ConfigurationException,
                        java.io.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

java.io.IOException - if an error occurs when writing the file

writeToString

public java.lang.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 java.util.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

addObjectClassAttribute

private void addObjectClassAttribute(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                     org.apache.directory.api.ldap.model.ldif.LdifEntry entry,
                                     java.lang.String objectClass)
                              throws org.apache.directory.api.ldap.model.exception.LdapException

Adds the computed 'objectClass' attribute for the given entry and object class name.

Parameters:

schemaManager - the schema manager

entry - the entry

objectClass - the object class name

Throws:

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

computeObjectClassAttributeValues

private void computeObjectClassAttributeValues(org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                                               java.util.Set<java.lang.String> objectClassAttributeValues,
                                               org.apache.directory.api.ldap.model.schema.ObjectClass objectClass)
                                        throws org.apache.directory.api.ldap.model.exception.LdapException

Recursively computes the 'objectClass' attribute values set.

Parameters:

schemaManager - the schema manager

objectClassAttributeValues - the set containing the values

objectClass - the current object class

Throws:

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

addBean

private void addBean(org.apache.directory.api.ldap.model.name.Dn rootDn,
                     org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                     AdsBaseBean bean,
                     java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries)
              throws java.lang.Exception

Adds a configuration bean to the list of entries.

Parameters:

rootDn - the current root Dn

schemaManager - the schema manager

bean - the configuration bean

entries - the list of the entries

Throws:

java.lang.Exception

addBean

private void addBean(org.apache.directory.api.ldap.model.name.Dn rootDn,
                     org.apache.directory.api.ldap.model.schema.SchemaManager schemaManager,
                     AdsBaseBean bean,
                     java.util.List<org.apache.directory.api.ldap.model.ldif.LdifEntry> entries,
                     org.apache.directory.api.ldap.model.ldif.LdifEntry parentEntry,
                     java.lang.String attributeTypeForParentEntry)
              throws java.lang.Exception

Adds a configuration bean to the list of entries.

Parameters:

rootDn - the current root Dn

schemaManager - the schema manager

bean - the configuration bean

entries - the list of the entries

parentEntry - the parent entry

attributeTypeForParentEntry - the attribute type to use when adding the value of the Rdn to the parent entry

Throws:

java.lang.Exception

getObjectClassNameForBean

private java.lang.String getObjectClassNameForBean(java.lang.Class<?> c)

Gets the name of the object class to use for the given bean class.

Parameters:

c - the bean class

Returns:

the name of the object class to use for the given bean class

getClassNameWithoutPackageName

private java.lang.String getClassNameWithoutPackageName(java.lang.Class<?> c)

Gets the class name of the given class stripped from its package name.

Parameters:

c - the class

Returns:

the class name of the given class stripped from its package name

isMultiple

private boolean isMultiple(java.lang.Class<?> clazz)

Indicates the given type is multiple.

Parameters:

clazz - the class

Returns:

true if the given is multiple, false if not.

getDn

private org.apache.directory.api.ldap.model.name.Dn getDn(org.apache.directory.api.ldap.model.name.Dn baseDn,
                                                          AdsBaseBean bean)
                                                   throws org.apache.directory.api.ldap.model.exception.LdapInvalidDnException,
                                                          java.lang.IllegalArgumentException,
                                                          java.lang.IllegalAccessException

Gets the Dn associated with the configuration bean based on the given base Dn.

Parameters:

baseDn - the base Dn

bean - the configuration bean

Returns:

the Dn associated with the configuration bean based on the given base Dn.

Throws:

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

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

addAttributeTypeValues

private void addAttributeTypeValues(java.lang.String attributeType,
                                    java.lang.Object o,
                                    org.apache.directory.api.ldap.model.ldif.LdifEntry entry)
                             throws org.apache.directory.api.ldap.model.exception.LdapException

Adds values for an attribute type to the given entry.

Parameters:

attributeType - the attribute type

value - the value

entry - the entry

Throws:

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

addAttributeTypeValue

private void addAttributeTypeValue(java.lang.String attributeType,
                                   java.lang.Object value,
                                   org.apache.directory.api.ldap.model.ldif.LdifEntry entry)
                            throws org.apache.directory.api.ldap.model.exception.LdapException

Adds a value, either byte[] or another type (converted into a String via the Object.toString() method), to the attribute.

Parameters:

attributeType - the attribute type

value - the value

entry - the entry

Throws:

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