org.apache.directory.server.protocol.shared.store

Class LdifFileLoader

java.lang.Object

org.apache.directory.server.protocol.shared.store.LdifFileLoader

public class LdifFileLoader
extends java.lang.Object

Support for commands to load an LDIF file into a DirContext.

Field Summary

Fields

Modifier and Type	Field and Description
protected CoreSession	coreSession a handle on the top core session
private int	count the total count of entries loaded
protected java.util.List<LdifLoadFilter>	filters the filters to use while loading entries into the server
protected java.io.File	ldif the LDIF file or directory containing LDIFs to load
protected java.lang.ClassLoader	loader the class loader to use if we cannot file the file as a path
private static org.slf4j.Logger	LOG the log for this class

Constructor Summary

Constructors

Constructor and Description
LdifFileLoader(CoreSession coreSession, java.io.File ldif, java.util.List<? extends LdifLoadFilter> filters) Creates a new instance of LdifFileLoader.
LdifFileLoader(CoreSession coreSession, java.io.File ldif, java.util.List<? extends LdifLoadFilter> filters, java.lang.ClassLoader loader) Creates a new instance of LdifFileLoader.
LdifFileLoader(CoreSession coreSession, java.lang.String ldif) Creates a new instance of LdifFileLoader.

Method Summary

Modifier and Type	Method and Description
private boolean	applyFilters(org.apache.directory.api.ldap.model.name.Dn dn, org.apache.directory.api.ldap.model.entry.Entry entry) Applies filters making sure failures in one filter do not effect another.
int	execute() Opens the LDIF file and loads the entries into the context.
private java.io.InputStream	getLdifStream() Tries to find an LDIF file either on the file system or packaged within a jar.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

the log for this class

coreSession

protected CoreSession coreSession

a handle on the top core session

ldif

protected java.io.File ldif

the LDIF file or directory containing LDIFs to load

filters

protected final java.util.List<LdifLoadFilter> filters

the filters to use while loading entries into the server

loader

protected final java.lang.ClassLoader loader

the class loader to use if we cannot file the file as a path

count

private int count

the total count of entries loaded

Constructor Detail

LdifFileLoader

public LdifFileLoader(CoreSession coreSession,
                      java.lang.String ldif)

Creates a new instance of LdifFileLoader.

Parameters:

coreSession - the context to load the entries into.

ldif - the file of LDIF entries to load.

LdifFileLoader

public LdifFileLoader(CoreSession coreSession,
                      java.io.File ldif,
                      java.util.List<? extends LdifLoadFilter> filters)

Creates a new instance of LdifFileLoader.

Parameters:

coreSession -

ldif -

filters -

LdifFileLoader

public LdifFileLoader(CoreSession coreSession,
                      java.io.File ldif,
                      java.util.List<? extends LdifLoadFilter> filters,
                      java.lang.ClassLoader loader)

Creates a new instance of LdifFileLoader.

Parameters:

coreSession -

ldif -

filters -

loader -

Method Detail

applyFilters

private boolean applyFilters(org.apache.directory.api.ldap.model.name.Dn dn,
                             org.apache.directory.api.ldap.model.entry.Entry entry)

Applies filters making sure failures in one filter do not effect another.

Parameters:

dn - the Dn of the entry

entry - the attributes of the entry

Returns:

true if all filters passed the entry, false otherwise

execute

public int execute()

Opens the LDIF file and loads the entries into the context.

Returns:

The count of entries created.

getLdifStream

private java.io.InputStream getLdifStream()
                                   throws java.io.FileNotFoundException

Tries to find an LDIF file either on the file system or packaged within a jar.

Returns:

the input stream to the ldif file.

Throws:

java.io.FileNotFoundException - if the file cannot be found.