@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ToolInvocationLogDetails extends java.lang.Object
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 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.
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCommandName()
Retrieves the name of the command (without any path information) for the
associated tool.
|
java.lang.String |
getInvocationID()
Retrieves the unique identifier to use to correlate the launch and
completion messages for the tool invocation, if available.
|
java.util.Set<java.io.File> |
getLogFiles()
Retrieves an unmodifiable set of the files in which launch and completion
log messages should be recorded for the tool invocation.
|
java.io.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.
|
java.lang.String |
toString()
Retrieves a string representation of this tool invocation log details
object.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this tool invocation log details
object to the provided buffer.
|
public java.lang.String getCommandName()
public boolean logInvocation()
true
if the messages should be logged, or false
if
not.public java.lang.String getInvocationID()
public java.util.Set<java.io.File> getLogFiles()
public java.io.PrintStream getToolErrorStream()
public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the string representation should be
appended.