com.unboundid.ldap.sdk.unboundidds.tools

Class LDAPCompare

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.util.LDAPCommandLineTool

com.unboundid.ldap.sdk.unboundidds.tools.LDAPCompare

All Implemented Interfaces:

UnsolicitedNotificationHandler

@ThreadSafety(level=NOT_THREADSAFE)
public final class LDAPCompare
extends LDAPCommandLineTool
implements UnsolicitedNotificationHandler

This class provide an LDAP command-line tool that may be used to perform compare operations in an LDAP directory 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.

Constructor Summary

Constructors

Constructor and Description
LDAPCompare(java.io.OutputStream out, java.io.OutputStream err) Creates a new instance of this tool with the provided output and error streams.

Method Summary

Modifier and Type	Method and 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.
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.
int	getMaxTrailingArguments() Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool.
int	getMinTrailingArguments() Retrieves the minimum number of unnamed trailing arguments that must be provided for this tool.
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.
java.lang.String	getTrailingArgumentsPlaceholder() Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.
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) Invokes this tool with the provided set of arguments, and using the provided streams for standard output and error.
static void	main(java.lang.String... args) Invokes this tool with the provided set of arguments.
protected boolean	supportsAuthentication() Indicates whether this tool should provide the arguments that allow it to bind via simple or SASL authentication.
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, doShutdownHookProcessing, err, getErr, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, 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

LDAPCompare

public LDAPCompare(@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 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 Detail

main

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

Invokes this tool with the provided set of arguments. The default standard output and error streams will be used.

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)

Invokes this tool with the provided set of arguments, and using the provided streams for standard output and error.

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 command-line arguments provided to this program.

Returns:

The result code obtained when running the tool. Any result code other than ResultCode.SUCCESS indicates an error.

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.

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

getMinTrailingArguments

public int getMinTrailingArguments()

Retrieves the minimum number of unnamed trailing arguments that must be provided for this tool. If a tool requires the use of trailing arguments, then it must override this method and the CommandLineTool.getMaxTrailingArguments() arguments to return nonzero values, and it must also override the CommandLineTool.getTrailingArgumentsPlaceholder() method to return a non-null value.

Overrides:

getMinTrailingArguments in class CommandLineTool

Returns:

The minimum number of unnamed trailing arguments that may be provided for this tool. A value of zero indicates that the tool may be invoked without any trailing arguments.

getMaxTrailingArguments

public int getMaxTrailingArguments()

Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool. If a tool supports trailing arguments, then it must override this method to return a nonzero value, and must also override the CommandLineTool.getTrailingArgumentsPlaceholder() method to return a non-null value.

Overrides:

getMaxTrailingArguments in class CommandLineTool

Returns:

The maximum number of unnamed trailing arguments that may be provided for this tool. A value of zero indicates that trailing arguments are not allowed. A negative value indicates that there should be no limit on the number of trailing arguments.

getTrailingArgumentsPlaceholder

@NotNull
public java.lang.String getTrailingArgumentsPlaceholder()

Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.

Overrides:

getTrailingArgumentsPlaceholder in class CommandLineTool

Returns:

A placeholder string that should be used for trailing arguments in the usage information for this tool, or null if trailing arguments are not supported.

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.

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

Returns:

true if this tool should provide the arguments that allow it to bind via simple or SASL authentication, or false 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 class LDAPCommandLineTool

Returns:

true if this tool should default to interactively prompting for the bind password, or false 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 class LDAPCommandLineTool

Returns:

true if this tool should provide a "--help-sasl" argument, or false 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 class LDAPCommandLineTool

Returns:

true if this tool should provide multiple versions of long identifiers for LDAP-specific arguments, or false 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 class LDAPCommandLineTool

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

Returns:

true if this tool supports creating connections to multiple servers, or false 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 returns true, then an "--enableSSLDebugging" argument will be added that sets the "javax.net.debug" system property to "all" before attempting any communication.

Overrides:

supportsSSLDebugging in class LDAPCommandLineTool

Returns:

true if this tool should offer an "--enableSSLDebugging" argument, or false 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 class LDAPCommandLineTool

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 return true for tools that may alter the server configuration, data, or other state information, and false for tools that do not make any changes.

Overrides:

logToolInvocationByDefault in class CommandLineTool

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, or false 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 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.

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

Parameters:

parser - The argument parser to which the arguments should be added.

Throws:

ArgumentException - If a problem occurs while adding the arguments.

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.

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 interface UnsolicitedNotificationHandler

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