OPENDJ-2701 Code cleanup

Gaetan Boismal

24.51.2016 0f698970acc441f4c6fa39b8fce19929a07eea17

OPENDJ-2701 Code cleanup

Move LDAPConnectionArgumentParser into org.opends.server.util.cli and
remove package org.opends.server.util.args

 opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java

@@ -62,7 +62,7 @@
import org.opends.server.types.InitializationException;
import org.opends.server.types.NullOutputStream;
import org.opends.server.types.RawAttribute;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/ExportLDIF.java

@@ -59,7 +59,7 @@
import org.opends.server.types.NullOutputStream;
import org.opends.server.types.RawAttribute;
import org.opends.server.types.SearchFilter;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/ImportLDIF.java

@@ -65,7 +65,7 @@
import org.opends.server.types.NullOutputStream;
import org.opends.server.types.RawAttribute;
import org.opends.server.types.SearchFilter;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPCompare.java

@@ -23,7 +23,7 @@

import static org.opends.messages.ToolMessages.*;
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.util.args.LDAPConnectionArgumentParser.*;
import static org.opends.server.util.cli.LDAPConnectionArgumentParser.*;

import java.io.BufferedReader;
import java.io.FileReader;

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPDelete.java

@@ -23,7 +23,7 @@

import static org.opends.messages.ToolMessages.*;
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.util.args.LDAPConnectionArgumentParser.*;
import static org.opends.server.util.cli.LDAPConnectionArgumentParser.*;

import java.io.BufferedReader;
import java.io.FileReader;

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPModify.java

@@ -25,7 +25,7 @@
import static org.opends.messages.ToolMessages.*;
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.args.LDAPConnectionArgumentParser.*;
import static org.opends.server.util.cli.LDAPConnectionArgumentParser.*;

import java.io.FileInputStream;
import java.io.FileNotFoundException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPSearch.java

@@ -25,7 +25,7 @@
import static org.opends.server.protocols.ldap.LDAPResultCode.*;
import static org.opends.server.util.ServerConstants.*;
import static org.opends.server.util.StaticUtils.*;
import static org.opends.server.util.args.LDAPConnectionArgumentParser.*;
import static org.opends.server.util.cli.LDAPConnectionArgumentParser.*;

import java.io.BufferedReader;
import java.io.FileReader;

 opendj-server-legacy/src/main/java/org/opends/server/tools/ManageAccount.java

@@ -54,7 +54,7 @@
import org.opends.server.protocols.ldap.LDAPResultCode;
import org.opends.server.types.NullOutputStream;
import org.opends.server.util.EmbeddedUtils;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/ManageTasks.java

@@ -27,7 +27,7 @@
import org.opends.server.types.LDAPException;
import org.opends.server.util.BuildVersion;
import org.opends.server.util.StaticUtils;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionConsoleInteraction;

import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/RebuildIndex.java

@@ -56,7 +56,7 @@
import org.opends.server.types.NullOutputStream;
import org.opends.server.types.RawAttribute;
import org.opends.server.util.StaticUtils;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.ArgumentException;
import com.forgerock.opendj.cli.BooleanArgument;

 opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java

@@ -60,7 +60,7 @@
import org.opends.server.types.NullOutputStream;
import org.opends.server.types.RawAttribute;
import org.opends.server.types.RestoreConfig;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/tools/StopDS.java

@@ -66,7 +66,7 @@
import org.opends.server.types.LDAPException;
import org.opends.server.types.NullOutputStream;
import org.opends.server.types.RawAttribute;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentConstants;

 opendj-server-legacy/src/main/java/org/opends/server/tools/tasks/TaskTool.java

@@ -44,7 +44,7 @@
import org.opends.server.types.LDAPException;
import org.opends.server.types.OpenDsException;
import org.opends.server.util.BuildVersion;
import org.opends.server.util.args.LDAPConnectionArgumentParser;
import org.opends.server.util.cli.LDAPConnectionArgumentParser;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/util/cli/LDAPConnectionArgumentParser.java

