com.unboundid.ldap.sdk.unboundidds.examples
Class DumpDNs

java.lang.Object
  extended by com.unboundid.util.CommandLineTool
      extended by com.unboundid.util.LDAPCommandLineTool
          extended by com.unboundid.ldap.sdk.unboundidds.examples.DumpDNs
All Implemented Interfaces:
IntermediateResponseListener, java.io.Serializable

@ThreadSafety(level=NOT_THREADSAFE)
public final class DumpDNs
extends LDAPCommandLineTool
implements IntermediateResponseListener

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class provides a utility that uses the stream directory values extended operation in order to obtain a listing of all entry DNs below a specified base DN in the Directory Server.

The APIs demonstrated by this example include:

See Also:
Serialized Form

Constructor Summary
DumpDNs(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.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 the version string for this tool.
 void intermediateResponseReturned(IntermediateResponse intermediateResponse)
          Indicates that the provided intermediate response has been returned by the server and may be processed by this intermediate response listener.
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.
 
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

DumpDNs

public DumpDNs(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 the version string for this tool.

Overrides:
getToolVersion in class CommandLineTool
Returns:
The version string for this tool.

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.

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.

intermediateResponseReturned

public void intermediateResponseReturned(IntermediateResponse intermediateResponse)
Indicates that the provided intermediate response has been returned by the server and may be processed by this intermediate response listener. In this case, it will

Specified by:
intermediateResponseReturned in interface IntermediateResponseListener
Parameters:
intermediateResponse - The intermediate response that has been returned by the server.