org.opends.server.tools

Class ImportLdif

java.lang.Object

com.forgerock.opendj.cli.Tool

org.opends.server.tools.tasks.TaskTool

org.opends.server.tools.ImportLdif

All Implemented Interfaces:

Closeable, AutoCloseable, TaskScheduleInformation

public final class ImportLdif
extends TaskTool

This program provides a utility that may be used to import the contents of an LDIF file into a Directory Server backend. This will be a process that is intended to run separate from Directory Server and not internally within the server process (e.g., via the tasks interface).

Nested Class Summary

Nested classes/interfaces inherited from class com.forgerock.opendj.cli.Tool

com.forgerock.opendj.cli.Tool.Style

Field Summary

Fields inherited from class org.opends.server.tools.tasks.TaskTool

canInitializeServer, NOW, OPTION_LONG_COMPRESS, OPTION_LONG_TMP_DIRECTORY, OPTION_SHORT_BACKEND_ID, OPTION_SHORT_COMPRESS

Method Summary

Modifier and Type	Method and Description
void	addTaskAttributes(Entry taskEntry) Adds utility specific attributes to the provided task entry that is added to the task backend.
protected void	cleanup() Cleanup task environment after offline run.
Class<?>	getTaskClass() Gets the Class that implements the utility to execute.
String	getTaskId() Gets an arbitrary task id assigned to this task.
String	getTaskObjectclass() Gets the objectclass used to represent scheduled instances of this utility in the task backend.
static void	importLdifEmbeddedOffline(com.forgerock.opendj.cli.ArgumentsBuilder arguments) This method is used for running the import-ldif tool programmatically against an offline server.
static void	importLdifEmbeddedOffline(com.forgerock.opendj.cli.ArgumentsBuilder arguments, OutputStream outStream, OutputStream errStream) This method is used for running the import-ldif tool programmatically against an offline server.
protected boolean	isEmbedded() Returns true if the tool is running in embedded mode.
boolean	isQuiet() Indicates whether the user has requested quiet output.
static void	main(String[] args) The main method for ImportLdif tool.
static int	mainImportLdif(String[] args, boolean canInitializeServer, OutputStream outStream, OutputStream errStream) Processes the command-line arguments and invokes the import process.
protected com.forgerock.opendj.cli.ReturnCode	processLocal() Called when this utility should perform its actions locally in this JVM.
protected com.forgerock.opendj.cli.ReturnCode	runTaskTool(String[] args) Runs the concrete tool implementation with the provided arguments.

Methods inherited from class org.opends.server.tools.tasks.TaskTool

addAttribute, addAttributeIfArgumentPresent, getArgumentParser, getDependencyIds, getFailedDependencyAction, getNotifyUponCompletionEmailAddresses, getNotifyUponErrorEmailAddresses, getRecurringDateTime, getStartDateTime, process, run, runEmbeddedOffline, runOffline, shutdownBackends, validateArguments, validateTaskArgs

Methods inherited from class com.forgerock.opendj.cli.Tool

askConfirmation, askPort, close, confirmAction, enableConsoleLoggingIfVerbose, errPrintln, errPrintln, errPrintln, errPrintlnSurroundedByBlankLines, errPrintVerboseMessage, flush, flushLogStream, getErrorStream, getErrStream, getInputStream, getOutputStream, isFullyInteractive, isScriptFriendly, isVerbose, logVerboseMessage, mayPrompt, parseArguments, pressReturnToContinue, print, println, println, println, println, printlnNoWrap, printlnSurroundedByBlankLines, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readPassword, readValidatedInput, readValidatedInput, report

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)

The main method for ImportLdif tool.

Parameters:

args - The command-line arguments provided to this program.

mainImportLdif

public static int mainImportLdif(String[] args,
                                 boolean canInitializeServer,
                                 OutputStream outStream,
                                 OutputStream errStream)

Processes the command-line arguments and invokes the import process.

Parameters:

args - The command-line arguments provided to this program.

