org.apache.directory.api.ldap.schema.extractor.impl

Class DefaultSchemaLdifExtractor

java.lang.Object

org.apache.directory.api.ldap.schema.extractor.impl.DefaultSchemaLdifExtractor

All Implemented Interfaces:

SchemaLdifExtractor

public class DefaultSchemaLdifExtractor
extends Object
implements SchemaLdifExtractor

Extracts LDIF files for the schema repository onto a destination directory.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BASE_PATH The base path.
private static Pattern	EXTRACT_PATTERN The pattern to extract the schema from LDIF files.
private boolean	extracted The extracted flag.
private static org.slf4j.Logger	LOG The logger.
private File	outputDirectory The output directory.
private static String	SCHEMA_SUBDIR The schema sub-directory.

Constructor Summary

Constructors

Constructor and Description
DefaultSchemaLdifExtractor(File outputDirectory) Creates an extractor which deposits files into the specified output directory.

Method Summary

Modifier and Type	Method and Description
private File	assembleDestinationFile(Deque<String> fileComponentStack) Assembles the destination file by appending file components previously pushed on the fileComponentStack argument.
private void	copyFile(File source, File destination) Copies a file line by line from the source file argument to the destination file argument.
private void	extractFromClassLoader(String resource) Extracts the LDIF schema resource from class loader.
void	extractOrCopy() Extracts the LDIF files from a Jar file or copies exploded LDIF resources without overwriting the resources if the schema has already been extracted.
void	extractOrCopy(boolean overwrite) Extracts the LDIF files from a Jar file or copies exploded LDIF resources.
static URL	getAnyResource(String resourceName, String resourceDescription) Gets resource from the class loader.
private File	getDestinationFile(File resource) Calculates the destination file.
static URL	getUniqueResource(String resourceName, String resourceDescription) Gets a unique resource from the class loader.
static InputStream	getUniqueResourceAsStream(String resourceName, String resourceDescription) Gets the unique schema file resource from the class loader off the base path.
boolean	isExtracted() Gets whether or not schema folder has been created or not.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_PATH

private static final String BASE_PATH

The base path.

See Also:

Constant Field Values

SCHEMA_SUBDIR

private static final String SCHEMA_SUBDIR

The schema sub-directory.

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

The logger.

EXTRACT_PATTERN

private static final Pattern EXTRACT_PATTERN

The pattern to extract the schema from LDIF files. java.util.regex.Pattern is immutable so only one instance is needed for all uses.

extracted

private boolean extracted

The extracted flag.

outputDirectory

private File outputDirectory

The output directory.

Constructor Detail

DefaultSchemaLdifExtractor

public DefaultSchemaLdifExtractor(File outputDirectory)

Creates an extractor which deposits files into the specified output directory.

Parameters:

outputDirectory - the directory where the schema root is extracted

Method Detail

isExtracted

public boolean isExtracted()

Gets whether or not schema folder has been created or not.

Specified by:

isExtracted in interface SchemaLdifExtractor

Returns:

true if schema folder has already been extracted.

extractOrCopy

public void extractOrCopy(boolean overwrite)
                   throws IOException

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

Specified by:

extractOrCopy in interface SchemaLdifExtractor

Parameters:

overwrite - over write extracted structure if true, false otherwise

Throws:

IOException - if schema already extracted and on IO errors

extractOrCopy

public void extractOrCopy()
                   throws IOException

Extracts the LDIF files from a Jar file or copies exploded LDIF resources without overwriting the resources if the schema has already been extracted.

Specified by:

extractOrCopy in interface SchemaLdifExtractor

Throws:

IOException - if schema already extracted and on IO errors

copyFile

private void copyFile(File source,
                      File destination)
               throws 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:

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

assembleDestinationFile

private File assembleDestinationFile(Deque<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

getDestinationFile

private File getDestinationFile(File resource)

Calculates the destination file.

Parameters:

resource - the source file

Returns:

the destination file's parent directory

getUniqueResourceAsStream

public static InputStream getUniqueResourceAsStream(String resourceName,
                                                    String resourceDescription)
                                             throws IOException

Gets the unique schema file resource from the class loader off the base path. If the same resource exists multiple times then an error will result since the resource is not unique.

Parameters:

resourceName - the file name of the resource to load

resourceDescription - human description of the resource

Returns:

the InputStream to read the contents of the resource

Throws:

IOException - if there are problems reading or finding a unique copy of the resource

getUniqueResource

public static URL getUniqueResource(String resourceName,
                                    String resourceDescription)
                             throws IOException

Gets a unique resource from the class loader.

Parameters:

resourceName - the name of the resource

resourceDescription - the description of the resource

Returns:

the URL to the resource in the class loader

Throws:

IOException - if there is an IO error

getAnyResource

public static URL getAnyResource(String resourceName,
                                 String resourceDescription)
                          throws IOException

Gets resource from the class loader. In case of several files with the same name, it returns any of them. This is useful in cases when the same artefacts are loaded several times, e.g. in some testing scenarios.

Parameters:

resourceName - the name of the resource

resourceDescription - the description of the resource

Returns:

the URL to the resource in the class loader

Throws:

IOException - if there is an IO error

extractFromClassLoader

private void extractFromClassLoader(String resource)
                             throws IOException

Extracts the LDIF schema resource from class loader.

Parameters:

resource - the LDIF schema resource

Throws:

IOException - if there are IO errors