org.opends.server.backends.pluggable

Class BackendStat

java.lang.Object

org.opends.server.backends.pluggable.BackendStat

public class BackendStat
extends Object

This program provides a utility that may be used to debug a Pluggable Backend. This tool provides the ability to:

• list root containers
• list entry containers
• list Trees in a Backend or Storage
• gather information about Backend indexes
• dump the contents of a Tree either at the Backend or the Storage layer.

This will be a process that is intended to run outside of Directory Server and not internally within the server process (e.g., via the tasks interface); it still requires configuration information and access to Directory Server instance data.

Constructor Summary

Constructors

Constructor and Description
BackendStat(OutputStream out, OutputStream err) Creates a new dsconfig application instance.

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args) Provides the command-line arguments to the main application for processing.
static int	main(String[] args, OutputStream outStream, OutputStream errStream) Provides the command-line arguments to the main application for processing and returns the exit code as an integer.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendStat

public BackendStat(OutputStream out,
           OutputStream err)

Creates a new dsconfig application instance.

Parameters:

out - The application output stream.

err - The application error stream.

Method Detail

main

public static void main(String[] args)

Provides the command-line arguments to the main application for processing.

Parameters:

args - The set of command-line arguments provided to this program.

main

public static int main(String[] args,
       OutputStream outStream,
       OutputStream errStream)

Provides the command-line arguments to the main application for processing and returns the exit code as an integer.

Parameters:

args - The set of command-line arguments provided to this program.

outStream - The output stream for standard output.

errStream - The output stream for standard error.

Returns:

Zero to indicate that the program completed successfully, or non-zero to indicate that an error occurred.