org.opends.server.util.args

Class LDAPConnectionArgumentParser

java.lang.Object

com.forgerock.opendj.cli.ArgumentParser

org.opends.server.util.args.LDAPConnectionArgumentParser

All Implemented Interfaces:

com.forgerock.opendj.cli.ToolRefDocContainer

public class LDAPConnectionArgumentParser
extends com.forgerock.opendj.cli.ArgumentParser

Creates an argument parser pre-populated with arguments for specifying information for opening and LDAPConnection an LDAP connection.

Field Summary

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

Constructor and Description
LDAPConnectionArgumentParser(String mainClassName, LocalizableMessage toolDescription, boolean longArgumentsCaseSensitive, com.forgerock.opendj.cli.ArgumentGroup argumentGroup, boolean alwaysSSL) Creates a new instance of this argument parser with no arguments.

Method Summary

Methods

Modifier and Type	Method and Description
LDAPConnection	connect(LDAPConnectionConsoleInteraction ui, PrintStream out, PrintStream err) Creates a connection using a console interaction that will be used to potentially interact with the user to prompt for necessary information for establishing the connection.
LDAPConnection	connect(PrintStream out, PrintStream err) Creates a new LDAPConnection and invokes a connect operation using information provided in the parsed set of arguments that were provided by the user.
LDAPConnection	connect(String host, int port, String bindDN, String bindPw, LDAPConnectionOptions options, int timeout, PrintStream out, PrintStream err) Creates a connection from information provided.
LDAPConnection	connect(String host, int port, String bindDN, String bindPw, LDAPConnectionOptions options, PrintStream out, PrintStream err) Creates a connection from information provided.
boolean	connectionArgumentsPresent() Indicates whether or not the user has indicated that they would like to perform a remote operation based on the arguments.
SecureConnectionCliArgs	getArguments() Gets the arguments associated with this parser.
static String	getPasswordValue(com.forgerock.opendj.cli.StringArgument bindPwdArg, com.forgerock.opendj.cli.FileBasedArgument bindPwdFileArg, com.forgerock.opendj.cli.StringArgument bindDnArg, PrintStream out, PrintStream err) Commodity method that retrieves the password value analyzing the contents of a string argument and of a file based argument.
static String	getPasswordValue(com.forgerock.opendj.cli.StringArgument bindPassword, com.forgerock.opendj.cli.FileBasedArgument bindPasswordFile, String bindDNValue, PrintStream out, PrintStream err) Commodity method that retrieves the password value analyzing the contents of a string argument and of a file based argument.

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

addArgument, addArgument, addDefaultArgument, addLdapConnectionArgument, displayMessageAndUsageReference, getArgumentForLongID, getArgumentList, getBindPassword, getDocSubcommandsDescriptionSupplement, getDocToolDescriptionSupplement, getHelpUsageReference, getOptionsRefSect1, getShortToolDescription, getTrailingArguments, getUsage, getUsageMessage, isUsageArgumentPresent, isVersionArgumentPresent, parseArguments, parseArguments, parseArguments, setDocSubcommandsDescriptionSupplement, setDocToolDescriptionSupplement, setFilePropertiesArgument, setNoPropertiesFileArgument, setShortToolDescription, setUsageArgument, setUsageArgument, setUsageOrVersionDisplayed, setVersionHandler, usageOrVersionDisplayed

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPConnectionArgumentParser

public LDAPConnectionArgumentParser(String mainClassName,
                            LocalizableMessage toolDescription,
                            boolean longArgumentsCaseSensitive,
                            com.forgerock.opendj.cli.ArgumentGroup argumentGroup,
                            boolean alwaysSSL)

Creates a new instance of this argument parser with no arguments. Unnamed trailing arguments will not be allowed.

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 long arguments should

argumentGroup - Group to which LDAP arguments will be added to the parser. May be null to indicate that arguments should be added to the default group

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

Method Detail

connectionArgumentsPresent

public boolean connectionArgumentsPresent()

Indicates whether or not the user has indicated that they would like to perform a remote operation based on the arguments.

Returns:

true if the user wants to perform a remote operation; false otherwise

connect

