Package com.unboundid.ldap.sdk.examples

Class IdentifyUniqueAttributeConflicts

  • All Implemented Interfaces:
    SearchResultListener, java.io.Serializable
    @ThreadSafety(level=NOT_THREADSAFE)
public final class IdentifyUniqueAttributeConflicts
extends LDAPCommandLineTool
implements SearchResultListener
    This class provides a tool that may be used to identify unique attribute conflicts (i.e., attributes which are supposed to be unique but for which some values exist in multiple entries).

    All of the necessary information is provided using command line arguments. Supported arguments include those allowed by the LDAPCommandLineTool class, as well as the following additional arguments:
    • "-b {baseDN}" or "--baseDN {baseDN}" -- specifies the base DN to use for the searches. At least one base DN must be provided.
    • "-f" {filter}" or "--filter "{filter}" -- specifies an optional filter to use for identifying entries across which uniqueness should be enforced. If this is not provided, then all entries containing the target attribute(s) will be examined.
    • "-A {attribute}" or "--attribute {attribute}" -- specifies an attribute for which to enforce uniqueness. At least one unique attribute must be provided.
    • "-m {behavior}" or "--multipleAttributeBehavior {behavior}" -- specifies the behavior that the tool should exhibit if multiple unique attributes are provided. Allowed values include unique-within-each-attribute, unique-across-all-attributes-including-in-same-entry, unique-across-all-attributes-except-in-same-entry, and unique-in-combination.
    • "-z {size}" or "--simplePageSize {size}" -- indicates that the search to find entries with unique attributes should use the simple paged results control to iterate across entries in fixed-size pages rather than trying to use a single search to identify all entries containing unique attributes.
    See Also:
    Serialized Form

    • Constructor Detail

      • IdentifyUniqueAttributeConflicts

        public IdentifyUniqueAttributeConflicts​(java.io.OutputStream outStream,
                                        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​(java.lang.String... args)
        Parse the provided command line arguments and perform the appropriate processing.
        Parameters:
        args - The command line arguments provided to this program.

      • main

        public static ResultCode main​(java.lang.String[] args,
                              java.io.OutputStream outStream,
                              java.io.OutputStream errStream)
        Parse the provided command line arguments and perform the appropriate processing.
        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.

      • 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 class CommandLineTool
        Returns:
        The name for this tool.

      • getToolVersion

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

      • getConnectionOptions

        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.

      • getCombinationConflictCounts

        public long getCombinationConflictCounts()
        Retrieves the number of conflicts identified across multiple attributes in combination.
        Returns:
        The number of conflicts identified across multiple attributes in combination.

      • getConflictCounts

        public java.util.Map<java.lang.String,​java.util.concurrent.atomic.AtomicLong> getConflictCounts()
        Retrieves a map that correlates the number of uniqueness conflicts found by attribute type.
        Returns:
        A map that correlates the number of uniqueness conflicts found by attribute type.

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

      • searchEntryReturned

        public void searchEntryReturned​(SearchResultEntry searchEntry)
        Indicates that the provided search result entry has been returned by the server and may be processed by this search result listener.
        Specified by:
        searchEntryReturned in interface SearchResultListener
        Parameters:
        searchEntry - The search result entry that has been returned by the server.