Package com.unboundid.ldap.sdk.examples

Class LDAPCompare

  • All Implemented Interfaces:
    java.io.Serializable
    @ThreadSafety(level=NOT_THREADSAFE)
public final class LDAPCompare
extends LDAPCommandLineTool
implements java.io.Serializable
    This class provides a simple tool that can be used to perform compare operations in an LDAP directory server. All of the necessary information is provided using command line arguments. Supported arguments include those allowed by the LDAPCommandLineTool class. In addition, a set of at least two unnamed trailing arguments must be given. The first argument should be a string containing the name of the target attribute followed by a colon and the assertion value to use for that attribute (e.g., "cn:john doe"). Alternately, the attribute name may be followed by two colons and the base64-encoded representation of the assertion value (e.g., "cn:: am9obiBkb2U="). Any subsequent trailing arguments will be the DN(s) of entries in which to perform the compare operation(s).

    Some of the APIs demonstrated by this example include:
    • Argument Parsing (from the com.unboundid.util.args package)
    • LDAP Command-Line Tool (from the com.unboundid.util package)
    • LDAP Communication (from the com.unboundid.ldap.sdk package)
    See Also:
    Serialized Form

    • Constructor Detail

      • LDAPCompare

        public LDAPCompare​(@Nullable
                   java.io.OutputStream outStream,
                   @Nullable
                   java.io.OutputStream errStream)
        Creates a new instance of this tool.
        Parameters:
        outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.
        errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.

    • Method Detail

      • main

        public static void main​(@NotNull
                        java.lang.String[] args)
        Parse the provided command line arguments and make the appropriate set of changes.
        Parameters:
        args - The command line arguments provided to this program.

      • main

        @NotNull
public static ResultCode main​(@NotNull
                              java.lang.String[] args,
                              @Nullable
                              java.io.OutputStream outStream,
                              @Nullable
                              java.io.OutputStream errStream)
        Parse the provided command line arguments and make the appropriate set of changes.
        Parameters:
        args - The command line arguments provided to this program.
        outStream - The output stream to which standard out should be written. It may be null if output should be suppressed.
        errStream - The output stream to which standard error should be written. It may be null if error messages should be suppressed.
        Returns:
        A result code indicating whether the processing was successful.

      • getMinTrailingArguments

        public int getMinTrailingArguments()
        Retrieves the minimum number of unnamed trailing arguments that are required.
        Overrides:
        getMinTrailingArguments in class CommandLineTool
        Returns:
        Two, to indicate that at least two trailing arguments (representing the attribute value assertion and at least one entry DN) must be provided.

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

      • supportsOutputFile

        protected boolean supportsOutputFile()
        Indicates whether this tool should provide arguments for redirecting output to a file. If this method returns true, then the tool will offer an "--outputFile" argument that will specify the path to a file to which all standard output and standard error content will be written, and it will also offer a "--teeToStandardOut" argument that can only be used if the "--outputFile" argument is present and will cause all output to be written to both the specified output file and to standard output.
        Overrides:
        supportsOutputFile in class CommandLineTool
        Returns:
        true if this tool should provide arguments for redirecting output to a file, 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.

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

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

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

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

      • doToolProcessing

        @NotNull
public ResultCode doToolProcessing()
        Performs the actual processing for this tool. In this case, it gets a connection to the directory server and uses it to perform the requested comparisons.
        Specified by:
        doToolProcessing in class CommandLineTool
        Returns:
        The result code for the processing that was performed.

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