Package com.unboundid.ldap.sdk.examples

Class TestLDAPSDKPerformance

    • Constructor Detail

      • TestLDAPSDKPerformance

        public TestLDAPSDKPerformance​(@Nullable
                              java.io.OutputStream out,
                              @Nullable
                              java.io.OutputStream err)
        Creates a new instance of this command-line tool.
        Parameters:
        out - The output stream to use for standard output. It may be null if standard output should be suppressed.
        err - The output stream to use for standard error. It may be null if standard error should be suppressed.

    • Method Detail

      • main

        public static void main​(@NotNull
                        java.lang.String... args)
        Runs this tool with the provided set of command-line arguments.
        Parameters:
        args - The command-line arguments provided to this program.

      • main

        @NotNull
public static ResultCode main​(@Nullable
                              java.io.OutputStream out,
                              @Nullable
                              java.io.OutputStream err,
                              @NotNull
                              java.lang.String... args)
        Runs this tool with the provided set of command-line arguments.
        Parameters:
        out - The output stream to use for standard output. It may be null if standard output should be suppressed.
        err - The output stream to use for standard error. It may be null if standard error should be suppressed.
        args - The command-line arguments provided to this program.
        Returns:
        A result code indicating the result of tool processing. Any result code other than ResultCode.SUCCESS should be considered an error.

      • getToolName

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

        @NotNull
public java.lang.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 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 java.util.List<java.lang.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 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.

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

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

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

      • getToolCompletionMessage

        @Nullable
protected java.lang.String getToolCompletionMessage()
        Retrieves an optional message that may provide additional information about the way that the tool completed its processing. For example if the tool exited with an error message, it may be useful for this method to return that error message.

        The message returned by this method is intended for purposes and is not meant to be parsed or programmatically interpreted.
        Overrides:
        getToolCompletionMessage in class CommandLineTool
        Returns:
        An optional message that may provide additional information about the completion state for this tool, or null if no completion message is available.

      • addToolArguments

        public void addToolArguments​(@NotNull
                             ArgumentParser parser)
                      throws ArgumentException
        Adds the command-line arguments supported for use with this tool to the provided argument parser. The tool may need to retain references to the arguments (and/or the argument parser, if trailing arguments are allowed) to it in order to obtain their values for use in later processing.
        Specified by:
        addToolArguments in class CommandLineTool
        Parameters:
        parser - The argument parser to which the arguments are to be added.
        Throws:
        ArgumentException - If a problem occurs while adding any of the tool-specific arguments to the provided argument parser.

      • getExampleUsages

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