Package org.opends.server.tools

Class StopDS

java.lang.Object

org.opends.server.tools.StopDS

public class StopDS
extends Object

This class provides a tool that can send a request to the Directory Server that will cause it to shut down.

Constructor Summary

Constructors

Constructor	Description
StopDS()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)	Invokes the stopDS method, passing it the provided command line arguments.
static int	stopDS(String[] args)	Parses the provided set of command-line arguments and attempts to contact the Directory Server in order to send it the shutdown request.
static int	stopDS(String[] args, OutputStream outStream, OutputStream errStream)	Parses the provided set of command-line arguments and attempts to contact the Directory Server in order to send it the shutdown request.

Methods inherited from class java.lang.Object

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

Constructor Detail

StopDS

public StopDS()

Method Detail

main

public static void main(String[] args)

Invokes the stopDS method, passing it the provided command line arguments. If the call to stopDS returns a nonzero value, then that will be used as the exit code for this program.

Parameters:

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

stopDS

public static int stopDS(String[] args)

Parses the provided set of command-line arguments and attempts to contact the Directory Server in order to send it the shutdown request.

Parameters:

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

Returns:

An integer value that indicates whether the shutdown request was accepted by the Directory Server. A nonzero value should be interpreted as a failure of some kind.

stopDS

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

Parses the provided set of command-line arguments and attempts to contact the Directory Server in order to send it the shutdown request.

Parameters:

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

outStream - The output stream to use for standard output, or null if standard output is not needed.

errStream - The output stream to use for standard error, or null if standard error is not needed.

Returns:

An integer value that indicates whether the shutdown request was accepted by the Directory Server. A nonzero value should be interpreted as a failure of some kind.