Move the no option constant definition to ToolConstants. Refactor some code...

jvergara

29.54.2007 66ad41503e32e26e11405b497a9592d98e2d05a0

Move the no option constant definition to ToolConstants.
Refactor some code and put it in CliApplicationHelper.
Fix some minor bugs in the output of the command-lines.

 opends/src/guitools/org/opends/guitools/replicationcli/ReplicationCliMain.java

@@ -299,64 +299,11 @@
  }

  /**
   * Displays an error message in the error output (wrapping it if necessary).
   * @param msg the error message to be displayed.
   * {@inheritDoc}
   */
  protected void printErrorMessage(Message msg)
  protected boolean isQuiet()
  {
    err.println(org.opends.server.util.StaticUtils.wrapText(msg,
        Utils.getCommandLineMaxLineWidth()));
    LOG.log(Level.SEVERE, msg.toString());
  }

  /**
   * Displays a progress message in the error output (wrapping it if necessary).
   * @param msg the error message to be displayed.
   */
  protected void printProgressMessage(Message msg)
  {
    if (!argParser.isQuiet())
    {
      out.print(org.opends.server.util.StaticUtils.wrapText(msg,
          Utils.getCommandLineMaxLineWidth()));
      out.flush();
    }
    LOG.log(Level.INFO, msg.toString());
  }

  /**
   * Prints a line break in the standard output if we are not in quite mode.
   */
  protected void printProgressLineBreak()
  {
    if (!argParser.isQuiet())
    {
      out.println();
    }
  }

  /**
   * Displays a warning message in the error output (wrapping it if necessary).
   * @param msg the warning message to be displayed.
   */
  protected void printWarningMessage(Message msg)
  {
    if (!argParser.isQuiet())
    {
      // TODO: decide if even in quiet mode we must display this message or not.
      out.print(org.opends.server.util.StaticUtils.wrapText(msg,
          Utils.getCommandLineMaxLineWidth()));
      out.flush();
    }
    LOG.log(Level.WARNING, msg.toString());
  }

  /**
   * Prints a line break in the standard output.
   */
  protected void printLineBreak()
  {
    out.println();
    return argParser.isQuiet();
  }

  /**

 opends/src/guitools/org/opends/guitools/replicationcli/ReplicationCliParser.java

@@ -389,16 +389,16 @@

    defaultArgs.remove(verboseArg);
    noPromptArg = new BooleanArgument(
        NO_PROMPT_OPTION_LONG,
        NO_PROMPT_OPTION_SHORT,
        NO_PROMPT_OPTION_LONG,
        OPTION_LONG_NO_PROMPT,
        OPTION_SHORT_NO_PROMPT,
        OPTION_LONG_NO_PROMPT,
        INFO_DESCRIPTION_NO_PROMPT.get());
    defaultArgs.add(index++, noPromptArg);

    quietArg = new BooleanArgument(
        SecureConnectionCliParser.QUIET_OPTION_LONG,
        SecureConnectionCliParser.QUIET_OPTION_SHORT,
        SecureConnectionCliParser.QUIET_OPTION_LONG,
        OPTION_LONG_QUIET,
        OPTION_SHORT_QUIET,
        OPTION_LONG_QUIET,
        INFO_REPLICATION_DESCRIPTION_QUIET.get());
    defaultArgs.add(quietArg);
    initializeGlobalArguments(defaultArgs);

 opends/src/guitools/org/opends/guitools/uninstaller/UninstallCliHelper.java

@@ -248,9 +248,8 @@
      Message.raw("2"),
      Message.raw("3")
    };
    Message answer = promptConfirm(
            INFO_CLI_UNINSTALL_WHAT_TO_DELETE.get(),
            options[0], options);
    Message answer = promptConfirm(INFO_CLI_UNINSTALL_WHAT_TO_DELETE.get(),
        options[0], options);
    if (options[2].toString().equals(answer.toString()))
    {
      cancelled = true;
@@ -304,15 +303,11 @@
          if (!ignore)
          {
            Message msg = keys[i];
            answer = promptConfirm(
                    msg, INFO_CLI_YES_LONG.get(),
                    validValues);
            answer = promptConfirm(msg, INFO_CLI_YES_LONG.get(), validValues);

            answers[i] =
                    INFO_CLI_YES_LONG.get().toString().
                            equalsIgnoreCase(answer.toString()) ||
                            INFO_CLI_YES_SHORT.get().toString().
                                    equalsIgnoreCase(answer.toString());
            answers[i] = INFO_CLI_YES_LONG.get().toString().equalsIgnoreCase(
                answer.toString()) || INFO_CLI_YES_SHORT.get().toString().
                equalsIgnoreCase(answer.toString());
          }
          else
          {

 opends/src/guitools/org/opends/guitools/uninstaller/UninstallGuiLauncher.java

@@ -54,7 +54,7 @@
public class UninstallGuiLauncher extends UninstallLauncher {

  /** Prefix for log files. */
  static public final String LOG_FILE_PREFIX = "opends-uninstall-cli-";
  static public final String LOG_FILE_PREFIX = "opends-uninstall-gui-";

  /** Suffix for log files. */
  static public final String LOG_FILE_SUFFIX = ".log";

 opends/src/guitools/org/opends/guitools/uninstaller/UninstallerArgumentParser.java

