Package com.unboundid.ldif

Class LDIFModify

java.lang.Object
com.unboundid.util.CommandLineTool
com.unboundid.ldif.LDIFModify
@ThreadSafety(level=NOT_THREADSAFE) public final class LDIFModify extends CommandLineTool
This class provides a command-line tool that can be used to apply a set of changes to data in an LDIF file.

  • Constructor Details

    • LDIFModify

      public LDIFModify(@Nullable OutputStream out, @Nullable OutputStream err)
      Creates a new instance of this tool with the provided output and error streams.
      Parameters:
      out - The output stream to use for standard output. It may be null if standard output should be suppressed.
      err - The output stream to use for standard error. It may be null if standard error should be suppressed.

  • Method Details

    • main

      public static void main(@NotNull String... args)
      Invokes this tool with the provided set of command-line arguments.
      Parameters:
      args - The set of arguments provided to this tool. It may be empty but must not be null.

    • main

      @NotNull public static ResultCode main(@Nullable OutputStream out, @Nullable OutputStream err, @NotNull String... args)
      Invokes this tool with the provided set of command-line arguments, using the given output and error streams.
      Parameters:
      out - The output stream to use for standard output. It may be null if standard output should be suppressed.
      err - The output stream to use for standard error. It may be null if standard error should be suppressed.
      args - The set of arguments provided to this tool. It may be empty but must not be null.
      Returns:
      A result code indicating the status of processing. Any result code other than ResultCode.SUCCESS should be considered an error.

    • main

      public static boolean main(@NotNull LDIFReader sourceReader, @NotNull LDIFReader changesReader, @NotNull LDIFWriter targetWriter, @NotNull List<String> errorMessages)
      Invokes this tool with the provided readers and writer. This method is primarily intended for legacy backward compatibility with the Ping Identity Directory Server and does not provide access to all functionality offered by this tool.
      Parameters:
      sourceReader - An LDIF reader that may be used to read the entries to be updated. It must not be null. Note this the reader will be closed when the tool completes.
      changesReader - An LDIF reader that may be used to read the changes to apply. It must not be null. Note that this reader will be closed when the tool completes.
      targetWriter - An LDIF writer that may be used to write the updated entries. It must not be null. Note that this writer will be closed when the tool completes.
      errorMessages - A list that will be updated with any errors encountered during processing. It must not be null and must be updatable.
      Returns:
      true if processing completed successfully, or false if one or more errors were encountered.

    • getToolName

      @NotNull public String getToolName()
      Retrieves the name of this tool. It should be the name of the command used to invoke this tool.
      Specified by:
      getToolName in class CommandLineTool
      Returns:
      The name for this tool.

    • getToolDescription

      @NotNull public String getToolDescription()
      Retrieves a human-readable description for this tool. If the description should include multiple paragraphs, then this method should return the text for the first paragraph, and the CommandLineTool.getAdditionalDescriptionParagraphs() method should be used to return the text for the subsequent paragraphs.
      Specified by:
      getToolDescription in class CommandLineTool
      Returns:
      A human-readable description for this tool.

    • getAdditionalDescriptionParagraphs

      @NotNull public List<String> getAdditionalDescriptionParagraphs()
      Retrieves additional paragraphs that should be included in the description for this tool. If the tool description should include multiple paragraphs, then the CommandLineTool.getToolDescription() method should return the text of the first paragraph, and each item in the list returned by this method should be the text for each subsequent paragraph. If the tool description should only have a single paragraph, then this method may return null or an empty list.
      Overrides:
      getAdditionalDescriptionParagraphs in class CommandLineTool
      Returns:
      Additional paragraphs that should be included in the description for this tool, or null or an empty list if only a single description paragraph (whose text is returned by the getToolDescription method) is needed.

    • getToolVersion

      @NotNull public String getToolVersion()
      Retrieves a version string for this tool, if available.
      Overrides:
      getToolVersion in class CommandLineTool
      Returns:
      A version string for this tool, or null if none is available.

    • supportsInteractiveMode

      public boolean supportsInteractiveMode()
      Indicates whether this tool should provide support for an interactive mode, in which the tool offers a mode in which the arguments can be provided in a text-driven menu rather than requiring them to be given on the command line. If interactive mode is supported, it may be invoked using the "--interactive" argument. Alternately, if interactive mode is supported and CommandLineTool.defaultsToInteractiveMode() returns true, then interactive mode may be invoked by simply launching the tool without any arguments.
      Overrides:
      supportsInteractiveMode in class CommandLineTool
      Returns:
      true if this tool supports interactive mode, or false if not.

    • defaultsToInteractiveMode

      public boolean defaultsToInteractiveMode()
      Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments. This will only be used if CommandLineTool.supportsInteractiveMode() returns true.
      Overrides:
      defaultsToInteractiveMode in class CommandLineTool
      Returns:
      true if this tool defaults to using interactive mode if launched without any command-line arguments, or false if not.

    • supportsPropertiesFile

      public boolean supportsPropertiesFile()
      Indicates whether this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line.
      Overrides:
      supportsPropertiesFile in class CommandLineTool
      Returns:
      true if this tool supports the use of a properties file for specifying default values for arguments that aren't specified on the command line, or false if not.

    • supportsDebugLogging

      protected boolean supportsDebugLogging()
      Indicates whether this tool supports the ability to generate a debug log file. If this method returns true, then the tool will expose additional arguments that can control debug logging.
      Overrides:
      supportsDebugLogging in class CommandLineTool
      Returns:
      true if this tool supports the ability to generate a debug log file, or false if not.

    • getToolCompletionMessage

      @Nullable protected String getToolCompletionMessage()
      Retrieves an optional message that may provide additional information about the way that the tool completed its processing. For example if the tool exited with an error message, it may be useful for this method to return that error message.

      The message returned by this method is intended for informational purposes and is not meant to be parsed or programmatically interpreted.
      Overrides:
      getToolCompletionMessage in class CommandLineTool
      Returns:
      An optional message that may provide additional information about the completion state for this tool, or null if no completion message is available.

    • addToolArguments

      public void addToolArguments(@NotNull ArgumentParser parser) throws ArgumentException
      Adds the command-line arguments supported for use with this tool to the provided argument parser. The tool may need to retain references to the arguments (and/or the argument parser, if trailing arguments are allowed) to it in order to obtain their values for use in later processing.
      Specified by:
      addToolArguments in class CommandLineTool
      Parameters:
      parser - The argument parser to which the arguments are to be added.
      Throws:
      ArgumentException - If a problem occurs while adding any of the tool-specific arguments to the provided argument parser.

    • doExtendedArgumentValidation

      public void doExtendedArgumentValidation() throws ArgumentException
      Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid. This method will be called after the basic argument parsing has been performed and immediately before the CommandLineTool.doToolProcessing() method is invoked. Note that if the tool supports interactive mode, then this method may be invoked multiple times to allow the user to interactively fix validation errors.
      Overrides:
      doExtendedArgumentValidation in class CommandLineTool
      Throws:
      ArgumentException - If there was a problem with the command-line arguments provided to this program.

    • doToolProcessing

      @NotNull public ResultCode doToolProcessing()
      Performs the core set of processing for this tool.
      Specified by:
      doToolProcessing in class CommandLineTool
      Returns:
      A result code that indicates whether the processing completed successfully.

    • getExampleUsages

      @NotNull public LinkedHashMap<String[],String> getExampleUsages()
      Retrieves a set of information that may be used to generate example usage information. Each element in the returned map should consist of a map between an example set of arguments and a string that describes the behavior of the tool when invoked with that set of arguments.
      Overrides:
      getExampleUsages in class CommandLineTool
      Returns:
      A set of information that may be used to generate example usage information. It may be null or empty if no example usage information is available.