com.unboundid.ldap.sdk.unboundidds.tools

Class SplitLDIF

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.ldap.sdk.unboundidds.tools.SplitLDIF

@ThreadSafety(level=NOT_THREADSAFE)
public final class SplitLDIF
extends CommandLineTool

This class provides a command-line tool that can be used to split an LDIF file below a specified base DN. This can be used to help initialize an entry-balancing deployment for use with the Directory Proxy Server.

NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

It supports a number of algorithms for determining how to split the data, including:

• split-using-hash-on-rdn -- The tool will compute a digest of the DN component that is immediately below the split base DN, and will use a modulus to select a backend set for a given entry. Since the split is based purely on computation involving the DN, the there is no need for caching to ensure that children are placed in the same sets as their parent, which allows it to run effectively with a small memory footprint.
• split-using-hash-on-attribute -- The tool will compute a digest of the value(s) of a specified attribute, and will use a modulus to select a backend set for a given entry. This hash will only be computed for entries immediately below the split base DN, and a cache will be used to ensure that entries more than one level below the split base DN are placed in the same backend set as their parent.
• split-using-fewest-entries -- When examining an entry immediately below the split base DN, the tool will place that entry in the set that has the fewest entries. For flat DITs in which entries only exist one level below the split base DN, this will effectively ensure a round-robin distribution. But for cases in which there are branches of varying sizes below the split base DN, this can help ensure that entries are more evenly distributed across backend sets. A cache will be used to ensure that entries more than one level below the split base DN are placed in the same backend set as their parent.
• split-using-filter -- When examining an entry immediately below the split base DN, a series of filters will be evaluated against that entry, which each filter associated with a specific backend set. If an entry doesn't match any of the provided filters, an RDN hash can be used to select the set. A cache will be used to ensure that entries more than one level below the split base DN are placed in the same backend set as their parent.

Constructor Summary

Constructors

Constructor and Description
SplitLDIF(java.io.OutputStream out, java.io.OutputStream err) Creates a new instance of this tool with the provided information.

Method Summary

Modifier and Type	Method and 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) Runs the tool with the provided set of command-line arguments.
static void	main(java.lang.String... args) Runs the tool with the provided set of command-line arguments.
protected boolean	supportsDebugLogging() Indicates whether this tool supports the ability to generate a debug log file.
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, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getToolCompletionMessage, getTrailingArgumentsPlaceholder, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, supportsOutputFile, wrapErr, wrapOut

Methods inherited from class java.lang.Object

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

Constructor Detail

SplitLDIF

public SplitLDIF(@Nullable
                 java.io.OutputStream out,
                 @Nullable
                 java.io.OutputStream err)

Creates a new instance of this tool with the provided information.

Parameters:

out - The output stream used for standard output. It may be null if standard output should be suppressed.

err - The output stream used for standard error. It may be null if standard error should be suppressed.

Method Detail

main

public static void main(@NotNull
                        java.lang.String... args)

Runs the tool with the provided set of command-line arguments.

Parameters:

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

main

@NotNull
public static ResultCode main(@Nullable
                                       java.io.OutputStream out,
                                       @Nullable
                                       java.io.OutputStream err,
                                       @NotNull
                                       java.lang.String... args)

Runs the tool with the provided set of command-line arguments.

Parameters:

out - The output stream used for standard output. It may be null if standard output should be suppressed.

err - The output stream used for standard error. It may be null if standard error should be suppressed.

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

Returns:

A result code with information about the processing performed. Any result code other than ResultCode.SUCCESS indicates that an error occurred.

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 class CommandLineTool

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 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.

getToolVersion

@NotNull
public java.lang.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.

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 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 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.