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

Class ToolInvocationLogDetails

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tools.ToolInvocationLogDetails
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ToolInvocationLogDetails extends Object
This class represents a data structure that contains information that should be used when logging launch and completion messages for a tool invocation.
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.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCommandName()
    Retrieves the name of the command (without any path information) for the associated tool.
    String
    getInvocationID()
    Retrieves the unique identifier to use to correlate the launch and completion messages for the tool invocation, if available.
    Set<File>
    getLogFiles()
    Retrieves an unmodifiable set of the files in which launch and completion log messages should be recorded for the tool invocation.
    PrintStream
    getToolErrorStream()
    Retrieves a print stream that may be used to report information about any problems encountered while attempting to perform invocation logging.
    boolean
    logInvocation()
    Indicates whether launch and completion messages should be logged for the tool.
    String
    toString()
    Retrieves a string representation of this tool invocation log details object.
    void
    toString(StringBuilder buffer)
    Appends a string representation of this tool invocation log details object to the provided buffer.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Method Details

    • getCommandName

      @NotNull public String getCommandName()
      Retrieves the name of the command (without any path information) for the associated tool.
      Returns:
      The name of the command for the associated tool.

    • logInvocation

      public boolean logInvocation()
      Indicates whether launch and completion messages should be logged for the tool.
      Returns:
      true if the messages should be logged, or false if not.

    • getInvocationID

      @NotNull public String getInvocationID()
      Retrieves the unique identifier to use to correlate the launch and completion messages for the tool invocation, if available.
      Returns:
      The unique identifier to use to correlate the launch and completion messages for the tool invocation, or an empty string if no invocation logging should be performed for the tool.

    • getLogFiles

      @NotNull public Set<File> getLogFiles()
      Retrieves an unmodifiable set of the files in which launch and completion log messages should be recorded for the tool invocation.
      Returns:
      An unmodifiable set of the files in which launch and completion log messages should be recorded for the tool invocation. It may be empty if no invocation logging should be performed.

    • getToolErrorStream

      @NotNull public PrintStream getToolErrorStream()
      Retrieves a print stream that may be used to report information about any problems encountered while attempting to perform invocation logging.
      Returns:
      A print stream that may be used to report information about any problems encountered while attempting to perform invocation logging.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this tool invocation log details object.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this tool invocation log details object.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this tool invocation log details object to the provided buffer.
      Parameters:
      buffer - The buffer to which the string representation should be appended.