Package org.opends.server.tools.supportextract

Class SupportExtract

java.lang.Object

com.forgerock.opendj.cli.Tool

org.opends.server.tools.supportextract.SupportExtract

All Implemented Interfaces:

Closeable, AutoCloseable

public final class SupportExtract
extends com.forgerock.opendj.cli.Tool

A tool that generates an archive with various server information, the archive can be sent to support for troubleshooting.

Nested Class Summary

Nested classes/interfaces inherited from class com.forgerock.opendj.cli.Tool

com.forgerock.opendj.cli.Tool.Style

Method Summary

Modifier and Type	Method	Description
void	errPrintln()	Displays a blank line to the error stream.
void	errPrintln(LocalizableMessage msg)	Displays a message to the error stream.
void	errPrintln(LocalizableMessage msg, int indent)	Displays a message to the error stream indented by the specified number of columns.
void	errPrintlnSurroundedByBlankLines(LocalizableMessage errorMessage)	Displays a blank line, the provided error message and another blank line on the error stream returned by Tool.getErrStream().
void	errPrintVerboseMessage(LocalizableMessage msg)	Displays a message to the error stream if verbose mode is enabled.
protected void	logVerboseMessage(String logMessage)	Logs the provided message on standard output.
static void	main(String[] args)	Runs the SupportExtract tool with the provided command line arguments.
void	print(LocalizableMessage msg)	Displays a message to the output stream.
void	println()	Displays a blank line to the output stream.
void	println(LocalizableMessage msg)	Displays a message to the output stream.
void	println(LocalizableMessage msg, int indent)	Displays a message to the output stream indented by the specified number of columns.
void	printlnSurroundedByBlankLines(LocalizableMessage message)	Displays a blank line, the provided message and another blank line.
com.forgerock.opendj.cli.ReturnCode	run(String... args)	Run this Tool tool with the provided arguments.

Methods inherited from class com.forgerock.opendj.cli.Tool

askPort, close, confirmAction, enableConsoleLoggingIfVerbose, flush, flushLogStream, getErrorStream, getErrStream, getInputStream, getOutputStream, isFullyInteractive, isQuiet, isScriptFriendly, isVerbose, mayPrompt, parseArguments, pressReturnToContinue, printlnNoWrap, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readValidatedInput, readValidatedInputOrThrow, report

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)

Runs the SupportExtract tool with the provided command line arguments.

Parameters:

args - The command line arguments.

run

public com.forgerock.opendj.cli.ReturnCode run(String... args)
                                        throws com.forgerock.opendj.cli.ClientException

Description copied from class: com.forgerock.opendj.cli.Tool

Run this Tool tool with the provided arguments. Output and errors will be written on the provided streams.

This method can be used to run the tool programmatically.

Overrides:

run in class com.forgerock.opendj.cli.Tool

Parameters:

args - Arguments set to pass to the tool.

Returns:

0 if all processing completed successfully, or non-zero if an error occurred.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool.

errPrintln

public void errPrintln()

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a blank line to the error stream.

Overrides:

errPrintln in class com.forgerock.opendj.cli.Tool

errPrintln

public void errPrintln(LocalizableMessage msg)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a message to the error stream.

Overrides:

errPrintln in class com.forgerock.opendj.cli.Tool

Parameters:

msg - The message.

errPrintln

public void errPrintln(LocalizableMessage msg,
                       int indent)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a message to the error stream indented by the specified number of columns.

Overrides:

errPrintln in class com.forgerock.opendj.cli.Tool

Parameters:

msg - The message.

indent - The number of columns to indent.

errPrintVerboseMessage

public void errPrintVerboseMessage(LocalizableMessage msg)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a message to the error stream if verbose mode is enabled.

Overrides:

errPrintVerboseMessage in class com.forgerock.opendj.cli.Tool

Parameters:

msg - The verbose message.

print

public void print(LocalizableMessage msg)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a message to the output stream.

Overrides:

print in class com.forgerock.opendj.cli.Tool

Parameters:

msg - The message.

println

public void println()

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a blank line to the output stream.

Overrides:

println in class com.forgerock.opendj.cli.Tool

println

public void println(LocalizableMessage msg)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a message to the output stream.

Overrides:

println in class com.forgerock.opendj.cli.Tool

Parameters:

msg - The message.

println

public void println(LocalizableMessage msg,
                    int indent)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a message to the output stream indented by the specified number of columns.

Overrides:

println in class com.forgerock.opendj.cli.Tool

Parameters:

msg - The message.

indent - The number of columns to indent.

printlnSurroundedByBlankLines

public void printlnSurroundedByBlankLines(LocalizableMessage message)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a blank line, the provided message and another blank line.

Overrides:

printlnSurroundedByBlankLines in class com.forgerock.opendj.cli.Tool

Parameters:

message - The message to print between two blank lines

errPrintlnSurroundedByBlankLines

public void errPrintlnSurroundedByBlankLines(LocalizableMessage errorMessage)

Description copied from class: com.forgerock.opendj.cli.Tool

Displays a blank line, the provided error message and another blank line on the error stream returned by Tool.getErrStream().

Overrides:

errPrintlnSurroundedByBlankLines in class com.forgerock.opendj.cli.Tool

Parameters:

errorMessage - The error message to print between two blank lines

logVerboseMessage

protected void logVerboseMessage(String logMessage)

Description copied from class: com.forgerock.opendj.cli.Tool

Logs the provided message on standard output.

Overrides:

logVerboseMessage in class com.forgerock.opendj.cli.Tool

Parameters:

logMessage - The message to logMessage