org.apache.directory.server.config

Class LdifConfigExtractor

java.lang.Object

org.apache.directory.server.config.LdifConfigExtractor

public final class LdifConfigExtractor
extends java.lang.Object

A class to copy the default config to the work directory of a DirectoryService instance. NOTE: much of this class code is duplicated from DefaultSchemaLdifExtractor class We should create a AbstractLdifExtractor class and move the reusable code there

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CONFIG_SUBDIR
private static java.util.regex.Pattern	EXTRACT_PATTERN
static java.lang.String	LDIF_CONFIG_FILE
private static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Modifier	Constructor and Description
private	LdifConfigExtractor()

Method Summary

Modifier and Type	Method and Description
private static java.io.File	assembleDestinationFile(java.io.File outputDirectory, java.util.Stack<java.lang.String> fileComponentStack) Assembles the destination file by appending file components previously pushed on the fileComponentStack argument.
private static void	copyFile(java.io.File source, java.io.File destination) Copies a file line by line from the source file argument to the destination file argument.
static void	extract(java.io.File outputDirectory, boolean overwrite) Extracts the LDIF files from a Jar file or copies exploded LDIF resources.
private static void	extractFromJar(java.io.File outputDirectory, java.lang.String resource) Extracts the LDIF schema resource from a Jar.
static java.lang.String	extractSingleFileConfig(java.io.File configDir, java.lang.String file, boolean overwrite) extracts or overwrites the configuration LDIF file and returns the absolute path of this file
private static java.io.File	getDestinationFile(java.io.File outputDirectory, java.io.File resource) Calculates the destination file.

Methods inherited from class java.lang.Object

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

Field Detail

LDIF_CONFIG_FILE

public static final java.lang.String LDIF_CONFIG_FILE

See Also:

Constant Field Values

CONFIG_SUBDIR

private static final java.lang.String CONFIG_SUBDIR

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

EXTRACT_PATTERN

private static final java.util.regex.Pattern EXTRACT_PATTERN

Constructor Detail

LdifConfigExtractor

private LdifConfigExtractor()

Method Detail

extract

public static void extract(java.io.File outputDirectory,
                           boolean overwrite)
                    throws java.io.IOException

Extracts the LDIF files from a Jar file or copies exploded LDIF resources.

Parameters:

overwrite - over write extracted structure if true, false otherwise

Throws:

java.io.IOException - if schema already extracted and on IO errors

copyFile

private static void copyFile(java.io.File source,
                             java.io.File destination)
                      throws java.io.IOException

Copies a file line by line from the source file argument to the destination file argument.

Parameters:

source - the source file to copy

destination - the destination to copy the source to

Throws:

java.io.IOException - if there are IO errors or the source does not exist

extractFromJar

private static void extractFromJar(java.io.File outputDirectory,
                                   java.lang.String resource)
                            throws java.io.IOException

Extracts the LDIF schema resource from a Jar.

Parameters:

resource - the LDIF schema resource

Throws:

java.io.IOException - if there are IO errors

getDestinationFile

private static java.io.File getDestinationFile(java.io.File outputDirectory,
                                               java.io.File resource)

Calculates the destination file.

Parameters:

resource - the source file

Returns:

the destination file's parent directory

assembleDestinationFile

private static java.io.File assembleDestinationFile(java.io.File outputDirectory,
                                                    java.util.Stack<java.lang.String> fileComponentStack)

Assembles the destination file by appending file components previously pushed on the fileComponentStack argument.

Parameters:

fileComponentStack - stack containing pushed file components

Returns:

the assembled destination file

extractSingleFileConfig

public static java.lang.String extractSingleFileConfig(java.io.File configDir,
                                                       java.lang.String file,
                                                       boolean overwrite)

extracts or overwrites the configuration LDIF file and returns the absolute path of this file

Parameters:

configDir - the directory where the config file should be extracted to

overwrite - flag to indicate to overwrite the config file if already present in the given config directory

Returns:

complete path of the config file on disk