canInitializeServer - true if the server can be initialized, false otherwise (basically, because this is executed in the context of a unit-test).

outStream - The output stream to use for standard output, or null if standard output is not needed.

errStream - The output stream to use for standard error, or null if standard error is not needed.

Returns:

The error code.

importLdifEmbeddedOffline

public static void importLdifEmbeddedOffline(com.forgerock.opendj.cli.ArgumentsBuilder arguments)
                                      throws com.forgerock.opendj.cli.ClientException

This method is used for running the import-ldif tool programmatically against an offline server.

The --offline and --noPropertyFile arguments are automatically added to the tool arguments.
Import offline implies that the DirectoryServer will be initialized.
No modification will be performed to the running JVM JDK logging configuration.

Parameters:

arguments - The command-line arguments provided to this program.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during the tool execution.

importLdifEmbeddedOffline

public static void importLdifEmbeddedOffline(com.forgerock.opendj.cli.ArgumentsBuilder arguments,
                                             OutputStream outStream,
                                             OutputStream errStream)
                                      throws com.forgerock.opendj.cli.ClientException

This method is used for running the import-ldif tool programmatically against an offline server.

The --offline and --noPropertyFile arguments are automatically added to the tool arguments.
Import offline implies that the DirectoryServer will be initialized.
No modification will be performed to the running JVM JDK logging configuration.

Parameters:

arguments - The command-line arguments provided to this program

outStream - The output stream to use for standard output, or null if standard output is not needed

errStream - The output stream to use for standard error, or null if standard error is not needed

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during the tool execution or if the tool has returned an error

isQuiet

public boolean isQuiet()

Description copied from class: com.forgerock.opendj.cli.Tool

Indicates whether the user has requested quiet output. The default implementation returns false.

Overrides:

isQuiet in class com.forgerock.opendj.cli.Tool

Returns:

true if the user has requested quiet output.

runTaskTool

protected com.forgerock.opendj.cli.ReturnCode runTaskTool(String[] args)
                                                   throws com.forgerock.opendj.cli.ClientException

Description copied from class: TaskTool

Runs the concrete tool implementation with the provided arguments.

Specified by:

runTaskTool in class TaskTool

Parameters:

args - The command line arguments.

Returns:

The ReturnCode returned by the tool execution.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during tool execution.

addTaskAttributes

public void addTaskAttributes(Entry taskEntry)

Description copied from interface: TaskScheduleInformation

Adds utility specific attributes to the provided task entry that is added to the task backend.

Parameters:

taskEntry - The task Entry to update.

getTaskObjectclass

public String getTaskObjectclass()

Description copied from interface: TaskScheduleInformation

Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Returns:

String representation of this utilities objectclass

getTaskClass

public Class<?> getTaskClass()

Description copied from interface: TaskScheduleInformation

Gets the Class that implements the utility to execute.

Returns:

class of the tasks implementation

processLocal

protected com.forgerock.opendj.cli.ReturnCode processLocal()
                                                    throws com.forgerock.opendj.cli.ClientException

Description copied from class: TaskTool

Called when this utility should perform its actions locally in this JVM.

Specified by:

processLocal in class TaskTool

Returns:

int indicating the result of this action

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool

cleanup

protected void cleanup()

Description copied from class: TaskTool

Cleanup task environment after offline run. Default implementation does nothing. Tasks which initialize some static part of the DirectoryServer instance (e.g admin data local backends) must override this method to shutdown all needed component to prevent JVM environment alteration.

Overrides:

cleanup in class TaskTool

getTaskId

public String getTaskId()

Description copied from interface: TaskScheduleInformation

Gets an arbitrary task id assigned to this task.

Returns:

assigned task id if any or null otherwise.

isEmbedded

protected boolean isEmbedded()

Description copied from class: TaskTool

Returns true if the tool is running in embedded mode.

Embedded mode would not change JDK logging configuration and will used running jvm slf4j loggers implementation

Overrides:

isEmbedded in class TaskTool

Returns:

true if the tool is running in embedded mode.