com.unboundid.ldap.sdk.examples
Class IdentifyUniqueAttributeConflicts

java.lang.Object
  extended by com.unboundid.util.CommandLineTool
      extended by com.unboundid.util.LDAPCommandLineTool
          extended by com.unboundid.ldap.sdk.examples.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:

See Also:
Serialized Form

Constructor Summary
IdentifyUniqueAttributeConflicts(java.io.OutputStream outStream, java.io.OutputStream errStream)
          Creates a new instance of this tool.
 
Method Summary
 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.
 ResultCode doToolProcessing()
          Performs the core set of processing for this tool.
 java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong> getConflictCounts()
          Retrieves a map that correlates the number of missing references found by attribute type.
 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 void main(java.lang.String... args)
          Parse the provided command line arguments and perform the appropriate processing.
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.
 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.
 void searchReferenceReturned(SearchResultReference searchReference)
          Indicates that the provided search result reference has been returned by the server and may be processed by this search result listener.
 
Methods inherited from class com.unboundid.util.LDAPCommandLineTool
addToolArguments, createBindRequest, createServerSet, createSSLUtil, createSSLUtil, doExtendedArgumentValidation, doExtendedNonLDAPArgumentValidation, getBindControls, getConnection, getConnectionOptions, getConnectionPool, getUnauthenticatedConnection, supportsAuthentication, supportsMultipleServers
 
Methods inherited from class com.unboundid.util.CommandLineTool
createArgumentParser, doShutdownHookProcessing, err, getErr, getMaxTrailingArguments, getOut, getTrailingArgumentsPlaceholder, out, registerShutdownHook, runTool, wrapErr, wrapOut
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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.

getToolDescription

public java.lang.String getToolDescription()
Retrieves a human-readable description for this tool.

Specified by:
getToolDescription in class CommandLineTool
Returns:
A human-readable description 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.

addNonLDAPArguments

public void addNonLDAPArguments(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

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.

getConflictCounts

public java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong> getConflictCounts()
Retrieves a map that correlates the number of missing references found by attribute type.

Returns:
A map that correlates the number of missing references 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.

searchReferenceReturned

public void searchReferenceReturned(SearchResultReference searchReference)
Indicates that the provided search result reference has been returned by the server and may be processed by this search result listener.

Specified by:
searchReferenceReturned in interface SearchResultListener
Parameters:
searchReference - The search result reference that has been returned by the server.