Package com.unboundid.ldap.sdk.examples

Class LDAPSearch

java.lang.Object
com.unboundid.util.CommandLineTool
com.unboundid.util.LDAPCommandLineTool
com.unboundid.ldap.sdk.examples.LDAPSearch
All Implemented Interfaces:
SearchResultListener, Serializable
@ThreadSafety(level=NOT_THREADSAFE) public final class LDAPSearch extends LDAPCommandLineTool implements SearchResultListener
This class provides a simple tool that can be used to search an LDAP directory server. 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 Communication (from the com.unboundid.ldap.sdk 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:
  • "-b {baseDN}" or "--baseDN {baseDN}" -- specifies the base DN to use for the search. This must be provided.
  • "-s {scope}" or "--scope {scope}" -- specifies the scope to use for the search. The scope value should be one of "base", "one", "sub", or "subord". If this isn't specified, then a scope of "sub" will be used.
  • "-R" or "--followReferrals" -- indicates that the tool should follow any referrals encountered while searching.
  • "-t" or "--terse" -- indicates that the tool should generate minimal output beyond the search results.
  • "-i {millis}" or "--repeatIntervalMillis {millis}" -- indicates that the search should be periodically repeated with the specified delay (in milliseconds) between requests.
  • "-n {count}" or "--numSearches {count}" -- specifies the total number of times that the search should be performed. This may only be used in conjunction with the "--repeatIntervalMillis" argument. If "--repeatIntervalMillis" is used without "--numSearches", then the searches will continue to be repeated until the tool is interrupted.
  • "--bindControl {control}" -- specifies a control that should be included in the bind request sent by this tool before performing any search operations.
  • "-J {control}" or "--control {control}" -- specifies a control that should be included in the search request(s) sent by this tool.
In addition, after the above named arguments are provided, a set of one or more unnamed trailing arguments must be given. The first argument should be the string representation of the filter to use for the search. If there are any additional trailing arguments, then they will be interpreted as the attributes to return in matching entries. If no attribute names are given, then the server should return all user attributes in matching entries.

Note that this class implements the SearchResultListener interface, which will be notified whenever a search result entry or reference is returned from the server. Whenever an entry is received, it will simply be printed displayed in LDIF.
See Also:

  • Constructor Details

    • LDAPSearch

      public LDAPSearch(@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.

    • getMinTrailingArguments

      public int getMinTrailingArguments()
      Retrieves the minimum number of unnamed trailing arguments that are required.
      Overrides:
      getMinTrailingArguments in class CommandLineTool
      Returns:
      One, to indicate that at least one trailing argument (representing the search filter) must be provided.

    • getMaxTrailingArguments

      public int getMaxTrailingArguments()
      Retrieves the maximum number of unnamed trailing arguments that are allowed.
      Overrides:
      getMaxTrailingArguments in class CommandLineTool
      Returns:
      A negative value to indicate that any number of trailing arguments may be provided.

    • getTrailingArgumentsPlaceholder

      @NotNull public String getTrailingArgumentsPlaceholder()
      Retrieves a placeholder string that may be used to indicate what kinds of trailing arguments are allowed.
      Overrides:
      getTrailingArgumentsPlaceholder in class CommandLineTool
      Returns:
      A placeholder string that may be used to indicate what kinds of trailing arguments are allowed.

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

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

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

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

    • doExtendedNonLDAPArgumentValidation

      public void doExtendedNonLDAPArgumentValidation() throws ArgumentException
      Performs any necessary processing that should be done to ensure that the provided set of command-line arguments were valid. This method will be called after the basic argument parsing has been performed and after all LDAP-specific argument validation has been processed, and immediately before the CommandLineTool.doToolProcessing() method is invoked.
      Overrides:
      doExtendedNonLDAPArgumentValidation in class LDAPCommandLineTool
      Throws:
      ArgumentException - If there was a problem with the command-line arguments provided to this program.

    • getBindControls

      @NotNull protected List<Control> getBindControls()
      Retrieves a set of controls that should be included in any bind request generated by this tool.
      Overrides:
      getBindControls in class LDAPCommandLineTool
      Returns:
      A set of controls that should be included in any bind request generated by this tool. It may be null or empty if no controls should be included in the bind request.

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

    • searchEntryReturned

      public void searchEntryReturned(@NotNull SearchResultEntry entry)
      Indicates that the provided search result entry was returned from the associated search operation.
      Specified by:
      searchEntryReturned in interface SearchResultListener
      Parameters:
      entry - The entry that was returned from the search.

    • searchReferenceReturned

      public void searchReferenceReturned(@NotNull SearchResultReference reference)
      Indicates that the provided search result reference was returned from the associated search operation.
      Specified by:
      searchReferenceReturned in interface SearchResultListener
      Parameters:
      reference - The reference that was returned from the search.

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