Package org.opends.server.tools

Class ImportLdif

  • All Implemented Interfaces:
    Closeable, AutoCloseable, TaskCommand
    public final class ImportLdif
extends com.forgerock.opendj.cli.Tool
implements TaskCommand
    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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addTaskAttributes​(Entry taskEntry)
      Adds attributes to the task entry before it is sent to the server.
      boolean canInitializeClient()
      Indicates whether to initialize a Directory Server client when running online.
      Class<? extends Task> getTaskClass()
      Returns the task class.
      String getTaskObjectClass()
      Returns the task's object class.
      static void importLdifEmbeddedOffline​(com.forgerock.opendj.cli.ArgumentsBuilder arguments, PrintStream outStream, PrintStream errStream)
      This method is used for running the import-ldif tool programmatically against an offline server.
      boolean isQuiet()
      Indicates whether the user has requested quiet output.
      static void main​(String[] args)
      The main method for ImportLdif tool.
      static com.forgerock.opendj.cli.ReturnCode mainImportLdif​(String[] args, ServerContext serverContext, PrintStream outStream, PrintStream errStream)
      Processes the command-line arguments and invokes the import process.
      com.forgerock.opendj.cli.ReturnCode processLocal()
      Runs the command in offline mode.
      com.forgerock.opendj.cli.ReturnCode run​(String... args)
      Run this Tool tool with the provided arguments.

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

        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, printlnNoWrap, printlnSurroundedByBlankLines, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readValidatedInput, readValidatedInputOrThrow, report

    • 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 com.forgerock.opendj.cli.ReturnCode mainImportLdif​(String[] args,
                                                                 ServerContext serverContext,
                                                                 PrintStream outStream,
                                                                 PrintStream errStream)
        Processes the command-line arguments and invokes the import process.
        Parameters:
        args - The command-line arguments provided to this program.
        serverContext - The server context, or null if the tool should initialize the server context itself.
        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 return code.

      • importLdifEmbeddedOffline

        public static void importLdifEmbeddedOffline​(com.forgerock.opendj.cli.ArgumentsBuilder arguments,
                                             PrintStream outStream,
                                             PrintStream 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.

      • run

        public com.forgerock.opendj.cli.ReturnCode run​(String... args)
                                        throws com.forgerock.opendj.cli.ClientException
        Description copied from class: com.forgerock.opendj.cli.Tool
        Run this Tool tool with the provided arguments. Output and errors will be written on the provided streams.

        This method can be used to run the tool programmatically.

        Overrides:
        run in class com.forgerock.opendj.cli.Tool
        Parameters:
        args - Arguments set to pass to the tool.
        Returns:
        The tool ReturnCode.
        Throws:
        com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.

      • addTaskAttributes

        public void addTaskAttributes​(Entry taskEntry)
        Description copied from interface: TaskCommand
        Adds attributes to the task entry before it is sent to the server.
        Specified by:
        addTaskAttributes in interface TaskCommand
        Parameters:
        taskEntry - the task entry.

      • canInitializeClient

        public boolean canInitializeClient()
        Description copied from interface: TaskCommand
        Indicates whether to initialize a Directory Server client when running online. This method should only return false when running tests while a client has already been initialized.
        Specified by:
        canInitializeClient in interface TaskCommand
        Returns:
        whether to initialize a Directory Server client when running online.

      • getTaskObjectClass

        public String getTaskObjectClass()
        Description copied from interface: TaskCommand
        Returns the task's object class.
        Specified by:
        getTaskObjectClass in interface TaskCommand
        Returns:
        the task's object class

      • processLocal

        public com.forgerock.opendj.cli.ReturnCode processLocal()
                                                 throws com.forgerock.opendj.cli.ClientException
        Description copied from interface: TaskCommand
        Runs the command in offline mode.
        Specified by:
        processLocal in interface TaskCommand
        Returns:
        the return code.
        Throws:
        com.forgerock.opendj.cli.ClientException - If an error occurs.