Package com.unboundid.ldap.sdk.examples

Class LDAPDebugger

java.lang.Object
com.unboundid.util.CommandLineTool
com.unboundid.util.LDAPCommandLineTool
com.unboundid.ldap.sdk.examples.LDAPDebugger
All Implemented Interfaces:
Serializable
@ThreadSafety(level=NOT_THREADSAFE) public final class LDAPDebugger extends LDAPCommandLineTool implements Serializable
This class provides a tool that can be used to create a simple listener that may be used to intercept and decode LDAP requests before forwarding them to another directory server, and then intercept and decode responses before returning them to the client. Some of the APIs demonstrated by this example include:
  • Argument Parsing (from the com.unboundid.util.args package)
  • LDAP Command-Line Tool (from the com.unboundid.util package)
  • LDAP Listener API (from the com.unboundid.ldap.listener package)


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:
  • "-a {address}" or "--listenAddress {address}" -- Specifies the address on which to listen for requests from clients.
  • "-L {port}" or "--listenPort {port}" -- Specifies the port on which to listen for requests from clients.
  • "-S" or "--listenUsingSSL" -- Indicates that the listener should accept connections from SSL-based clients rather than those using unencrypted LDAP.
  • "-f {path}" or "--outputFile {path}" -- Specifies the path to the output file to be written. If this is not provided, then the output will be written to standard output.
  • "-c {path}" or "--codeLogFile {path}" -- Specifies the path to a file to be written with generated code that corresponds to requests received from clients. If this is not provided, then no code log will be generated.
See Also:

  • Constructor Details

    • LDAPDebugger

      public LDAPDebugger(@Nullable OutputStream outStream, @Nullable 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 Details

    • main

      public static void main(@NotNull String[] args)
      Parse the provided command line arguments and make the appropriate set of changes.
      Parameters:
      args - The command line arguments provided to this program.

    • main

      @NotNull public static ResultCode main(@NotNull String[] args, @Nullable OutputStream outStream, @Nullable OutputStream errStream)
      Parse the provided command line arguments and make the appropriate set of changes.
      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 String getToolName()
      Retrieves the name for this tool.
      Specified by:
      getToolName in class CommandLineTool
      Returns:
      The name for this tool.

    • getToolDescription

      @NotNull public String getToolDescription()
      Retrieves the description for this tool.
      Specified by:
      getToolDescription in class CommandLineTool
      Returns:
      The description for this tool.

    • getToolVersion

      @NotNull public String getToolVersion()
      Retrieves the version string for this tool.
      Overrides:
      getToolVersion in class CommandLineTool
      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 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.

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

    • supportsDebugLogging

      protected boolean supportsDebugLogging()
      Indicates whether this tool supports the ability to generate a debug log file. If this method returns true, then the tool will expose additional arguments that can control debug logging.
      Overrides:
      supportsDebugLogging in class CommandLineTool
      Returns:
      true if this tool supports the ability to generate a debug log file, 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 used by this program that aren't already provided by the generic LDAPCommandLineTool framework.
      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

      @NotNull public ResultCode doToolProcessing()
      Performs the actual processing for this tool. In this case, it gets a connection to the directory server and uses it to perform the requested search.
      Specified by:
      doToolProcessing in class CommandLineTool
      Returns:
      The result code for the processing that was performed.

    • getExampleUsages

      @NotNull public LinkedHashMap<String[],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.

    • getListener

      @Nullable public LDAPListener getListener()
      Retrieves the LDAP listener used to decode the communication.
      Returns:
      The LDAP listener used to decode the communication, or null if the tool is not running.

    • shutDown

      public void shutDown()
      Indicates that the associated listener should shut down.