@@ -30,6 +30,7 @@
import static org.opends.messages.ToolMessages.*;
import static org.opends.messages.AdminToolMessages.*;
import static org.opends.server.admin.client.cli.DsFrameworkCliReturnCode.*;
import static org.opends.server.tools.ToolConstants.*;

import java.io.OutputStream;
import java.util.ArrayList;
@@ -152,9 +153,9 @@
        );
    args.add(removeLDIFFiles);
    noPrompt = new BooleanArgument(
        NO_PROMPT_OPTION_LONG,
        NO_PROMPT_OPTION_SHORT,
        NO_PROMPT_OPTION_LONG,
        OPTION_LONG_NO_PROMPT,
        OPTION_SHORT_NO_PROMPT,
        OPTION_LONG_NO_PROMPT,
        INFO_DESCRIPTION_NO_PROMPT.get());
    args.add(noPrompt);
    forceOnError = new BooleanArgument(
@@ -164,9 +165,9 @@
        INFO_UNINSTALLDS_DESCRIPTION_FORCE.get(noPrompt.getLongIdentifier()));
    args.add(forceOnError);
    quiet = new BooleanArgument(
        SecureConnectionCliParser.QUIET_OPTION_LONG,
        SecureConnectionCliParser.QUIET_OPTION_SHORT,
        SecureConnectionCliParser.QUIET_OPTION_LONG,
        OPTION_LONG_QUIET,
        OPTION_SHORT_QUIET,
        OPTION_LONG_QUIET,
        INFO_UNINSTALLDS_DESCRIPTION_QUIET.get());
    args.add(quiet);


 opends/src/messages/messages/admin_tool.properties

@@ -84,7 +84,6 @@
INFO_CLI_UNINSTALL_CONFIRM_OUTSIDELOGS=The Directory Server contains log \
 files in the following locations outside the server path:%n%s%nRemove these \
 files?
INFO_CLI_UNINSTALL_CONFIRM_PROMPT=%s%n[%s]:
INFO_CLI_UNINSTALL_CONFIRM_STOP=The OpenDS server is currently running and \
 must be stopped before uninstallation can continue.%nStop the Server and \
 permanently delete the files?
@@ -111,6 +110,10 @@
INFO_CLI_UNINSTALL_WHAT_TO_DELETE=Do you want to remove all components of \
 OpenDS or select the components to remove?%n1. Remove all components%n2. \
 Select the components to be removed%n3. Neither; Quit the uninstaller
INFO_CLI_VIEW_DETAILS=View Details
INFO_CLI_DO_YOU_WANT_TO_CONTINUE=Do you want to continue?
INFO_CLI_NUMBER_PROMPT=Enter a number or press Enter to accept the default
INFO_CLI_INVALID_RESPONSE=Invalid response
INFO_CLI_YES_LONG=yes
INFO_CLI_YES_SHORT=y
INFO_CLI_NO_LONG=no

 opends/src/messages/messages/quicksetup.properties

