public class ReplicationCliArgumentParser extends SecureConnectionCliParser
Modifier and Type | Field and Description |
---|---|
static String |
INITIALIZE_ALL_REPLICATION_SUBCMD_NAME
The text of the initialize all replication subcommand.
|
noPropertiesFileArg, propertiesFileArg, secureArgsList, verboseArg
Modifier and Type | Method and Description |
---|---|
String |
getAdministratorUID()
Returns the Administrator UID explicitly provided in the command-line.
|
String |
getAdministratorUIDOrDefault()
Returns the default Administrator UID value.
|
List<String> |
getBaseDNs()
Returns the list of base DNs provided by the user.
|
String |
getBindDnToUnconfigure()
Returns the server bind dn explicitly provided in the unconfigure replication subcommand.
|
String |
getBindPasswordAdmin()
Get the global administrator password which has to be used for the command
to connect to the server(s) without prompting the user.
|
String |
getConfigFile()
Returns the config file value provided in the hidden argument of the
command-line.
|
String |
getHostNameDestination()
Returns the destination host name explicitly provided in the initialize
replication subcommand.
|
String |
getHostNameDestinationOrDefault()
Returns the destination host name default value in the initialize
replication subcommand.
|
String |
getHostNameSource()
Returns the source host name explicitly provided in the initialize
replication subcommand.
|
String |
getHostNameSourceOrDefault()
Returns the first host name default value in the initialize replication
subcommand.
|
String |
getHostNameToDisable()
Returns the host name explicitly provided in the disable replication
subcommand.
|
String |
getHostNameToInitializeAllOrDefault()
Returns the host name default value in the initialize all replication
subcommand.
|
String |
getHostNameToStatusOrDefault()
Returns the host name default value in the status replication subcommand.
|
String |
getHostNameToUnconfigureOrDefault()
Returns the host name default value in the unconfigure replication subcommand.
|
int |
getMaximumDuration()
Returns the maximum duration explicitly provided in the purge historical
replication subcommand.
|
int |
getMaximumDurationOrDefault()
Returns the maximum duration default value in the purge historical
replication subcommand.
|
int |
getPortDestination()
Returns the destination server port explicitly provided in the initialize
replication subcommand.
|
int |
getPortDestinationOrDefault()
Returns the destination server port default value in the initialize
replication subcommand.
|
int |
getPortSource()
Returns the source server port explicitly provided in the initialize
replication subcommand.
|
int |
getPortSourceOrDefault()
Returns the source server port default value in the initialize replication
subcommand.
|
int |
getPortToInitializeAllOrDefault()
Returns the server port default value in the initialize all replication
subcommand.
|
int |
getPortToStatusOrDefault()
Returns the server port default value in the status replication subcommand.
|
int |
getPortToUnconfigure()
Returns the server port explicitly provided in the unconfigure replication subcommand.
|
int |
getPortToUnconfigureOrDefault()
Returns the server port default value in the unconfigure replication subcommand.
|
int |
getReplicationPort1()
Returns the first server replication port explicitly provided in the enable
replication subcommand.
|
int |
getReplicationPort2()
Returns the second server replication port explicitly provided in the
enable replication subcommand.
|
int |
getResetChangeNumber()
Returns the changenumber specified as argument.
|
SecureConnectionCliArgs |
getSecureArgsList()
Returns the SecureConnectionCliArgs object containing the arguments
of this parser.
|
TaskScheduleArgs |
getTaskArgsList()
Returns the TaskScheduleArgs object containing the arguments
of this parser.
|
protected void |
initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args,
com.forgerock.opendj.cli.ArgumentGroup argGroup)
Initialize the global options with the provided set of arguments.
|
boolean |
isInteractive()
Tells whether the user specified to have an interactive operation or not.
|
boolean |
isQuiet()
Tells whether the user specified to have a quite operation or not.
|
boolean |
isScriptFriendly()
Tells whether the user specified to have a script-friendly output or not.
|
void |
setResetChangeNumber(String changeNumber)
Sets the start change number value.
|
int |
validateGlobalOptions(LocalizableMessageBuilder buf)
Indication if provided global options are validate.
|
createGlobalArguments, getBindDN, getBindPassword, getConnectTimeout, getHostName, getPort, getTrustManager, initializeGlobalArguments, isVerbose, validateGlobalOptions
addArgument, defaultSubCommand, getSelectedSubCommand, getSubCommand, getSubCommands, getUsage, setUsageArgument, setUsageGroupArgument
addArgument, addDefaultArgument, addLdapConnectionArgument, displayMessageAndUsageReference, getArgumentForLongId, getArgumentForShortId, getArguments, getBindPassword, getDocSubcommandsDescriptionSupplement, getDocToolDescriptionSupplement, getShortToolDescription, getTrailingArguments, isUsageArgumentPresent, isVersionArgumentPresent, parseArguments, parseArguments, parseArguments, replaceArgument, setDocSubcommandsDescriptionSupplement, setDocToolDescriptionSupplement, setShortToolDescription, setUsageOrVersionDisplayed, setVersionHandler, usageOrVersionDisplayed
public static final String INITIALIZE_ALL_REPLICATION_SUBCMD_NAME
public int validateGlobalOptions(LocalizableMessageBuilder buf)
SecureConnectionCliParser
validateGlobalOptions
in class SecureConnectionCliParser
buf
- The LocalizableMessageBuilder
to write the error message.protected void initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args, com.forgerock.opendj.cli.ArgumentGroup argGroup)
initializeGlobalArguments
in class SecureConnectionCliParser
args
- the arguments to use to initialize the global options.argGroup
- the group to which args will be added.
arguments.public boolean isInteractive()
true
if the user specified to have an interactive
operation and false
otherwise.public boolean isQuiet()
true
if the user specified to have a quite operation
and false
otherwise.public boolean isScriptFriendly()
true
if the user specified to have a script-friendly
output and false
otherwise.public String getBindPasswordAdmin()
public String getAdministratorUID()
getAdministratorUID
in class SecureConnectionCliParser
public String getAdministratorUIDOrDefault()
public int getReplicationPort1()
public int getReplicationPort2()
public String getHostNameToDisable()
public String getHostNameToUnconfigureOrDefault()
public String getBindDnToUnconfigure()
public String getHostNameToStatusOrDefault()
public String getHostNameToInitializeAllOrDefault()
public String getHostNameSource()
public String getHostNameSourceOrDefault()
public String getHostNameDestination()
public String getHostNameDestinationOrDefault()
public int getPortSource()
public int getPortSourceOrDefault()
public int getPortDestination()
public int getPortDestinationOrDefault()
public int getPortToUnconfigure()
public int getPortToUnconfigureOrDefault()
public int getPortToInitializeAllOrDefault()
public int getPortToStatusOrDefault()
public List<String> getBaseDNs()
public String getConfigFile()
public SecureConnectionCliArgs getSecureArgsList()
public TaskScheduleArgs getTaskArgsList()
public int getMaximumDuration()
public int getMaximumDurationOrDefault()
public int getResetChangeNumber()
public void setResetChangeNumber(String changeNumber)
changeNumber
- the new value of the optionCopyright © 2010-2017 ForgeRock AS. All Rights Reserved.