Class TransformLDIF
- java.lang.Object
-
- com.unboundid.util.CommandLineTool
-
- com.unboundid.ldap.sdk.transformations.TransformLDIF
-
- All Implemented Interfaces:
LDIFReaderEntryTranslator
@ThreadSafety(level=NOT_THREADSAFE) public final class TransformLDIF extends CommandLineTool implements LDIFReaderEntryTranslator
This class provides a command-line tool that can be used to apply a number of transformations to an LDIF file. The transformations that can be applied include:- It can scramble the values of a specified set of attributes in a manner that attempts to preserve the syntax and consistently scrambles the same value to the same representation.
- It can strip a specified set of attributes out of entries.
- It can redact the values of a specified set of attributes, to indicate that the values are there but providing no information about what their values are.
- It can replace the values of a specified attribute with a given set of values.
- It can add an attribute with a given set of values to any entry that does not contain that attribute.
- It can replace the values of a specified attribute with a value that contains a sequentially-incrementing counter.
- It can strip entries matching a given base DN, scope, and filter out of the LDIF file.
- It can perform DN mapping, so that entries that exist below one base DN are moved below a different base DN.
- It can perform attribute mapping, to replace uses of one attribute name with another.
-
-
Constructor Summary
Constructors Constructor Description TransformLDIF(java.io.OutputStream out, java.io.OutputStream err)
Creates a new instance of this tool with the provided information.
-
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.void
doExtendedArgumentValidation()
Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid.ResultCode
doToolProcessing()
Performs the core set of processing 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.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 ResultCode
main(java.io.OutputStream out, java.io.OutputStream err, java.lang.String... args)
Invokes this tool with the provided set of arguments.static void
main(java.lang.String... args)
Invokes this tool with the provided set of 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.Entry
translate(Entry original, long firstLineNumber)
Applies some special transformation or filtering to the original Entry.-
Methods inherited from class com.unboundid.util.CommandLineTool
addEnableSSLDebuggingArgument, createArgumentParser, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getToolCompletionMessage, getTrailingArgumentsPlaceholder, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, supportsOutputFile, wrapErr, wrapOut
-
-
-
-
Constructor Detail
-
TransformLDIF
public TransformLDIF(java.io.OutputStream out, java.io.OutputStream err)
Creates a new instance of this tool with the provided information.- 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(java.lang.String... args)
Invokes this tool with the provided set of arguments.- Parameters:
args
- The command-line arguments provided to this program.
-
main
public static ResultCode main(java.io.OutputStream out, java.io.OutputStream err, java.lang.String... args)
Invokes this tool with the provided set of arguments.- 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 command-line arguments provided to this program.- Returns:
- A result code indicating whether processing completed successfully.
-
getToolName
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
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.
-
getToolVersion
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.
-
addToolArguments
public void addToolArguments(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.
-
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 theCommandLineTool.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 classCommandLineTool
- Throws:
ArgumentException
- If there was a problem with the command-line arguments provided to this program.
-
doToolProcessing
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
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.
-
translate
public Entry translate(Entry original, long firstLineNumber) throws LDIFException
Applies some special transformation or filtering to the original Entry.- Specified by:
translate
in interfaceLDIFReaderEntryTranslator
- Parameters:
original
- The original Entry that was read and parsed from the input file.firstLineNumber
- The first line number of the LDIF record corresponding to the read Entry. This is most useful when throwing an LDIFException.- Returns:
- The Entry that should be returned in the call to
LDIFReader.readEntry()
. This can be the original parameter Entry, a newly constructed Entry, ornull
to signal that the provided Entry should be skipped. - Throws:
LDIFException
- If there is an exception during processing. This exception will be re-thrown to the caller of readEntry.
-
-