@@ -1029,7 +1029,7 @@
INFO_UPGRADE_CHOOSE_VERSION_UNABLE_TO_ACCESS_BUILD_INFO=Unable to access \
 remote build information.
INFO_UPGRADE_FILE_PROMPT=Enter the name and path of the OpenDS install file \
 (.zip)
 (.zip):
INFO_UPGRADE_LAUNCHER_DESCRIPTION=This utility may be used to upgrade the \
 Directory Server to a newer version.
INFO_UPGRADE_LAUNCHER_GUI_LAUNCHED_FAILED=%n%nThe graphical upgrade launch \

 opends/src/quicksetup/org/opends/quicksetup/Application.java

@@ -850,7 +850,10 @@
          mb.append(formatString(msg));
        } else
        {
          mb.append(formatter.getLineBreak());
          if (!Utils.isCli())
          {
            mb.append(getLineBreak());
          }
          mb.append(formatString(msg));
        }


 opends/src/quicksetup/org/opends/quicksetup/CliApplicationHelper.java

@@ -36,9 +36,9 @@
import static org.opends.messages.AdminToolMessages.*;
import static org.opends.messages.ToolMessages.*;
import static org.opends.messages.QuickSetupMessages.*;
import static org.opends.server.tools.ToolConstants.*;

import org.opends.quicksetup.util.Utils;
import org.opends.server.admin.client.cli.SecureConnectionCliParser;
import org.opends.server.util.args.ArgumentParser;
import org.opends.server.util.args.ArgumentException;
import org.opends.server.util.args.BooleanArgument;
@@ -69,7 +69,10 @@
          Logger.getLogger(CliApplicationHelper.class.getName());

  /** Format string used for deriving the console prompt. */
  static public final String PROMPT_FORMAT = "%s%n[%s]:";
  static public final String PROMPT_DEFAULT_FORMAT = "%s%n[%s]:";

  /** Format string used for deriving the console prompt. */
  static public final String PROMPT_NO_DEFAULT_FORMAT = "%s";

  private BooleanArgument noPromptArg = null;

