org.opends.server.admin.client.cli

Class SecureConnectionCliParser

java.lang.Object

com.forgerock.opendj.cli.ArgumentParser

com.forgerock.opendj.cli.SubCommandArgumentParser

org.opends.server.admin.client.cli.SecureConnectionCliParser

All Implemented Interfaces:

com.forgerock.opendj.cli.ToolRefDocContainer

Direct Known Subclasses:

ReplicationCliArgumentParser, StatusCliArgumentParser, UninstallerArgumentParser

public abstract class SecureConnectionCliParser
extends com.forgerock.opendj.cli.SubCommandArgumentParser

This is a commodity class that can be used to check the arguments required to establish a secure connection in the command line. It can be used to generate an ApplicationTrustManager object based on the options provided by the user in the command line.

Field Summary

Fields

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	showUsageArg The 'showUsage' global argument.
protected com.forgerock.opendj.cli.BooleanArgument	verboseArg The 'verbose' global argument.

Fields inherited from class com.forgerock.opendj.cli.ArgumentParser

argumentGroups, DEFAULT_OPENDJ_CONFIG_DIR, DEFAULT_OPENDJ_PROPERTIES_FILE_EXTENSION, DEFAULT_OPENDJ_PROPERTIES_FILE_NAME, ioArgGroup, PROPERTY_SCRIPT_NAME, PROPERTY_SCRIPT_NAME_LEGACY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecureConnectionCliParser(String mainClassName, LocalizableMessage toolDescription, boolean longArgumentsCaseSensitive) Creates a new instance of this argument parser with no arguments.

Method Summary

Methods

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.
String	getBindPassword(String dn, OutputStream out, OutputStream err) Gets the password which has to be used for the command.
protected String	getBindPassword(String dn, OutputStream out, OutputStream err, com.forgerock.opendj.cli.StringArgument pwdArg, com.forgerock.opendj.cli.FileBasedArgument fileArg) Get the password which has to be used for the command.
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.
boolean	useSSL() Indicate if the SSL mode is required.
boolean	useStartTLS() Indicate if the startTLS 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.

Methods inherited from class com.forgerock.opendj.cli.SubCommandArgumentParser

addGlobalArgument, addGlobalArgument, addLdapConnectionArgument, getGlobalArgument, getGlobalArgumentForLongID, getGlobalArgumentForShortID, getGlobalArgumentList, getGlobalArgumentsByLongID, getGlobalArgumentsByShortID, getSubCommand, getSubCommand, getSubCommands, getSubCommandUsage, getUsage, hasGlobalArgument, hasGlobalArgumentWithLongID, hasGlobalArgumentWithShortID, hasSubCommand, parseArguments, removeGlobalArgument, setUsageArgument, setUsageGroupArgument, setUsageHandler

Methods inherited from class com.forgerock.opendj.cli.ArgumentParser

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

showUsageArg

protected com.forgerock.opendj.cli.BooleanArgument showUsageArg

The 'showUsage' global argument.

verboseArg

protected com.forgerock.opendj.cli.BooleanArgument verboseArg

The 'verbose' global argument.

secureArgsList

protected SecureConnectionCliArgs secureArgsList

The secure args list object.

propertiesFileArg

protected com.forgerock.opendj.cli.StringArgument propertiesFileArg

Argument indicating a properties file argument.

noPropertiesFileArg

protected com.forgerock.opendj.cli.BooleanArgument noPropertiesFileArg

The argument which should be used to indicate that we will not look for properties file.

Constructor Detail

SecureConnectionCliParser

protected SecureConnectionCliParser(String mainClassName,
                         LocalizableMessage toolDescription,
                         boolean longArgumentsCaseSensitive)

Creates a new instance of this argument parser with no arguments.

Parameters:

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.

longArgumentsCaseSensitive - Indicates whether subcommand and long argument names should be treated in a case-sensitive manner.

Method Detail

getBindDN

public String getBindDN()

Get the bindDN which has to be used for the command.

Returns:

The bindDN specified by the command line argument, or the default value, if not specified.

getAdministratorUID

public String getAdministratorUID()

