Package com.unboundid.ldap.sdk.unboundidds.tools

Class LDAPSearch

java.lang.Object
com.unboundid.util.CommandLineTool
com.unboundid.util.LDAPCommandLineTool
com.unboundid.ldap.sdk.unboundidds.tools.LDAPSearch
All Implemented Interfaces:
UnsolicitedNotificationHandler
@ThreadSafety(level=NOT_THREADSAFE) public final class LDAPSearch extends LDAPCommandLineTool implements UnsolicitedNotificationHandler
This class provides an implementation of an LDAP command-line tool that may be used to issue searches to a directory server. Matching entries will be output in the LDAP data interchange format (LDIF), to standard output and/or to a specified file. This is a much more full-featured tool than the LDAPSearch tool, and includes a number of features only intended for use with Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products.
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.

  • Constructor Details

    • LDAPSearch

      public LDAPSearch(@Nullable OutputStream out, @Nullable OutputStream err)
      Creates a new instance of this tool with the provided streams.
      Parameters:
      out - The output stream to use for standard output. If this is null, then standard output will be suppressed.
      err - The output stream to use for standard error. If this is null, then standard error will be suppressed.

  • Method Details

    • main

      public static void main(@NotNull String... args)
      Runs this tool with the provided command-line arguments. It will use the JVM-default streams for standard input, output, and error.
      Parameters:
      args - The command-line arguments to provide to this program.

    • main

      @NotNull public static ResultCode main(@Nullable OutputStream out, @Nullable OutputStream err, @NotNull String... args)
      Runs this tool with the provided streams and command-line arguments.
      Parameters:
      out - The output stream to use for standard output. If this is null, then standard output will be suppressed.
      err - The output stream to use for standard error. If this is null, then standard error will be suppressed.
      args - The command-line arguments provided to this program.
      Returns:
      The result code obtained when running the tool. Any result code other than ResultCode.SUCCESS indicates an error.

    • getToolName

      @NotNull public 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 String getToolDescription()
      Retrieves a human-readable description for this tool. If the description should include multiple paragraphs, then this method should return the text for the first paragraph, and the CommandLineTool.getAdditionalDescriptionParagraphs() method should be used to return the text for the subsequent paragraphs.
      Specified by:
      getToolDescription in class CommandLineTool
      Returns:
      A human-readable description for this tool.

    • getAdditionalDescriptionParagraphs

      @NotNull public List<String> getAdditionalDescriptionParagraphs()
      Retrieves additional paragraphs that should be included in the description for this tool. If the tool description should include multiple paragraphs, then the CommandLineTool.getToolDescription() method should return the text of the first paragraph, and each item in the list returned by this method should be the text for each subsequent paragraph. If the tool description should only have a single paragraph, then this method may return null or an empty list.
      Overrides:
      getAdditionalDescriptionParagraphs in class CommandLineTool
      Returns:
      Additional paragraphs that should be included in the description for this tool, or null or an empty list if only a single description paragraph (whose text is returned by the getToolDescription method) is needed.

    • getToolVersion

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

    • getMinTrailingArguments

      public int getMinTrailingArguments()
      Retrieves the minimum number of unnamed trailing arguments that must be provided for this tool. If a tool requires the use of trailing arguments, then it must override this method and the CommandLineTool.getMaxTrailingArguments() arguments to return nonzero values, and it must also override the CommandLineTool.getTrailingArgumentsPlaceholder() method to return a non-null value.
      Overrides:
      getMinTrailingArguments in class CommandLineTool
      Returns:
      The minimum number of unnamed trailing arguments that may be provided for this tool. A value of zero indicates that the tool may be invoked without any trailing arguments.

    • getMaxTrailingArguments

      public int getMaxTrailingArguments()
      Retrieves the maximum number of unnamed trailing arguments that may be provided for this tool. If a tool supports trailing arguments, then it must override this method to return a nonzero value, and must also override the CommandLineTool.getTrailingArgumentsPlaceholder() method to return a non-null value.
      Overrides:
      getMaxTrailingArguments in class CommandLineTool
      Returns:
      The maximum number of unnamed trailing arguments that may be provided for this tool. A value of zero indicates that trailing arguments are not allowed. A negative value indicates that there should be no limit on the number of trailing arguments.

    • getTrailingArgumentsPlaceholder

      @NotNull public String getTrailingArgumentsPlaceholder()
      Retrieves a placeholder string that should be used for trailing arguments in the usage information for this tool.
      Overrides:
      getTrailingArgumentsPlaceholder in class CommandLineTool
      Returns:
      A placeholder string that should be used for trailing arguments in the usage information for this tool, or null if trailing arguments are not supported.

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

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

    • getSuppressedShortIdentifiers

      @NotNull protected Set<Character> getSuppressedShortIdentifiers()
      Retrieves a set containing any short identifiers that should be suppressed in the set of generic tool arguments so that they can be used by a tool-specific argument instead.
      Overrides:
      getSuppressedShortIdentifiers in class LDAPCommandLineTool
      Returns:
      A set containing any short identifiers that should be suppressed in the set of generic tool arguments so that they can be used by a tool-specific argument instead. It may be empty but must not be null.

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

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

    • supportsMultipleServers

      protected boolean supportsMultipleServers()
      Indicates whether this tool supports creating connections to multiple servers. If it is to support multiple servers, then the "--hostname" and "--port" arguments will be allowed to be provided multiple times, and will be required to be provided the same number of times. The same type of communication security and bind credentials will be used for all servers.
      Overrides:
      supportsMultipleServers in class LDAPCommandLineTool
      Returns:
      true if this tool supports creating connections to multiple servers, or false if not.

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

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

    • handleUnsolicitedNotification

      public void handleUnsolicitedNotification(@NotNull LDAPConnection connection, @NotNull ExtendedResult notification)
      Performs any processing that may be necessary in response to the provided unsolicited notification that has been received from the server.
      Specified by:
      handleUnsolicitedNotification in interface UnsolicitedNotificationHandler
      Parameters:
      connection - The connection on which the unsolicited notification was received.
      notification - The unsolicited notification that has been received from the server.

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