public LDAPConnection connect(PrintStream out,
                     PrintStream err)
                       throws LDAPConnectionException,
                              com.forgerock.opendj.cli.ArgumentException

Creates a new LDAPConnection and invokes a connect operation using information provided in the parsed set of arguments that were provided by the user.

Parameters:

out - stream to write messages

err - stream to write error messages

Returns:

LDAPConnection created by this class from parsed arguments

Throws:

LDAPConnectionException - if there was a problem connecting to the server indicated by the input arguments

com.forgerock.opendj.cli.ArgumentException - if there was a problem processing the input arguments

connect

public LDAPConnection connect(LDAPConnectionConsoleInteraction ui,
                     PrintStream out,
                     PrintStream err)
                       throws LDAPConnectionException,
                              com.forgerock.opendj.cli.ArgumentException

Creates a connection using a console interaction that will be used to potentially interact with the user to prompt for necessary information for establishing the connection.

Parameters:

ui - user interaction for prompting the user

out - stream to write messages

err - stream to write error messages

Returns:

LDAPConnection created by this class from parsed arguments

Throws:

LDAPConnectionException - if there was a problem connecting to the server

com.forgerock.opendj.cli.ArgumentException - if there was a problem indicated by the input arguments

connect

public LDAPConnection connect(String host,
                     int port,
                     String bindDN,
                     String bindPw,
                     LDAPConnectionOptions options,
                     PrintStream out,
                     PrintStream err)
                       throws LDAPConnectionException

Creates a connection from information provided.

Parameters:

host - of the server

port - of the server

bindDN - with which to connect

bindPw - with which to connect

options - with which to connect

out - stream to write messages

err - stream to write error messages

Returns:

LDAPConnection created by this class from parsed arguments

Throws:

LDAPConnectionException - if there was a problem connecting to the server indicated by the input arguments

connect

public LDAPConnection connect(String host,
                     int port,
                     String bindDN,
                     String bindPw,
                     LDAPConnectionOptions options,
                     int timeout,
                     PrintStream out,
                     PrintStream err)
                       throws LDAPConnectionException

Creates a connection from information provided.

Parameters:

host - of the server

port - of the server

bindDN - with which to connect

bindPw - with which to connect

options - with which to connect

timeout - the timeout to establish the connection in milliseconds. Use 0 to express no timeout

out - stream to write messages

err - stream to write error messages

Returns:

LDAPConnection created by this class from parsed arguments

Throws:

LDAPConnectionException - if there was a problem connecting to the server indicated by the input arguments

getArguments

public SecureConnectionCliArgs getArguments()

Gets the arguments associated with this parser.

Returns:

arguments for this parser.

getPasswordValue

public static String getPasswordValue(com.forgerock.opendj.cli.StringArgument bindPwdArg,
                      com.forgerock.opendj.cli.FileBasedArgument bindPwdFileArg,
                      com.forgerock.opendj.cli.StringArgument bindDnArg,
                      PrintStream out,
                      PrintStream err)

Commodity method that retrieves the password value analyzing the contents of a string argument and of a file based argument. It assumes that the arguments have already been parsed and validated. If the string is a dash, or no password is available, it will prompt for it on the command line.

Parameters:

bindPwdArg - the string argument for the password.

bindPwdFileArg - the file based argument for the password.

bindDnArg - the string argument for the bindDN.

out - stream to write message.

err - stream to write error message.

Returns:

the password value.

getPasswordValue

public static String getPasswordValue(com.forgerock.opendj.cli.StringArgument bindPassword,
                      com.forgerock.opendj.cli.FileBasedArgument bindPasswordFile,
                      String bindDNValue,
                      PrintStream out,
                      PrintStream err)
                               throws com.forgerock.opendj.cli.ClientException

Commodity method that retrieves the password value analyzing the contents of a string argument and of a file based argument. It assumes that the arguments have already been parsed and validated. If the string is a dash, or no password is available, it will prompt for it on the command line.

Parameters:

bindPassword - the string argument for the password.

bindPasswordFile - the file based argument for the password.

bindDNValue - the string value for the bindDN.

out - stream to write message.

err - stream to write error message.

Returns:

the password value.

Throws:

com.forgerock.opendj.cli.ClientException - if the password cannot be read