|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.util.CommandLineTool
com.unboundid.util.LDAPCommandLineTool
com.unboundid.ldap.sdk.examples.IdentifyUniqueAttributeConflicts
@ThreadSafety(level=NOT_THREADSAFE) public final class IdentifyUniqueAttributeConflicts
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:
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 |
---|
public IdentifyUniqueAttributeConflicts(java.io.OutputStream outStream, java.io.OutputStream errStream)
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 |
---|
public static void main(java.lang.String... args)
args
- The command line arguments provided to this program.public static ResultCode main(java.lang.String[] args, java.io.OutputStream outStream, java.io.OutputStream errStream)
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.
public java.lang.String getToolName()
getToolName
in class CommandLineTool
public java.lang.String getToolDescription()
getToolDescription
in class CommandLineTool
public java.lang.String getToolVersion()
getToolVersion
in class CommandLineTool
null
if none is
available.public void addNonLDAPArguments(ArgumentParser parser) throws ArgumentException
addNonLDAPArguments
in class LDAPCommandLineTool
parser
- The argument parser to which the arguments should be added.
ArgumentException
- If a problem occurs while adding the arguments.public ResultCode doToolProcessing()
doToolProcessing
in class CommandLineTool
public java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong> getConflictCounts()
public java.util.LinkedHashMap<java.lang.String[],java.lang.String> getExampleUsages()
getExampleUsages
in class CommandLineTool
null
or empty if no example usage
information is available.public void searchEntryReturned(SearchResultEntry searchEntry)
searchEntryReturned
in interface SearchResultListener
searchEntry
- The search result entry that has been returned by the
server.public void searchReferenceReturned(SearchResultReference searchReference)
searchReferenceReturned
in interface SearchResultListener
searchReference
- The search result reference that has been returned
by the server.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |