public class StatusCliArgumentParser extends SecureConnectionCliParser
noPropertiesFileArg, propertiesFileArg, secureArgsList, showUsageArg, verboseArg| Constructor and Description |
|---|
StatusCliArgumentParser(String mainClassName)
Creates a new instance of this argument parser with no arguments.
|
| Modifier and Type | Method and Description |
|---|---|
String |
getDefaultBindDn()
Returns the bind DN default value.
|
String |
getExplicitBindDn()
Returns the bind DN explicitly provided in the command-line.
|
int |
getRefreshPeriod()
Returns the refresh period (in seconds) specified in the command-line.
|
void |
initializeGlobalArguments(OutputStream outStream)
Initialize Global option.
|
boolean |
isInteractive()
Tells whether the user specified to have an interactive status CLI or not.
|
boolean |
isScriptFriendly()
Tells whether the user specified to have a script-friendly output or not.
|
createGlobalArguments, getAdministratorUID, getBindDN, getBindPassword, getBindPassword, getBindPassword, getConnectTimeout, getHostName, getPort, getTrustManager, initializeGlobalArguments, initializeGlobalArguments, isVerbose, useSSL, useStartTLS, validateGlobalOptions, validateGlobalOptionsaddGlobalArgument, addGlobalArgument, addLdapConnectionArgument, getGlobalArgument, getGlobalArgumentForLongID, getGlobalArgumentForShortID, getGlobalArgumentList, getGlobalArgumentsByLongID, getGlobalArgumentsByShortID, getSubCommand, getSubCommand, getSubCommands, getSubCommandUsage, getUsage, hasGlobalArgument, hasGlobalArgumentWithLongID, hasGlobalArgumentWithShortID, hasSubCommand, parseArguments, removeGlobalArgument, setUsageArgument, setUsageGroupArgument, setUsageHandleraddArgument, 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, usageOrVersionDisplayedpublic StatusCliArgumentParser(String mainClassName)
mainClassName - The fully-qualified name of the Java class that should
be invoked to launch the program with which this
argument parser is associated.public void initializeGlobalArguments(OutputStream outStream) throws com.forgerock.opendj.cli.ArgumentException
outStream - The output stream used for the usage.com.forgerock.opendj.cli.ArgumentException - If there is a problem with any of the parameters used
to create this argument.public boolean isInteractive()
true if the user specified to have an interactive
status CLI and false otherwise.public boolean isScriptFriendly()
true if the user specified to have a script-friendly
output and false otherwise.public int getRefreshPeriod()
public String getExplicitBindDn()
null if no bind DN was explicitly provided.public String getDefaultBindDn()
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.