Class ParallelUpdate
- java.lang.Object
-
- com.unboundid.util.CommandLineTool
-
- com.unboundid.util.LDAPCommandLineTool
-
- com.unboundid.ldap.sdk.unboundidds.tools.ParallelUpdate
-
- All Implemented Interfaces:
UnsolicitedNotificationHandler
@ThreadSafety(level=NOT_THREADSAFE) public final class ParallelUpdate extends LDAPCommandLineTool implements UnsolicitedNotificationHandler
This class provides a command-line tool that can be used to read change records for add, delete, modify and modify DN operations from an LDIF file, and then apply them in parallel using multiple threads for higher throughput.
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.
Changes in the LDIF file to be processed should be ordered such that if there are any dependencies between changes, prerequisite changes come before the changes that depend on them (for example, if one add change record creates a parent entry and another creates a child entry, the add change record that creates the parent entry must come before the one that creates the child entry). When this tool is preparing to process a change, it will determine whether the new change depends on any other changes that are currently in progress, and if so, will delay processing that change until its dependencies have been satisfied. If a change does not depend on any other changes that are currently being processed, then it can be processed in parallel with those changes.
The tool will keep track of any changes that fail in a way that indicates they succeed if re-tried later (for example, an attempt to add an entry that fails because its parent does not exist, but its parent may be created later in the set of LDIF changes), and can optionally re-try those changes after processing is complete. Any changes that are not retried, as well as changes that still fail after the retry attempts, will be written to a rejects file with information about the reason for the failure so that an administrator can take any necessary further action upon them.
-
-
Constructor Summary
Constructors Constructor Description ParallelUpdate(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
addNonLDAPArguments(ArgumentParser parser)
Adds the arguments needed by this command-line tool to the provided argument parser which are not related to connecting or authenticating to the directory server.boolean
defaultsToInteractiveMode()
Indicates whether this tool defaults to launching in interactive mode if the tool is invoked without any command-line arguments.protected boolean
defaultToPromptForBindPassword()
Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.protected void
doShutdownHookProcessing(ResultCode resultCode)
Performs any processing that may be needed when the JVM is shutting down, whether because tool processing has completed or because it has been interrupted (e.g., by a kill or break signal).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.protected java.util.List<Control>
getBindControls()
Retrieves a set of controls that should be included in any bind request generated by this tool.LDAPConnectionOptions
getConnectionOptions()
Retrieves the connection options that should be used for connections that are created with this command line 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.long
getInitialAttemptCount()
Retrieves the number of operations attempted on the initial pass through the LDIF file (that is, operations for which no retry attempts was made).long
getInitialSuccessCount()
Retrieves the number of operations that completed successfully on their first attempt.long
getRejectCount()
Retrieves the number of operations that were rejected and did not complete successfully during any of the attempts.long
getRetryAttemptCount()
Retrieves the number of retry attempts made for operations that did not complete successfully on their first attempt.long
getRetrySuccessCount()
Retrieves the number of operations that did not complete completed successfully on their initial attempt but did succeed on a retry attempt.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.long
getTotalAttemptCount()
Retrieves the total number of operations attempted.long
getTotalOpDurationMillis()
Retrieves the total length of time, in milliseconds, spent processing operations.long
getTotalSuccessCount()
Retrieves the total number of operations that completed successfully.void
handleUnsolicitedNotification(LDAPConnection connection, ExtendedResult notification)
Performs any processing that may be necessary in response to the provided unsolicited notification that has been received from the server.protected boolean
includeAlternateLongIdentifiers()
Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.protected boolean
logToolInvocationByDefault()
Indicates whether to log messages about the launch and completion of this tool into the invocation log of Ping Identity server products that may include it.static ResultCode
main(java.io.OutputStream out, java.io.OutputStream err, java.lang.String... args)
Parses the provided set of command-line arguments and then performs the necessary processing.static void
main(java.lang.String... args)
Parses the provided set of command-line arguments and then performs the necessary processing.protected boolean
registerShutdownHook()
Indicates whether this tool should register a shutdown hook with the JVM.protected boolean
supportsAuthentication()
Indicates whether this tool should provide the arguments that allow it to bind via simple or SASL authentication.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.protected boolean
supportsMultipleServers()
Indicates whether this tool supports creating connections to multiple servers.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.protected boolean
supportsSASLHelp()
Indicates whether this tool should provide a "--help-sasl" argument that provides information about the supported SASL mechanisms and their associated properties.protected boolean
supportsSSLDebugging()
Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging.-
Methods inherited from class com.unboundid.util.LDAPCommandLineTool
addToolArguments, anyLDAPArgumentsProvided, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getConnection, getConnectionOptionsWithRequestedSettings, getConnectionPool, getConnectionPool, getSuppressedShortIdentifiers, getUnauthenticatedConnection
-
Methods inherited from class com.unboundid.util.CommandLineTool
addEnableSSLDebuggingArgument, createArgumentParser, err, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getTrailingArgumentsPlaceholder, out, requestToolArgumentsInteractively, runTool, supportsOutputFile, wrapErr, wrapOut
-
-
-
-
Constructor Detail
-
ParallelUpdate
public ParallelUpdate(@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 which standard output should be written. It may benull
if standard output should be suppressed.err
- The output stream to which standard error should be written. It may benull
if standard error should be suppressed.
-
-
Method Detail
-
main
public static void main(@NotNull java.lang.String... args)
Parses the provided set of command-line arguments and then performs the necessary processing.- Parameters:
args
- The command-line arguments provided to this program.
-
main
@NotNull public static ResultCode main(@Nullable java.io.OutputStream out, @Nullable java.io.OutputStream err, @NotNull java.lang.String... args)
Parses the provided set of command-line arguments and then performs the necessary processing.- Parameters:
out
- The output stream to which standard output should be written. It may benull
if standard output should be suppressed.err
- The output stream to which standard error should be written. It may benull
if standard error should be suppressed.args
- The command-line arguments provided to this program.- Returns:
- Zero if all processing completed successfully, or nonzero if 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 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.
-
addNonLDAPArguments
public void addNonLDAPArguments(@NotNull ArgumentParser parser) throws ArgumentException
Adds the arguments needed by this command-line tool to the provided argument parser which are not related to connecting or authenticating to the directory server.- Specified by:
addNonLDAPArguments
in classLDAPCommandLineTool
- Parameters:
parser
- The argument parser to which the arguments should be added.- Throws:
ArgumentException
- If a problem occurs while adding the arguments.
-
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.
-
supportsDebugLogging
protected boolean supportsDebugLogging()
Indicates whether this tool supports the ability to generate a debug log file. If this method returnstrue
, then the tool will expose additional arguments that can control debug logging.- Overrides:
supportsDebugLogging
in classCommandLineTool
- Returns:
true
if this tool supports the ability to generate a debug log file, orfalse
if not.
-
supportsAuthentication
protected boolean supportsAuthentication()
Indicates whether this tool should provide the arguments that allow it to bind via simple or SASL authentication.- Overrides:
supportsAuthentication
in classLDAPCommandLineTool
- Returns:
true
if this tool should provide the arguments that allow it to bind via simple or SASL authentication, orfalse
if not.
-
defaultToPromptForBindPassword
protected boolean defaultToPromptForBindPassword()
Indicates whether this tool should default to interactively prompting for the bind password if a password is required but no argument was provided to indicate how to get the password.- Overrides:
defaultToPromptForBindPassword
in classLDAPCommandLineTool
- Returns:
true
if this tool should default to interactively prompting for the bind password, orfalse
if not.
-
supportsSASLHelp
protected boolean supportsSASLHelp()
Indicates whether this tool should provide a "--help-sasl" argument that provides information about the supported SASL mechanisms and their associated properties.- Overrides:
supportsSASLHelp
in classLDAPCommandLineTool
- Returns:
true
if this tool should provide a "--help-sasl" argument, orfalse
if not.
-
includeAlternateLongIdentifiers
protected boolean includeAlternateLongIdentifiers()
Indicates whether the LDAP-specific arguments should include alternate versions of all long identifiers that consist of multiple words so that they are available in both camelCase and dash-separated versions.- Overrides:
includeAlternateLongIdentifiers
in classLDAPCommandLineTool
- Returns:
true
if this tool should provide multiple versions of long identifiers for LDAP-specific arguments, orfalse
if not.
-
getBindControls
@NotNull protected java.util.List<Control> getBindControls()
Retrieves a set of controls that should be included in any bind request generated by this tool.- Overrides:
getBindControls
in classLDAPCommandLineTool
- Returns:
- A set of controls that should be included in any bind request
generated by this tool. It may be
null
or empty if no controls should be included in the bind request.
-
supportsMultipleServers
protected boolean supportsMultipleServers()
Indicates whether this tool supports creating connections to multiple servers. If it is to support multiple servers, then the "--hostname" and "--port" arguments will be allowed to be provided multiple times, and will be required to be provided the same number of times. The same type of communication security and bind credentials will be used for all servers.- Overrides:
supportsMultipleServers
in classLDAPCommandLineTool
- Returns:
true
if this tool supports creating connections to multiple servers, orfalse
if not.
-
supportsSSLDebugging
protected boolean supportsSSLDebugging()
Indicates whether this tool should provide a command-line argument that allows for low-level SSL debugging. If this returnstrue
, then an "--enableSSLDebugging" argument will be added that sets the "javax.net.debug" system property to "all" before attempting any communication.- Overrides:
supportsSSLDebugging
in classLDAPCommandLineTool
- Returns:
true
if this tool should offer an "--enableSSLDebugging" argument, orfalse
if not.
-
getConnectionOptions
@NotNull public LDAPConnectionOptions getConnectionOptions()
Retrieves the connection options that should be used for connections that are created with this command line tool. Subclasses may override this method to use a custom set of connection options.- Overrides:
getConnectionOptions
in classLDAPCommandLineTool
- Returns:
- The connection options that should be used for connections that are created with this command line tool.
-
logToolInvocationByDefault
protected boolean logToolInvocationByDefault()
Indicates whether to log messages about the launch and completion of this tool into the invocation log of Ping Identity server products that may include it. This method is not needed for tools that are not expected to be part of the Ping Identity server products suite. Further, this value may be overridden by settings in the server's tool-invocation-logging.properties file.
This method should generally returntrue
for tools that may alter the server configuration, data, or other state information, andfalse
for tools that do not make any changes.- Overrides:
logToolInvocationByDefault
in classCommandLineTool
- Returns:
true
if Ping Identity server products should include messages about the launch and completion of this tool in tool invocation log files by default, orfalse
if not.
-
getToolCompletionMessage
@Nullable public 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.
-
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.
-
getTotalAttemptCount
public long getTotalAttemptCount()
Retrieves the total number of operations attempted. This should only be called after all tool processing has completed.- Returns:
- The total number of operations attempted.
-
getInitialAttemptCount
public long getInitialAttemptCount()
Retrieves the number of operations attempted on the initial pass through the LDIF file (that is, operations for which no retry attempts was made). This should only be called after all tool processing has completed.- Returns:
- The number of operations attempted on the initial pass through the LDIF file.
-
getRetryAttemptCount
public long getRetryAttemptCount()
Retrieves the number of retry attempts made for operations that did not complete successfully on their first attempt. This should only be called after all tool processing has completed.- Returns:
- The number of retry attempts made for operations that did not complete successfully on their first attempt.
-
getTotalSuccessCount
public long getTotalSuccessCount()
Retrieves the total number of operations that completed successfully. This should only be called after all tool processing has completed.- Returns:
- The total number of operations that completed successfully.
-
getInitialSuccessCount
public long getInitialSuccessCount()
Retrieves the number of operations that completed successfully on their first attempt. This should only be called after all tool processing has completed.- Returns:
- The total number of operations that completed successfully on their first attempt.
-
getRetrySuccessCount
public long getRetrySuccessCount()
Retrieves the number of operations that did not complete completed successfully on their initial attempt but did succeed on a retry attempt. This should only be called after all tool processing has completed.- Returns:
- The number of operations that completed successfully on a retry attempt.
-
getRejectCount
public long getRejectCount()
Retrieves the number of operations that were rejected and did not complete successfully during any of the attempts. This should only be called after all tool processing has completed.- Returns:
- The number of operations that were rejected.
-
getTotalOpDurationMillis
public long getTotalOpDurationMillis()
Retrieves the total length of time, in milliseconds, spent processing operations. This should only be called after all tool processing has completed. Note that when running with multiple threads, this can exceed the length of time spent running the tool because multiple operations can be processed in parallel.- Returns:
- The total length of time, in milliseconds, spent processing operations.
-
registerShutdownHook
protected boolean registerShutdownHook()
Indicates whether this tool should register a shutdown hook with the JVM. Shutdown hooks allow for a best-effort attempt to perform a specified set of processing when the JVM is shutting down under various conditions, including:- When all non-daemon threads have stopped running (i.e., the tool has completed processing).
- When
System.exit()
orRuntime.exit()
is called. - When the JVM receives an external kill signal (e.g., via the use of the kill tool or interrupting the JVM with Ctrl+C).
System.halt()
orRuntime.halt()
methods).
If this method is overridden to returntrue
, then theCommandLineTool.doShutdownHookProcessing(ResultCode)
method should also be overridden to contain the logic that will be invoked when the JVM is shutting down in a manner that calls shutdown hooks.- Overrides:
registerShutdownHook
in classCommandLineTool
- Returns:
true
if this tool should register a shutdown hook, orfalse
if not.
-
doShutdownHookProcessing
protected void doShutdownHookProcessing(@Nullable ResultCode resultCode)
Performs any processing that may be needed when the JVM is shutting down, whether because tool processing has completed or because it has been interrupted (e.g., by a kill or break signal).
Note that because shutdown hooks run at a delicate time in the life of the JVM, they should complete quickly and minimize access to external resources. See the documentation for thejava.lang.Runtime.addShutdownHook
method for recommendations and restrictions about writing shutdown hooks.- Overrides:
doShutdownHookProcessing
in classCommandLineTool
- Parameters:
resultCode
- The result code returned by the tool. It may benull
if the tool was interrupted before it completed processing.
-
handleUnsolicitedNotification
public void handleUnsolicitedNotification(@NotNull LDAPConnection connection, @NotNull ExtendedResult notification)
Performs any processing that may be necessary in response to the provided unsolicited notification that has been received from the server.- Specified by:
handleUnsolicitedNotification
in interfaceUnsolicitedNotificationHandler
- Parameters:
connection
- The connection on which the unsolicited notification was received.notification
- The unsolicited notification that has been received from the server.
-
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.
-
-