org.opends.server.admin.client.cli

Class SecureConnectionCliArgs

java.lang.Object

org.opends.server.admin.client.cli.SecureConnectionCliArgs

public final class SecureConnectionCliArgs
extends Object

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
com.forgerock.opendj.cli.StringArgument	adminUidArg The 'adminUID' global argument.
com.forgerock.opendj.cli.StringArgument	bindDnArg The 'bindDN' global argument.
com.forgerock.opendj.cli.StringArgument	bindPasswordArg The 'bindPassword' global argument.
com.forgerock.opendj.cli.FileBasedArgument	bindPasswordFileArg The 'bindPasswordFile' global argument.
com.forgerock.opendj.cli.StringArgument	certNicknameArg The 'certNicknameArg' global argument.
com.forgerock.opendj.cli.IntegerArgument	connectTimeoutArg Argument to specify the connection timeout.
com.forgerock.opendj.cli.StringArgument	hostNameArg The 'hostName' global argument.
com.forgerock.opendj.cli.StringArgument	keyStorePasswordArg The 'keyStorePassword' global argument.
com.forgerock.opendj.cli.FileBasedArgument	keyStorePasswordFileArg The 'keyStorePasswordFile' global argument.
com.forgerock.opendj.cli.StringArgument	keyStorePathArg The 'keyStore' global argument.
com.forgerock.opendj.cli.IntegerArgument	portArg The 'port' global argument.
com.forgerock.opendj.cli.StringArgument	saslOptionArg Argument indicating a SASL option.
com.forgerock.opendj.cli.BooleanArgument	trustAllArg The 'trustAllArg' global argument.
com.forgerock.opendj.cli.StringArgument	trustStorePasswordArg The 'trustStorePassword' global argument.
com.forgerock.opendj.cli.FileBasedArgument	trustStorePasswordFileArg The 'trustStorePasswordFile' global argument.
com.forgerock.opendj.cli.StringArgument	trustStorePathArg The 'trustStore' global argument.
com.forgerock.opendj.cli.BooleanArgument	useSSLArg The 'useSSLArg' global argument.
com.forgerock.opendj.cli.BooleanArgument	useStartTLSArg The 'useStartTLSArg' global argument.

Constructor Summary

Constructors

Constructor and Description
SecureConnectionCliArgs(boolean alwaysSSL) Creates a new instance of secure arguments.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	alwaysSSL() Indicate if the SSL mode is always used.
boolean	argumentsPresent() Indicates whether or not any of the arguments are present.
Set<com.forgerock.opendj.cli.Argument>	createGlobalArguments() Initialize Global option.
String	getAdministratorUID() Get the admin UID which has to be used for the command.
int	getAdminPortFromConfig() Returns the admin port from the configuration.
String	getBindDN() Get the bindDN which has to be used for the command.
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.
int	getPortFromConfig() Returns the port to be used according to the configuration and the arguments provided by the user.
ApplicationTrustManager	getTrustManager() Handle TrustStore.
String	getTruststoreFileFromConfig() Returns the absolute path of the trust store file that appears on the config.
void	initArgumentsWithConfiguration() Updates the default values of the port and the trust store with what is read in the configuration.
boolean	useAdminUID() Tells whether this parser uses the Administrator UID (instead of the bind DN) or not.
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.

Methods inherited from class java.lang.Object

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

Field Detail

hostNameArg

public com.forgerock.opendj.cli.StringArgument hostNameArg

The 'hostName' global argument.

portArg

public com.forgerock.opendj.cli.IntegerArgument portArg

The 'port' global argument.

bindDnArg

public com.forgerock.opendj.cli.StringArgument bindDnArg

The 'bindDN' global argument.

adminUidArg

public com.forgerock.opendj.cli.StringArgument adminUidArg

The 'adminUID' global argument.

bindPasswordFileArg

public com.forgerock.opendj.cli.FileBasedArgument bindPasswordFileArg

The 'bindPasswordFile' global argument.

bindPasswordArg

public com.forgerock.opendj.cli.StringArgument bindPasswordArg

The 'bindPassword' global argument.

trustAllArg

public com.forgerock.opendj.cli.BooleanArgument trustAllArg

