com.unboundid.ldap.sdk.examples

Class IdentifyReferencesToMissingEntries

java.lang.Object

com.unboundid.util.CommandLineTool

com.unboundid.util.LDAPCommandLineTool

com.unboundid.ldap.sdk.examples.IdentifyReferencesToMissingEntries

All Implemented Interfaces:

SearchResultListener, java.io.Serializable

@ThreadSafety(level=NOT_THREADSAFE)
public final class IdentifyReferencesToMissingEntries
extends LDAPCommandLineTool
implements SearchResultListener

This class provides a tool that may be used to identify references to entries that do not exist. This tool can be useful for verifying existing data in directory servers that provide support for referential integrity.

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.
• "-A {attribute}" or "--attribute {attribute}" -- specifies an attribute that is expected to contain references to other entries. This attribute should be indexed for equality searches, and its values should be DNs. At least one attribute must be provided.
• "-z {size}" or "--simplePageSize {size}" -- indicates that the search to find entries with references to other entries 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 that reference other entries.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentifyReferencesToMissingEntries(java.io.OutputStream outStream, java.io.OutputStream errStream) Creates a new instance of this tool.

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.
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.
java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong>	getMissingReferenceCounts() Retrieves a map that correlates the number of missing references found by attribute type.
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.
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.
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.
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	supportsOutputFile() Indicates whether this tool should provide arguments for redirecting output to a file.
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	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, getBindControls, getConnection, getConnectionOptionsWithRequestedSettings, getConnectionPool, getConnectionPool, getSuppressedShortIdentifiers, getUnauthenticatedConnection, supportsAuthentication, supportsMultipleServers, supportsSASLHelp

Methods inherited from class com.unboundid.util.CommandLineTool

addEnableSSLDebuggingArgument, createArgumentParser, doShutdownHookProcessing, err, getAdditionalDescriptionParagraphs, getErr, getMaxTrailingArguments, getMinTrailingArguments, getOriginalErr, getOriginalOut, getOut, getPasswordFileReader, getToolCompletionMessage, getTrailingArgumentsPlaceholder, logToolInvocationByDefault, out, registerShutdownHook, requestToolArgumentsInteractively, runTool, wrapErr, wrapOut

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentifyReferencesToMissingEntries

public IdentifyReferencesToMissingEntries(@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 perform the appropriate processing.

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

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

Specified by:

getToolDescription in class CommandLineTool

Returns:

A human-readable description for this tool.

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.

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.

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.

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.

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.

getMissingReferenceCounts

@NotNull
public java.util.Map<java.lang.String,java.util.concurrent.atomic.AtomicLong> getMissingReferenceCounts()

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

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

searchEntryReturned

public void searchEntryReturned(@NotNull
                                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(@NotNull
                                    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.