Class DumpDNs
- java.lang.Object
-
- com.unboundid.util.CommandLineTool
-
- com.unboundid.util.LDAPCommandLineTool
-
- 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
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.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
The APIs demonstrated by this example include:- The use of the stream directory values extended operation.
- Intermediate response processing.
- The LDAP command-line tool API.
- Argument parsing.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DumpDNs(java.io.OutputStream outStream, java.io.OutputStream errStream)
Creates a new instance of this tool.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.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.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.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.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.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, 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, supportsOutputFile, wrapErr, wrapOut
-
-
-
-
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 benull
if output should be suppressed.errStream
- The output stream to which standard error should be written. It may benull
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 benull
if output should be suppressed.errStream
- The output stream to which standard error should be written. It may benull
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 classCommandLineTool
- Returns:
- The name for this tool.
-
getToolDescription
public java.lang.String getToolDescription()
Retrieves a human-readable description for this tool.- Specified by:
getToolDescription
in classCommandLineTool
- Returns:
- A human-readable description for this tool.
-
getToolVersion
public java.lang.String getToolVersion()
Retrieves the version string for this tool.- Overrides:
getToolVersion
in classCommandLineTool
- Returns:
- The version string for this tool.
-
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 anddefaultsToInteractiveMode()
returnstrue
, then interactive mode may be invoked by simply launching the tool without any arguments.- Overrides:
supportsInteractiveMode
in classCommandLineTool
- Returns:
true
if this tool supports interactive mode, orfalse
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 ifsupportsInteractiveMode()
returnstrue
.- Overrides:
defaultsToInteractiveMode
in classCommandLineTool
- Returns:
true
if this tool defaults to using interactive mode if launched without any command-line arguments, orfalse
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 classLDAPCommandLineTool
- Returns:
true
if this tool should default to interactively prompting for the bind password, orfalse
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 classCommandLineTool
- 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, orfalse
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 classLDAPCommandLineTool
- Returns:
true
if this tool should provide multiple versions of long identifiers for LDAP-specific arguments, orfalse
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 returnstrue
, then an "--enableSSLDebugging}" argument will be added that sets the "javax.net.debug" system property to "all" before attempting any communication.- Overrides:
supportsSSLDebugging
in classLDAPCommandLineTool
- Returns:
true
if this tool should offer an "--enableSSLDebugging" argument, orfalse
if not.
-
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 classLDAPCommandLineTool
- Parameters:
parser
- The argument parser to which the arguments should be added.- Throws:
ArgumentException
- If a problem occurs while adding the arguments.
-
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 classLDAPCommandLineTool
- Returns:
- The connection options that should be used for connections that are created with this command line tool.
-
doToolProcessing
public ResultCode doToolProcessing()
Performs the core set of processing for this tool.- Specified by:
doToolProcessing
in classCommandLineTool
- 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 classCommandLineTool
- 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 interfaceIntermediateResponseListener
- Parameters:
intermediateResponse
- The intermediate response that has been returned by the server.
-
-