public class ControlPanelArgumentParser extends com.forgerock.opendj.cli.ArgumentParser
Constructor and Description |
---|
ControlPanelArgumentParser(String mainClassName,
LocalizableMessage msg)
The default constructor for this class.
|
Modifier and Type | Method and Description |
---|---|
String |
getBindPassword()
Get 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.
|
static int |
getDefaultAdministrationPort()
Returns the default value for the administration port.
|
static String |
getDefaultBindDN()
Returns the default bind DN.
|
String |
getExplicitBindDn()
Returns the bind DN explicitly provided in the command-line.
|
String |
getExplicitHostName()
Returns the host name explicitly provided in the command-line.
|
int |
getExplicitPort()
Returns the administration port explicitly provided in the command-line.
|
void |
initializeArguments()
Initializes the arguments without parsing them.
|
boolean |
isRemote()
Returns whether the user specified to connect to a remote server.
|
boolean |
isTrustAll()
Returns whether the user specified to trust all certificates or not.
|
addArgument, addArgument, addDefaultArgument, addLdapConnectionArgument, displayMessageAndUsageReference, getArgumentForLongId, getArgumentForShortId, getArguments, getBindPassword, getDocSubcommandsDescriptionSupplement, getDocToolDescriptionSupplement, getShortToolDescription, getTrailingArguments, getUsage, isUsageArgumentPresent, isVersionArgumentPresent, parseArguments, parseArguments, parseArguments, replaceArgument, setDocSubcommandsDescriptionSupplement, setDocToolDescriptionSupplement, setShortToolDescription, setUsageArgument, setUsageOrVersionDisplayed, setVersionHandler, usageOrVersionDisplayed
public ControlPanelArgumentParser(String mainClassName, LocalizableMessage msg)
mainClassName
- the class name of the main class for the command-line
that is being used.msg
- the usage message.public static int getDefaultAdministrationPort()
public static String getDefaultBindDN()
public void initializeArguments() throws com.forgerock.opendj.cli.ArgumentException
com.forgerock.opendj.cli.ArgumentException
- if there was an error creating or adding the
arguments. If this occurs is likely to be a bug.public String getExplicitHostName()
null
if no bind DN was explicitly provided.public int getExplicitPort()
public String getExplicitBindDn()
null
if no bind DN was explicitly provided.public String getBindPassword()
null
.null
if not specified.public boolean isTrustAll()
public int getConnectTimeout() throws IllegalStateException
0
if there is no timeout.IllegalStateException
- if the method is called before
parsing the arguments.public boolean isRemote()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.