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, showUsageArg, 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.
|
LinkedList<String> |
getBaseDNs()
Returns the list of base DNs provided by the user.
|
String |
getBindDNToDisable()
Returns the server bind dn explicitly provided in the disable 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 |
getConfigClass()
Returns the config class value provided in the hidden argument of the
command-line.
|
String |
getConfigFile()
Returns the config file value provided in the hidden argument of the
command-line.
|
String |
getDefaultBindDnToDisable()
Returns the server bind dn default value in the disable replication
subcommand.
|
String |
getDefaultHostNameToPostExternalInitialization()
Returns the host name default value in the post external initialization
subcommand.
|
String |
getDefaultHostNameToPreExternalInitialization()
Returns the host name default value in the pre external initialization
subcommand.
|
int |
getDefaultPortToPostExternalInitialization()
Returns the server port default value in the post external initialization
subcommand.
|
int |
getDefaultPortToPreExternalInitialization()
Returns the server port default value in the pre external initialization
subcommand.
|
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 |
getHostNameToDisableOrDefault()
Returns the host name default value in the disable replication
subcommand.
|
String |
getHostNameToInitializeAll()
Returns the host name explicitly provided in the initialize all replication
subcommand.
|
String |
getHostNameToInitializeAllOrDefault()
Returns the host name default value in the initialize all replication
subcommand.
|
String |
getHostNameToPostExternalInitialization()
Returns the host name explicitly provided in the post external
initialization subcommand.
|
String |
getHostNameToPreExternalInitialization()
Returns the host name explicitly provided in the pre external
initialization subcommand.
|
String |
getHostNameToStatus()
Returns the host name explicitly provided in the status replication
subcommand.
|
String |
getHostNameToStatusOrDefault()
Returns the host name default value in the status 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 |
getPortToDisable()
Returns the server port explicitly provided in the disable replication
subcommand.
|
int |
getPortToDisableOrDefault()
Returns the server port default value in the disable replication
subcommand.
|
int |
getPortToInitializeAll()
Returns the server port explicitly provided in the initialize all
replication subcommand.
|
int |
getPortToInitializeAllOrDefault()
Returns the server port default value in the initialize all replication
subcommand.
|
int |
getPortToPostExternalInitialization()
Returns the server port explicitly provided in the post external
initialization subcommand.
|
int |
getPortToPreExternalInitialization()
Returns the server port explicitly provided in the pre external
initialization subcommand.
|
int |
getPortToStatus()
Returns the server port explicitly provided in the status replication
subcommand.
|
int |
getPortToStatusOrDefault()
Returns the server port default value in the status 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 |
isDisableReplicationSubcommand()
Returns whether the user provided subcommand is the disable replication
or not.
|
boolean |
isEnableReplicationSubcommand()
Returns whether the user provided subcommand is the enable replication
or not.
|
boolean |
isInitializeAllReplicationSubcommand()
Returns whether the user provided subcommand is the initialize all
replication or not.
|
boolean |
isInitializeReplicationSubcommand()
Returns whether the user provided subcommand is the initialize replication
or not.
|
boolean |
isInteractive()
Tells whether the user specified to have an interactive operation or not.
|
boolean |
isPostExternalInitializationSubcommand()
Returns whether the user provided subcommand is the post external
initialization or not.
|
boolean |
isPreExternalInitializationSubcommand()
Returns whether the user provided subcommand is the pre external
initialization or not.
|
boolean |
isPurgeHistoricalSubcommand()
Returns whether the user provided subcommand is the purge historical
or not.
|
boolean |
isQuiet()
Tells whether the user specified to have a quite operation or not.
|
boolean |
isResetChangeNumber()
Returns whether the user specified the reset changelog numbering subcommand.
|
boolean |
isScriptFriendly()
Tells whether the user specified to have a script-friendly output or not.
|
boolean |
isStatusReplicationSubcommand()
Returns whether the user provided subcommand is the status replication
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, getBindPassword, getBindPassword, getConnectTimeout, getHostName, getPort, getTrustManager, initializeGlobalArguments, isVerbose, useSSL, useStartTLS, validateGlobalOptions
addGlobalArgument, addGlobalArgument, addLdapConnectionArgument, getGlobalArgument, getGlobalArgumentForLongID, getGlobalArgumentForShortID, getGlobalArgumentList, getGlobalArgumentsByLongID, getGlobalArgumentsByShortID, getSubCommand, getSubCommand, getSubCommands, getSubCommandUsage, getUsage, hasGlobalArgument, hasGlobalArgumentWithLongID, hasGlobalArgumentWithShortID, hasSubCommand, parseArguments, removeGlobalArgument, setUsageArgument, setUsageGroupArgument, setUsageHandler
addArgument, addArgument, addDefaultArgument, displayMessageAndUsageReference, getArgumentForLongID, getArgumentList, getBindPassword, getDocSubcommandsDescriptionSupplement, getDocToolDescriptionSupplement, getHelpUsageReference, getOptionsRefSect1, getShortToolDescription, getTrailingArguments, getUsageMessage, isUsageArgumentPresent, isVersionArgumentPresent, parseArguments, parseArguments, setDocSubcommandsDescriptionSupplement, setDocToolDescriptionSupplement, setFilePropertiesArgument, setNoPropertiesFileArgument, setShortToolDescription, setUsageArgument, setUsageOrVersionDisplayed, setVersionHandler, usageOrVersionDisplayed
public static final String INITIALIZE_ALL_REPLICATION_SUBCMD_NAME
public int validateGlobalOptions(LocalizableMessageBuilder buf)
validateGlobalOptions
in class SecureConnectionCliParser
buf
- the LocalizableMessageBuilder to write the error messages.protected void initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args, com.forgerock.opendj.cli.ArgumentGroup argGroup) throws com.forgerock.opendj.cli.ArgumentException
initializeGlobalArguments
in class SecureConnectionCliParser
args
- the arguments to use to initialize the global options.argGroup
- the group to which args will be added.com.forgerock.opendj.cli.ArgumentException
- if there is a conflict with the provided
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 getHostNameToDisableOrDefault()
public String getBindDNToDisable()
public String getDefaultBindDnToDisable()
public String getHostNameToStatus()
public String getHostNameToStatusOrDefault()
public String getHostNameToInitializeAll()
public String getHostNameToInitializeAllOrDefault()
public String getHostNameToPreExternalInitialization()
public String getDefaultHostNameToPreExternalInitialization()
public String getHostNameToPostExternalInitialization()
public String getDefaultHostNameToPostExternalInitialization()
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 getPortToDisable()
public int getPortToDisableOrDefault()
public int getPortToInitializeAll()
public int getPortToInitializeAllOrDefault()
public int getPortToPreExternalInitialization()
public int getDefaultPortToPreExternalInitialization()
public int getPortToPostExternalInitialization()
public int getDefaultPortToPostExternalInitialization()
public int getPortToStatus()
public int getPortToStatusOrDefault()
public LinkedList<String> getBaseDNs()
public String getConfigClass()
public String getConfigFile()
public boolean isEnableReplicationSubcommand()
true
if the user provided subcommand is the
enable replication and false
otherwise.public boolean isDisableReplicationSubcommand()
true
if the user provided subcommand is the
disable replication and false
otherwise.public boolean isResetChangeNumber()
true
if the user wanted to reset change numberpublic boolean isStatusReplicationSubcommand()
true
if the user provided subcommand is the
status replication and false
otherwise.public boolean isPurgeHistoricalSubcommand()
true
if the user provided subcommand is the
purge historical and false
otherwise.public boolean isInitializeAllReplicationSubcommand()
true
if the user provided subcommand is the
initialize all replication and false
otherwise.public boolean isPreExternalInitializationSubcommand()
true
if the user provided subcommand is the
pre external initialization and false
otherwise.public boolean isPostExternalInitializationSubcommand()
true
if the user provided subcommand is the
post external initialization and false
otherwise.public boolean isInitializeReplicationSubcommand()
true
if the user provided subcommand is the
initialize replication and false
otherwise.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-2016 ForgeRock AS. All Rights Reserved.