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 Summary
Constructors Constructor Description LDIFModify(java.io.OutputStream out, java.io.OutputStream err)
Creates a new instance of this tool with the provided output and error streams.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addToolArguments(ArgumentParser parser)
Adds the command-line arguments supported for use with this tool to the provided argument parser.boolean
defaultsToInteractiveMode()
Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments.ResultCode
doToolProcessing()
Performs the core set of processing for this tool.java.util.List<java.lang.String>
getAdditionalDescriptionParagraphs()
Retrieves additional paragraphs that should be included in the description for this tool.java.util.LinkedHashMap<java.lang.String[],java.lang.String>
getExampleUsages()
Retrieves a set of information that may be used to generate example usage information.protected java.lang.String
getToolCompletionMessage()
Retrieves an optional message that may provide additional information about the way that the tool completed its processing.java.lang.String
getToolDescription()
Retrieves a human-readable description for this tool.java.lang.String
getToolName()
Retrieves the name of this tool.java.lang.String
getToolVersion()
Retrieves a version string for this tool, if available.static boolean
main(LDIFReader sourceReader, LDIFReader changesReader, LDIFWriter targetWriter, java.util.List<java.lang.String> errorMessages)
Invokes this tool with the provided readers and writer.static ResultCode
main(java.io.OutputStream out, java.io.OutputStream err, java.lang.String... args)
Invokes this tool with the provided set of command-line arguments, using the given output and error streams.static void
main(java.lang.String... args)
Invokes this tool with the provided set of command-line arguments.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.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.-
Methods inherited from class com.unboundid.util.CommandLineTool
addEnableSSLDebuggingArgument, createArgumentParser, doExtendedArgumentValidation, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getTrailingArgumentsPlaceholder, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, supportsOutputFile, wrapErr, wrapOut
-
-
-
-
Constructor Detail
-
LDIFModify
public LDIFModify(@Nullable java.io.OutputStream out, @Nullable java.io.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 benull
if standard output should be suppressed.err
- The output stream to use for standard error. It may benull
if standard error should be suppressed.
-
-
Method Detail
-
main
public static void main(@NotNull java.lang.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 benull
.
-
main
@NotNull public static ResultCode main(@Nullable java.io.OutputStream out, @Nullable java.io.OutputStream err, @NotNull java.lang.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 benull
if standard output should be suppressed.err
- The output stream to use for standard error. It may benull
if standard error should be suppressed.args
- The set of arguments provided to this tool. It may be empty but must not benull
.- 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 java.util.List<java.lang.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 benull
. 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 benull
. 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 benull
. 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 benull
and must be updatable.- Returns:
true
if processing completed successfully, orfalse
if one or more errors were encountered.
-
getToolName
@NotNull public java.lang.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 classCommandLineTool
- Returns:
- The name for this tool.
-
getToolDescription
@NotNull public java.lang.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 theCommandLineTool.getAdditionalDescriptionParagraphs()
method should be used to return the text for the subsequent paragraphs.- Specified by:
getToolDescription
in classCommandLineTool
- Returns:
- A human-readable description for this tool.
-
getAdditionalDescriptionParagraphs
@NotNull public java.util.List<java.lang.String> getAdditionalDescriptionParagraphs()
Retrieves additional paragraphs that should be included in the description for this tool. If the tool description should include multiple paragraphs, then theCommandLineTool.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 returnnull
or an empty list.- Overrides:
getAdditionalDescriptionParagraphs
in classCommandLineTool
- 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 thegetToolDescription
method) is needed.
-
getToolVersion
@NotNull public java.lang.String getToolVersion()
Retrieves a version string for this tool, if available.- Overrides:
getToolVersion
in classCommandLineTool
- 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 andCommandLineTool.defaultsToInteractiveMode()
returnstrue
, then interactive mode may be invoked by simply launching the tool without any arguments.- Overrides:
supportsInteractiveMode
in classCommandLineTool
- Returns:
true
if this tool supports interactive mode, orfalse
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 ifCommandLineTool.supportsInteractiveMode()
returnstrue
.- Overrides:
defaultsToInteractiveMode
in classCommandLineTool
- Returns:
true
if this tool defaults to using interactive mode if launched without any command-line arguments, orfalse
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 classCommandLineTool
- 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, orfalse
if not.
-
getToolCompletionMessage
@Nullable protected java.lang.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 classCommandLineTool
- 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 classCommandLineTool
- 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.
-
doToolProcessing
@NotNull public ResultCode doToolProcessing()
Performs the core set of processing for this tool.- Specified by:
doToolProcessing
in classCommandLineTool
- Returns:
- A result code that indicates whether the processing completed successfully.
-
getExampleUsages
@NotNull public java.util.LinkedHashMap<java.lang.String[],java.lang.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 classCommandLineTool
- 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.
-
-