File was renamed from opendj-server-legacy/src/main/java/org/opends/server/util/args/LDAPConnectionArgumentParser.java
@@ -14,7 +14,7 @@
 * Copyright 2008-2010 Sun Microsystems, Inc.
 * Portions Copyright 2011-2016 ForgeRock AS.
 */
package org.opends.server.util.args;
package org.opends.server.util.cli;

import static org.opends.messages.ToolMessages.*;

@@ -36,7 +36,6 @@
import org.opends.server.tools.SSLConnectionException;
import org.opends.server.tools.SSLConnectionFactory;
import org.opends.server.types.OpenDsException;
import org.opends.server.util.cli.LDAPConnectionConsoleInteraction;

import com.forgerock.opendj.cli.Argument;
import com.forgerock.opendj.cli.ArgumentException;

 opendj-server-legacy/src/main/java/org/opends/server/util/cli/package-info.java

@@ -12,17 +12,76 @@
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2006-2008 Sun Microsystems, Inc.
 * Portions Copyright 2016 ForgeRock AS.
 */

/**
 * Provides a high-level framework for implementing command-line
 * tools.
 * Provides a high-level framework for implementing command-line tools.
 * <p>
 * The {@link ConsoleApplication} interface can be used as a basis for
 * The {@code LDAPConnectionArgumentParser} provides an implementation of
 * an utility that can manage the processing of command-line arguments for
 * an application.
 * This class centralizes a significant amount of processing so that it does
 * not need to be repeated in all tools requiring this kind of functionality,
 * as well as helping to ensure that the interaction with program arguments
 * is in compliance with Sun's CLIP specification.
 * <BR><BR>
 * Features offered by this argument parsing implementation include:
 * <BR>
 * <UL>
 *   <LI>
 *     Arguments can be denoted using either a single dash followed by a single
 *     character or two dashes followed by a more verbose multi-character
 *     token.
 *   </LI>
 *   <LI>
 *     The parsing performed on these arguments is very lenient so that it will
 *     likely be compatible with the style preferred by the end user.
 *   </LI>
 *   <LI>
 *     Arguments are declared with or without a value, and the parser can be
 *     used to ensure that a value is provided for arguments that require one.
 *   </LI>
 *   <LI>
 *     Each type of argument is associated with a particular data type, and a
 *     minimal amount of validation can be handled by the argument parser itself
 *     in this case (e.g., if an argument is associated with an integer type,
 *     then non-numeric values will be rejected, and it is also possible to
 *     define an acceptable range of values).
 *   </LI>
 *   <LI>
 *     The argument parser contains a built-in mechanism for ensuring that there
 *     are no conflicts between option names (i.e., it ensures that two
 *     different arguments don't both try to use "-x" to invoke them).
 *   </LI>
 *   <LI>
 *     The argument parser contains a mechanism for allowing "extra" arguments
 *     at the end of the list which are not explicitly associated with
 *     parameters.  For example, in the ldapsearch utility, at least one of
 *     these "extra" arguments would be used for the filter, and if there are
 *     any more of them then they would be used for the list of attributes to
 *     return.
 *   </LI>
 *   <LI>
 *     The argument parser itself can generate usage information in a consistent
 *     manner so that it is not necessary for each command-line application to
 *     explicitly provide this functionality.
 *   </LI>
 * </UL>
 * <BR>
 * A second version of the argument parser is also available which does not
 * include support for trailing arguments but does include support for
 * the use of subcommands.  In this case, you can define a number of subcommands
 * each with their own set of arguments.  This can be used for cases in which
 * one umbrella utility has a number of different capabilities (e.g., the "cvs"
 * command has a number of sub-commands like "checkout" and "commit" and "diff",
 * each of which has its own set of options).
 * <p>
 * The {@code ConsoleApplication} interface can be used as a basis for
 * console based applications. It includes common utility methods for
 * interacting with the console.
 * <p>
 * The {@link MenuBuilder} and associated classes and interfaces can
 * The {@code MenuBuilder} and associated classes and interfaces can
 * be used to implement text based menu driven applications.
 */
@org.opends.server.types.PublicAPI(