org.opends.server.tools.dsreplication

Class ReplicationCliMain

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.dsreplication.ReplicationCliMain

public class ReplicationCliMain
extends com.forgerock.opendj.cli.ConsoleApplication

This class provides a tool that can be used to enable and disable replication and also to initialize the contents of a replicated suffix with the contents of another suffix. It also allows to display the replicated status of the different base DNs of the servers that are registered in the ADS.

Nested Class Summary

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

com.forgerock.opendj.cli.ConsoleApplication.Style

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOG_FILE_PREFIX Prefix for log files.
static String	LOG_FILE_SUFFIX Suffix for log files.

Constructor Summary

Constructors

Constructor and Description
ReplicationCliMain(PrintStream out, PrintStream err) Constructor for the ReplicationCliMain object.

Method Summary

Methods

Modifier and Type	Method and Description
ReplicationCliReturnCode	execute(String[] args, boolean initializeServer) Parses the provided command-line arguments and uses that information to run the replication tool.
void	initializeAllSuffix(String baseDN, InitialLdapContext ctx, boolean displayProgress) Initializes all the replicas in the topology with the contents of a given replica.
void	initializeAllSuffixTry(String baseDN, InitialLdapContext ctx, boolean displayProgress) Initializes all the replicas in the topology with the contents of a given replica.
boolean	isAdvancedMode()
boolean	isInteractive()
boolean	isMenuDrivenMode()
boolean	isQuiet()
boolean	isScriptFriendly()
boolean	isVerbose()
static void	main(String[] args) The main method for the replication tool.
static int	mainCLI(String[] args) Parses the provided command-line arguments and uses that information to run the replication tool.
static int	mainCLI(String[] args, boolean initializeServer, OutputStream outStream, OutputStream errStream) Parses the provided command-line arguments and uses that information to run the replication tool.
int	readInteger(LocalizableMessage prompt, int defaultValue) Interactively retrieves an integer value from the console.

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

askConfirmation, askPort, confirmAction, errPrint, errPrintln, errPrintln, errPrintln, errPrintVerboseMessage, getErrorStream, getErrStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, println, printProgressBar, printVerboseMessage, readInput, readInput, readLineOfInput, readPassword, readPassword, readPort, readValidatedInput, readValidatedInput

Methods inherited from class java.lang.Object

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

Field Detail

LOG_FILE_PREFIX

public static final String LOG_FILE_PREFIX

Prefix for log files.

See Also:

Constant Field Values

LOG_FILE_SUFFIX

public static final String LOG_FILE_SUFFIX

Suffix for log files.

See Also:

Constant Field Values

Constructor Detail

ReplicationCliMain

public ReplicationCliMain(PrintStream out,
                  PrintStream err)

Constructor for the ReplicationCliMain object.

Parameters:

out - the print stream to use for standard output.

err - the print stream to use for standard error.

Method Detail

main

public static void main(String[] args)

The main method for the replication tool.

Parameters:

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

mainCLI

public static int mainCLI(String[] args)

Parses the provided command-line arguments and uses that information to run the replication tool.

Parameters:

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

Returns:

The error code.

mainCLI

public static int mainCLI(String[] args,
          boolean initializeServer,
          OutputStream outStream,
          OutputStream errStream)

Parses the provided command-line arguments and uses that information to run the replication tool.

Parameters:

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

initializeServer - Indicates whether to initialize the server.

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:

The error code.

execute

public ReplicationCliReturnCode execute(String[] args,
                               boolean initializeServer)

Parses the provided command-line arguments and uses that information to run the replication tool.

Parameters:

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

initializeServer - Indicates whether to initialize the server.

Returns:

The error code.

readInteger

public final int readInteger(LocalizableMessage prompt,
              int defaultValue)
                      throws com.forgerock.opendj.cli.ClientException

Interactively retrieves an integer value from the console.

Parameters:

prompt - The message prompt.

defaultValue - The default value.

Returns:

Returns the value.

Throws:

com.forgerock.opendj.cli.ClientException - If the value could not be retrieved for some reason.

initializeAllSuffix

public void initializeAllSuffix(String baseDN,
                       InitialLdapContext ctx,
                       boolean displayProgress)
                         throws ReplicationCliException

Initializes all the replicas in the topology with the contents of a given replica.

Parameters:

ctx - the connection to the server where the source replica of the initialization is.

baseDN - the dn of the suffix.

displayProgress - whether we want to display progress or not.

Throws:

ReplicationCliException - if an unexpected error occurs.

initializeAllSuffixTry

public void initializeAllSuffixTry(String baseDN,
                          InitialLdapContext ctx,
                          boolean displayProgress)
                            throws com.forgerock.opendj.cli.ClientException,
                                   PeerNotFoundException

Initializes all the replicas in the topology with the contents of a given replica. This method will try to create the task only once.

Parameters:

ctx - the connection to the server where the source replica of the initialization is.

baseDN - the dn of the suffix.

displayProgress - whether we want to display progress or not.

Throws:

com.forgerock.opendj.cli.ClientException - if an unexpected error occurs.

PeerNotFoundException - if the replication mechanism cannot find a peer.

isAdvancedMode

public boolean isAdvancedMode()

Overrides:

isAdvancedMode in class com.forgerock.opendj.cli.ConsoleApplication

isInteractive

public boolean isInteractive()

Overrides:

isInteractive in class com.forgerock.opendj.cli.ConsoleApplication

isMenuDrivenMode

public boolean isMenuDrivenMode()

Overrides:

isMenuDrivenMode in class com.forgerock.opendj.cli.ConsoleApplication

isQuiet

public boolean isQuiet()

Overrides:

isQuiet in class com.forgerock.opendj.cli.ConsoleApplication

isScriptFriendly

public boolean isScriptFriendly()

Overrides:

isScriptFriendly in class com.forgerock.opendj.cli.ConsoleApplication

isVerbose

public boolean isVerbose()

Overrides:

isVerbose in class com.forgerock.opendj.cli.ConsoleApplication