The 'trustAllArg' global argument.

trustStorePathArg

public com.forgerock.opendj.cli.StringArgument trustStorePathArg

The 'trustStore' global argument.

trustStorePasswordArg

public com.forgerock.opendj.cli.StringArgument trustStorePasswordArg

The 'trustStorePassword' global argument.

trustStorePasswordFileArg

public com.forgerock.opendj.cli.FileBasedArgument trustStorePasswordFileArg

The 'trustStorePasswordFile' global argument.

keyStorePathArg

public com.forgerock.opendj.cli.StringArgument keyStorePathArg

The 'keyStore' global argument.

keyStorePasswordArg

public com.forgerock.opendj.cli.StringArgument keyStorePasswordArg

The 'keyStorePassword' global argument.

keyStorePasswordFileArg

public com.forgerock.opendj.cli.FileBasedArgument keyStorePasswordFileArg

The 'keyStorePasswordFile' global argument.

certNicknameArg

public com.forgerock.opendj.cli.StringArgument certNicknameArg

The 'certNicknameArg' global argument.

useSSLArg

public com.forgerock.opendj.cli.BooleanArgument useSSLArg

The 'useSSLArg' global argument.

useStartTLSArg

public com.forgerock.opendj.cli.BooleanArgument useStartTLSArg

The 'useStartTLSArg' global argument.

saslOptionArg

public com.forgerock.opendj.cli.StringArgument saslOptionArg

Argument indicating a SASL option.

connectTimeoutArg

public com.forgerock.opendj.cli.IntegerArgument connectTimeoutArg

Argument to specify the connection timeout.

Constructor Detail

SecureConnectionCliArgs

public SecureConnectionCliArgs(boolean alwaysSSL)

Creates a new instance of secure arguments.

Parameters:

alwaysSSL - If true, always use the SSL connection type. In this case, the arguments useSSL and startTLS are not present.

Method Detail

argumentsPresent

public boolean argumentsPresent()

Indicates whether or not any of the arguments are present.

Returns:

boolean where true indicates that at least one of the arguments is present

getAdministratorUID

public String getAdministratorUID()

Get the admin UID which has to be used for the command.

Returns:

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

useAdminUID

public boolean useAdminUID()

Tells whether this parser uses the Administrator UID (instead of the bind DN) or not.

Returns:

true if this parser uses the Administrator UID and false otherwise.

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.

createGlobalArguments

public Set<com.forgerock.opendj.cli.Argument> createGlobalArguments()
                                                             throws com.forgerock.opendj.cli.ArgumentException

Initialize Global option.

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.

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.

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

alwaysSSL

public boolean alwaysSSL()

Indicate if the SSL mode is always used.

Returns:

True if SSL mode is always used.

getTrustManager

public ApplicationTrustManager getTrustManager()

Handle TrustStore.

Returns:

The trustStore manager to be used for the command.

getTruststoreFileFromConfig

public String getTruststoreFileFromConfig()
                                   throws org.forgerock.opendj.config.server.ConfigException

Returns the absolute path of the trust store file that appears on the config. Returns null if the trust store is not defined or it does not exist.

Returns:

the absolute path of the trust store file that appears on the config.

Throws:

org.forgerock.opendj.config.server.ConfigException - if there is an error reading the configuration.

getAdminPortFromConfig

public int getAdminPortFromConfig()
                           throws org.forgerock.opendj.config.server.ConfigException

Returns the admin port from the configuration.

Returns:

the admin port from the configuration.

Throws:

org.forgerock.opendj.config.server.ConfigException - if an error occurs reading the configuration.

getPortFromConfig

public int getPortFromConfig()

Returns the port to be used according to the configuration and the arguments provided by the user. This method should be called after the arguments have been parsed.

Returns:

the port to be used according to the configuration and the arguments provided by the user.

initArgumentsWithConfiguration

public void initArgumentsWithConfiguration()
                                    throws org.forgerock.opendj.config.server.ConfigException

Updates the default values of the port and the trust store with what is read in the configuration.

Throws:

org.forgerock.opendj.config.server.ConfigException - if there is an error reading the configuration.