Returns the Administrator UID provided in the command-line.

Returns:

the Administrator UID provided in the command-line.

getBindPassword

protected String getBindPassword(String dn,
                     OutputStream out,
                     OutputStream err,
                     com.forgerock.opendj.cli.StringArgument pwdArg,
                     com.forgerock.opendj.cli.FileBasedArgument fileArg)

Get the password which has to be used for the command.

Parameters:

dn - The user DN for which to password could be asked.

out - The input stream to used if we have to prompt to the user.

err - The error stream to used if we have to prompt to the user.

pwdArg - The password StringArgument argument.

fileArg - The password FileBased argument.

Returns:

The password stored into the specified file on by the command line argument, or prompts it if not specified.

getBindPassword

public String getBindPassword(String dn,
                     OutputStream out,
                     OutputStream err)

Gets the password which has to be used for the command.

Parameters:

dn - The user DN for which to password could be asked.

out - The input stream to used if we have to prompt to the user.

err - The error stream to used if we have to prompt to the user.

Returns:

The password stored into the specified file on by the command line argument, or prompts it if not specified.

getBindPassword

public String getBindPassword()

Gets the password which has to be used for the command without prompting the user. If no password was specified, return null.

Returns:

The password stored into the specified file on by the command line argument, or null it if not specified.

createGlobalArguments

protected Set<com.forgerock.opendj.cli.Argument> createGlobalArguments(OutputStream outStream,
                                                           boolean alwaysSSL)
                                                                throws com.forgerock.opendj.cli.ArgumentException

Initialize Global option.

Parameters:

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.

Returns:

a ArrayList with the options created.

Throws:

com.forgerock.opendj.cli.ArgumentException - If there is a problem with any of the parameters used to create this argument.

initializeGlobalArguments

protected void initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args)
                                  throws com.forgerock.opendj.cli.ArgumentException

Initialize the global options with the provided set of arguments.

Parameters:

args - the arguments to use to initialize the global options.

Throws:

com.forgerock.opendj.cli.ArgumentException - if there is a conflict with the provided arguments.

initializeGlobalArguments

protected void initializeGlobalArguments(Collection<com.forgerock.opendj.cli.Argument> args,
                             com.forgerock.opendj.cli.ArgumentGroup argGroup)
                                  throws com.forgerock.opendj.cli.ArgumentException

Initialize the global options with the provided set of arguments.

Parameters:

args - the arguments to use to initialize the global options.

argGroup - to which args will be added

Throws:

com.forgerock.opendj.cli.ArgumentException - if there is a conflict with the provided arguments.

getHostName

public String getHostName()

Get the host name which has to be used for the command.

Returns:

The host name specified by the command line argument, or the default value, if not specified.

getPort

public String getPort()

Get the port which has to be used for the command.

Returns:

The port specified by the command line argument, or the default value, if not specified.

validateGlobalOptions

public int validateGlobalOptions(LocalizableMessageBuilder buf)

Indication if provided global options are validate.

Parameters:

buf - the LocalizableMessageBuilder to write the error messages.

Returns:

return code.

validateGlobalOptions

public int validateGlobalOptions(PrintStream err)

Indication if provided global options are validate.

Parameters:

err - the stream to be used to print error message.

Returns:

return code.

isVerbose

public boolean isVerbose()

Indicate if the verbose mode is required.

Returns:

True if verbose mode is required

useSSL

public boolean useSSL()

Indicate if the SSL mode is required.

Returns:

True if SSL mode is required

useStartTLS

public boolean useStartTLS()

Indicate if the startTLS mode is required.

Returns:

True if startTLS mode is required

getTrustManager

public ApplicationTrustManager getTrustManager()

Handle TrustStore.

Returns:

The trustStore manager to be used for the command.

getConnectTimeout

public int getConnectTimeout()
                      throws IllegalStateException

Returns the timeout to be used to connect in milliseconds. The method must be called after parsing the arguments.

Returns:

the timeout to be used to connect in milliseconds. Returns 0 if there is no timeout.

Throws:

IllegalStateException - if the method is called before parsing the arguments.