public abstract class SecureConnectionCliParser extends com.forgerock.opendj.cli.SubCommandArgumentParser
Modifier and Type | Field and Description |
---|---|
protected com.forgerock.opendj.cli.BooleanArgument |
noPropertiesFileArg
The argument which should be used to indicate that we will not look for properties file.
|
protected com.forgerock.opendj.cli.StringArgument |
propertiesFileArg
Argument indicating a properties file argument.
|
protected SecureConnectionCliArgs |
secureArgsList
The secure args list object.
|
protected com.forgerock.opendj.cli.BooleanArgument |
verboseArg
The 'verbose' global argument.
|
Modifier | Constructor and Description |
---|---|
protected |
SecureConnectionCliParser(String mainClassName,
LocalizableMessage toolDescription)
Creates a new instance of this argument parser with no arguments.
|
Modifier and Type | Method and Description |
---|---|
protected Set<com.forgerock.opendj.cli.Argument> |
createGlobalArguments(OutputStream outStream,
boolean alwaysSSL)
Initialize Global option.
|
String |
getAdministratorUID()
Returns the Administrator UID provided in the command-line.
|
String |
getBindDN()
Get the bindDN which has to be used for the command.
|
String |
getBindPassword()
Gets the password which has to be used for the command without prompting
the user.
|
int |
getConnectTimeout()
Returns the timeout to be used to connect in milliseconds.
|
String |
getHostName()
Get the host name which has to be used for the command.
|
String |
getPort()
Get the port which has to be used for the command.
|
ApplicationTrustManager |
getTrustManager()
Handle TrustStore.
|
protected void |
initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args)
Initialize the global options with the provided set of arguments.
|
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 |
isVerbose()
Indicate if the verbose mode is required.
|
int |
validateGlobalOptions(LocalizableMessageBuilder buf)
Indication if provided global options are validate.
|
int |
validateGlobalOptions(PrintStream err)
Indication if provided global options are validate.
|
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
protected com.forgerock.opendj.cli.BooleanArgument verboseArg
protected SecureConnectionCliArgs secureArgsList
protected com.forgerock.opendj.cli.StringArgument propertiesFileArg
protected com.forgerock.opendj.cli.BooleanArgument noPropertiesFileArg
protected SecureConnectionCliParser(String mainClassName, LocalizableMessage toolDescription)
mainClassName
- The fully-qualified name of the Java class that should
be invoked to launch the program with which this
argument parser is associated.toolDescription
- A human-readable description for the tool, which will be
included when displaying usage information.public String getBindDN()
public String getAdministratorUID()
public String getBindPassword()
protected final Set<com.forgerock.opendj.cli.Argument> createGlobalArguments(OutputStream outStream, boolean alwaysSSL)
outStream
- The output stream used for the usage.alwaysSSL
- If true, always use the SSL connection type. In this case,
the arguments useSSL and startTLS are not present.protected void initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args)
args
- the arguments to use to initialize the global options.protected void initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args, com.forgerock.opendj.cli.ArgumentGroup argGroup)
args
- the arguments to use to initialize the global options.argGroup
- to which args will be addedpublic String getHostName()
public String getPort()
public int validateGlobalOptions(LocalizableMessageBuilder buf)
buf
- The LocalizableMessageBuilder
to write the error message.public int validateGlobalOptions(PrintStream err)
err
- The stream to be used to print error message.public boolean isVerbose()
public ApplicationTrustManager getTrustManager()
public int getConnectTimeout() throws IllegalStateException
0
if there is no timeout.IllegalStateException
- if the method is called before parsing the arguments.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.