@@ -123,7 +126,17 @@
    while (!isValid)
    {

      Message msg = Message.raw(PROMPT_FORMAT, prompt, defaultValue);
      Message msg;

      if (defaultValue == null)
      {

        msg = Message.raw(PROMPT_NO_DEFAULT_FORMAT, prompt, defaultValue);
      }
      else
      {
        msg = Message.raw(PROMPT_DEFAULT_FORMAT, prompt, defaultValue);
      }

      out.print(msg);
      out.flush();
@@ -161,11 +174,11 @@
            Utils.getCommandLineMaxLineWidth());

    while (true) {
      out.print(wrappedPrompt);

      if (defaultValue == null) {
        out.print(": ");
        out.print(wrappedPrompt);
        out.print(" ");
      } else {
        out.println(wrappedPrompt);
        out.print("[");
        out.print(defaultValue);
        out.print("]: ");
@@ -423,17 +436,17 @@
    // them with the parser.
    try {
      noPromptArg = new BooleanArgument(
          SecureConnectionCliParser.NO_PROMPT_OPTION_LONG,
          SecureConnectionCliParser.NO_PROMPT_OPTION_SHORT,
          SecureConnectionCliParser.NO_PROMPT_OPTION_LONG,
          OPTION_LONG_NO_PROMPT,
          OPTION_SHORT_NO_PROMPT,
          OPTION_LONG_NO_PROMPT,
          INFO_DESCRIPTION_NO_PROMPT.get());
      argParser.addArgument(noPromptArg);

      quietArg =
        new BooleanArgument(
            SecureConnectionCliParser.QUIET_OPTION_LONG,
            SecureConnectionCliParser.QUIET_OPTION_SHORT,
            SecureConnectionCliParser.QUIET_OPTION_LONG,
            OPTION_LONG_QUIET,
            OPTION_SHORT_QUIET,
            OPTION_LONG_QUIET,
            INFO_DESCRIPTION_QUIET.get());
      argParser.addArgument(quietArg);

@@ -444,7 +457,6 @@
    return argParser;
  }


  /**
   * Displays an error message in the error output (wrapping it if necessary).
   * @param msg the error message to be displayed.
@@ -453,6 +465,64 @@
  {
    err.println(org.opends.server.util.StaticUtils.wrapText(msg,
        Utils.getCommandLineMaxLineWidth()));
    LOG.log(Level.SEVERE, msg.toString());
  }

  /**
   * Displays a progress message in the error output (wrapping it if necessary).
   * @param msg the error message to be displayed.
   */
  protected void printProgressMessage(Message msg)
  {
    if (!isQuiet())
    {
      out.print(org.opends.server.util.StaticUtils.wrapText(msg,
          Utils.getCommandLineMaxLineWidth()));
      out.flush();
    }
    LOG.log(Level.INFO, msg.toString());
  }

  /**
   * Displays a progress message in the error output (wrapping it if necessary).
   * @param msg the error message to be displayed.
   */
  protected void printProgressMessage(String msg)
  {
    if (!isQuiet())
    {
      out.print(org.opends.server.util.StaticUtils.wrapText(msg,
          Utils.getCommandLineMaxLineWidth()));
      out.flush();
    }
    LOG.log(Level.INFO, msg.toString());
  }

  /**
   * Prints a line break in the standard output if we are not in quite mode.
   */
  protected void printProgressLineBreak()
  {
    if (!isQuiet())
    {
      out.println();
    }
  }

  /**
   * Displays a warning message in the error output (wrapping it if necessary).
   * @param msg the warning message to be displayed.
   */
  protected void printWarningMessage(Message msg)
  {
    if (!isQuiet())
    {
      // TODO: decide if even in quiet mode we must display this message or not.
      out.println(org.opends.server.util.StaticUtils.wrapText(msg,
          Utils.getCommandLineMaxLineWidth()));
      out.flush();
    }
    LOG.log(Level.WARNING, msg.toString());
  }

  /**
@@ -474,6 +544,20 @@
  }

  /**
   * Prints a line message in the standard output.
   * @param msg the error message to be displayed.
   * @param overrideQuietMode whether to override the quiet mode or not.
   */
  protected void printLine(Message msg, boolean overrideQuietMode)
  {
    if (!isQuiet() || overrideQuietMode)
    {
      out.println(org.opends.server.util.StaticUtils.wrapText(msg,
          Utils.getCommandLineMaxLineWidth()));
    }
  }

  /**
   * Prompts the user to give the Global Administrator UID.
   * @param defaultValue the default value that will be proposed in the prompt
   * message.

 opends/src/quicksetup/org/opends/quicksetup/CliUserInteraction.java

@@ -28,7 +28,7 @@
package org.opends.quicksetup;

import org.opends.messages.Message;
import static org.opends.messages.QuickSetupMessages.*;
import static org.opends.messages.AdminToolMessages.*;

import org.opends.quicksetup.util.Utils;
import org.opends.server.util.StaticUtils;
@@ -87,7 +87,7 @@
      sOptions.add(createOption(options.length + 1,
              viewDetailsOption != null ?
                      viewDetailsOption.toString() :
                      "View Details")); // TODO: i18n
                      INFO_CLI_VIEW_DETAILS.get().toString()));
    }

    println(String.valueOf(summary));
@@ -100,10 +100,10 @@
      for (String o : sOptions) {
        println(o);
      }
      System.out.print( // TODO: i18n
              Message.raw(CliUserInteraction.PROMPT_FORMAT,
                      "Enter a number or press Enter to accept the default",
                      Integer.toString(defInt)));
      System.out.print(
          Message.raw(CliApplicationHelper.PROMPT_DEFAULT_FORMAT,
              INFO_CLI_NUMBER_PROMPT.get().toString(),
              Integer.toString(defInt)));

      System.out.flush();

@@ -123,7 +123,7 @@
      } else if (respInt > 0 && respInt <= options.length) {
        returnValue = options[respInt - 1];
      } else {
        println("Illegal response " + response); // TODO: i18n
        println(INFO_CLI_INVALID_RESPONSE.get()+" " + response);
      }
    }
    return returnValue;

 opends/src/quicksetup/org/opends/quicksetup/Constants.java

@@ -82,4 +82,7 @@
          HTML_LIST_ITEM_CLOSE
  };

  /** The cli java system property. */
  public static final String CLI_JAVA_PROPERTY = "org.opends.quicksetup.cli";

}

 opends/src/quicksetup/org/opends/quicksetup/Launcher.java

@@ -247,7 +247,7 @@
   */
  protected int launchCli(CliApplication cliApp)
  {
    System.setProperty("org.opends.quicksetup.cli", "true");
    System.setProperty(Constants.CLI_JAVA_PROPERTY, "true");
    QuickSetupCli cli = new QuickSetupCli(cliApp, this);
    ApplicationReturnCode.ReturnCode returnValue = cli.run();
    if (returnValue.equals(ApplicationReturnCode.ReturnCode.USER_DATA_ERROR))

 opends/src/quicksetup/org/opends/quicksetup/upgrader/UpgradeLauncher.java

@@ -39,7 +39,6 @@
import org.opends.quicksetup.QuickSetupLog;

import org.opends.quicksetup.util.Utils;
import org.opends.server.admin.client.cli.SecureConnectionCliParser;
import org.opends.server.util.ServerConstants;
import org.opends.server.util.args.ArgumentParser;
import org.opends.server.util.args.BooleanArgument;
@@ -191,15 +190,15 @@
              null, null, INFO_UPGRADE_DESCRIPTION_FILE.get());
      argParser.addArgument(file);
      noPrompt = new BooleanArgument(
          SecureConnectionCliParser.NO_PROMPT_OPTION_LONG,
          SecureConnectionCliParser.NO_PROMPT_OPTION_SHORT,
          SecureConnectionCliParser.NO_PROMPT_OPTION_LONG,
          OPTION_LONG_NO_PROMPT,
          OPTION_SHORT_NO_PROMPT,
          OPTION_LONG_NO_PROMPT,
          INFO_UPGRADE_DESCRIPTION_NO_PROMPT.get());
      argParser.addArgument(noPrompt);
      quiet = new BooleanArgument(
          SecureConnectionCliParser.QUIET_OPTION_LONG,
          SecureConnectionCliParser.QUIET_OPTION_SHORT,
          SecureConnectionCliParser.QUIET_OPTION_LONG,
          OPTION_LONG_QUIET,
          OPTION_SHORT_QUIET,
          OPTION_LONG_QUIET,
          INFO_UPGRADE_DESCRIPTION_SILENT.get());
      argParser.addArgument(quiet);
      showUsage = new BooleanArgument("showusage", OPTION_SHORT_HELP,

 opends/src/quicksetup/org/opends/quicksetup/util/PlainTextProgressMessageFormatter.java

@@ -192,7 +192,7 @@
  public Message getFormattedWithPoints(Message text)
  {
    return new MessageBuilder(text).append(SPACE)
            .append(INFO_PROGRESS_POINTS.get()).toMessage();
            .append(INFO_PROGRESS_POINTS.get()).append(SPACE).toMessage();
  }

  /**
@@ -262,8 +262,9 @@
  public Message getTaskSeparator()
  {
    return Message.raw(
    "\n\n-----------------------------------------------------------------\n\n"
            );
        Constants.LINE_SEPARATOR+
        "-----------------------------------------------------------------"+
        Constants.LINE_SEPARATOR);
  }

  /**

 opends/src/quicksetup/org/opends/quicksetup/util/Utils.java

@@ -811,7 +811,7 @@
   */
  public static boolean isCli()
  {
    return "true".equals(System.getProperty("org.opends.quicksetup.cli"));
    return "true".equals(System.getProperty(Constants.CLI_JAVA_PROPERTY));
  }

  /**

 opends/src/server/org/opends/server/admin/client/cli/SecureConnectionCliParser.java

@@ -164,18 +164,6 @@
  // the trust manager.
  private ApplicationTrustManager trustManager;

  /** Short form of the option for specifying a noninteractive session. */
  static public final Character NO_PROMPT_OPTION_SHORT = 'n';

  /** Long form of the option for specifying a quiet session. */
  static public final String QUIET_OPTION_LONG = "quiet";

  /** Long form of the option for specifying a noninteractive session. */
  static public final String NO_PROMPT_OPTION_LONG = "no-prompt";

  /** Short form of the option for specifying a quiet session. */
  static public final Character QUIET_OPTION_SHORT = 'Q';

  /**
   * The tracer object for the debug logger.
   */
@@ -451,7 +439,7 @@
        INFO_DESCRIPTION_TRUSTSTOREPASSWORD.get());
    set.add(trustStorePasswordArg);

    trustStorePasswordFileArg = new FileBasedArgument("truststorepasswordfile",
    trustStorePasswordFileArg = new FileBasedArgument("truststorePasswordFile",
        OPTION_SHORT_TRUSTSTORE_PWD_FILE, OPTION_LONG_TRUSTSTORE_PWD_FILE,
        false, false, OPTION_VALUE_TRUSTSTORE_PWD_FILE, null, null,
        INFO_DESCRIPTION_TRUSTSTOREPASSWORD_FILE.get());
@@ -469,7 +457,7 @@
        INFO_DESCRIPTION_KEYSTOREPASSWORD.get());
    set.add(keyStorePasswordArg);

    keyStorePasswordFileArg = new FileBasedArgument("keystorepasswordfile",
    keyStorePasswordFileArg = new FileBasedArgument("keystorePasswordFile",
        OPTION_SHORT_KEYSTORE_PWD_FILE, OPTION_LONG_KEYSTORE_PWD_FILE, false,
        false, OPTION_VALUE_KEYSTORE_PWD_FILE, null, null,
        INFO_DESCRIPTION_KEYSTOREPASSWORD_FILE.get());

 opends/src/server/org/opends/server/tools/dsconfig/DSConfig.java

@@ -54,7 +54,6 @@
import org.opends.server.admin.RelationDefinition;
import org.opends.server.admin.Tag;
import org.opends.server.admin.client.ManagedObjectDecodingException;
import org.opends.server.admin.client.cli.SecureConnectionCliParser;
import org.opends.server.loggers.debug.DebugTracer;
import org.opends.server.tools.ClientException;
import org.opends.server.types.DebugLogLevel;
@@ -473,18 +472,18 @@
          INFO_DESCRIPTION_VERBOSE.get());

      quietArgument = new BooleanArgument(
          SecureConnectionCliParser.QUIET_OPTION_LONG,
          SecureConnectionCliParser.QUIET_OPTION_SHORT,
          SecureConnectionCliParser.QUIET_OPTION_LONG, INFO_DESCRIPTION_QUIET
              .get());
          OPTION_LONG_QUIET,
          OPTION_SHORT_QUIET,
          OPTION_LONG_QUIET,
          INFO_DESCRIPTION_QUIET.get());

      scriptFriendlyArgument = new BooleanArgument("script-friendly", 's',
          "script-friendly", INFO_DESCRIPTION_SCRIPT_FRIENDLY.get());

      noPromptArgument = new BooleanArgument(
          SecureConnectionCliParser.NO_PROMPT_OPTION_LONG,
          SecureConnectionCliParser.NO_PROMPT_OPTION_SHORT,
          SecureConnectionCliParser.NO_PROMPT_OPTION_LONG,
          OPTION_LONG_NO_PROMPT,
          OPTION_SHORT_NO_PROMPT,
          OPTION_LONG_NO_PROMPT,
          INFO_DESCRIPTION_NO_PROMPT.get());

      showUsageArgument = new BooleanArgument("showUsage", OPTION_SHORT_HELP,