standardized the tools various option forms for suppressing output to -Q/--...

kenneth_suter

23.57.2007 67a4b575be3f35220d91a15db0ba1923d25268c0

standardized the tools various option forms for suppressing output to -Q/--quiet

 opendj-sdk/opends/src/guitools/org/opends/guitools/uninstaller/UninstallCliHelper.java

@@ -97,7 +97,7 @@
    UninstallUserData userData = new UninstallUserData();

    boolean isInteractive;
    boolean isSilent;
    boolean isQuiet;
    boolean isCancelled = false;

    /* Step 1: analyze the arguments.
@@ -113,9 +113,9 @@

    isInteractive = args.isInteractive();

    isSilent = args.isSilent();
    isQuiet = args.isQuiet();

    userData.setSilent(isSilent);
    userData.setQuiet(isQuiet);
    userData.setForceOnError(args.isForceOnError());
    userData.setTrustManager(args.getTrustManager());

@@ -388,7 +388,7 @@
   * @return <CODE>true</CODE> if the user wants to continue with uninstall and
   * <CODE>false</CODE> otherwise.
   * @throws UserDataException if there is a problem with the data
   * provided by the user (in the particular case where we are on silent
   * provided by the user (in the particular case where we are on quiet
   * uninstall and some data is missing or not valid).
   */
  private boolean checkServerState(UninstallUserData userData,
@@ -450,7 +450,7 @@
        {
          if (confirmToUpdateRemoteAndStart())
          {
            boolean startWorked = startServer(userData.isSilent());
            boolean startWorked = startServer(userData.isQuiet());
            // Ask for authentication if needed, etc.
            if (startWorked)
            {
@@ -489,7 +489,7 @@
        }
        else
        {
          boolean startWorked = startServer(userData.isSilent());
          boolean startWorked = startServer(userData.isQuiet());
          // Ask for authentication if needed, etc.
          if (startWorked)
          {

 opendj-sdk/opends/src/guitools/org/opends/guitools/uninstaller/UninstallerArgumentParser.java

@@ -54,7 +54,7 @@
{
  private BooleanArgument interactive;
  private BooleanArgument forceOnError;
  private BooleanArgument silent;
  private BooleanArgument quiet;
  private BooleanArgument removeAll;
  private BooleanArgument removeServerLibraries;
  private BooleanArgument removeDatabases;
@@ -163,12 +163,12 @@
        "forceOnError",
        INFO_UNINSTALLDS_DESCRIPTION_FORCE.get());
    args.add(forceOnError);
    silent = new BooleanArgument(
        SecureConnectionCliParser.SILENT_OPTION_LONG,
        SecureConnectionCliParser.SILENT_OPTION_SHORT,
        SecureConnectionCliParser.SILENT_OPTION_LONG,
    quiet = new BooleanArgument(
        SecureConnectionCliParser.QUIET_OPTION_LONG,
        SecureConnectionCliParser.QUIET_OPTION_SHORT,
        SecureConnectionCliParser.QUIET_OPTION_LONG,
        INFO_UNINSTALLDS_DESCRIPTION_SILENT.get());
    args.add(silent);
    args.add(quiet);

    adminUidArg = new StringArgument("adminUID", 'I',
        "adminUID", false, false, true, "adminUID",
@@ -224,14 +224,14 @@
  }

  /**
   * Tells whether the user specified to have a silent uninstall or not.
   * Tells whether the user specified to have a quiet uninstall or not.
   * This method must be called after calling parseArguments.
   * @return <CODE>true</CODE> if the user specified to have a silent
   * @return <CODE>true</CODE> if the user specified to have a quiet
   * uninstall and <CODE>false</CODE> otherwise.
   */
  public boolean isSilent()
  public boolean isQuiet()
  {
    return silent.isPresent();
    return quiet.isPresent();
  }

  /**

 opendj-sdk/opends/src/messages/messages/admin_tool.properties

@@ -347,7 +347,7 @@
 install.  If not specified the graphical interface will be launched.  The \
 rest of the options (excluding help and version) will only be taken into \
 account if this option is specified
INFO_UNINSTALLDS_DESCRIPTION_SILENT=Perform a silent uninstall (no \
INFO_UNINSTALLDS_DESCRIPTION_SILENT=Perform a quiet uninstall (no \
 progress information is written to the standard output)
INFO_UNINSTALLDS_DESCRIPTION_REMOVE_ALL=Remove all components of \
 OpenDS (this option is not compatible with the rest of remove options)

 opendj-sdk/opends/src/messages/messages/tools.properties

@@ -849,7 +849,7 @@
 started properly
INFO_INSTALLDS_DESCRIPTION_PROGNAME_486=The setup command used to invoke this \
 program
INFO_INSTALLDS_DESCRIPTION_SILENT_489=Perform a silent installation
INFO_INSTALLDS_DESCRIPTION_SILENT_489=Perform a quiet installation
INFO_INSTALLDS_DESCRIPTION_BASEDN_490=Specifies the base DN for user \
 information in the Directory Server.  Multiple base DNs may be provided by \
 using this option multiple times
@@ -903,7 +903,7 @@
INFO_INSTALLDS_PROMPT_ROOT_DN_512=What would you like to use as the initial \
 root user DN for the Directory Server?
SEVERE_ERR_INSTALLDS_NO_ROOT_PASSWORD_513=ERROR:  No password was provided \
 for the initial root user.  When performing a silent installation, this must \
 for the initial root user.  When performing a quiet installation, this must \
 be provided using either the %s or the %s argument
INFO_INSTALLDS_PROMPT_ROOT_PASSWORD_514=Please provide the password to use \
 for the initial root user
@@ -1990,7 +1990,7 @@
 line version of this tool
INFO_UPGRADE_DESCRIPTION_INTERACTIVE_1191=Prompt for any required information \
 rather than fail
INFO_UPGRADE_DESCRIPTION_SILENT_1192=Perform a silent upgrade
INFO_UPGRADE_DESCRIPTION_SILENT_1192=Perform a quiet upgrade
INFO_LDIFIMPORT_DESCRIPTION_COUNT_REJECTS_1195=Count the number of entries \
 rejected by the server and return that value as the exit code (values > 255 \
 will be reduced to 255 due to exit code restrictions)
@@ -2045,7 +2045,7 @@
 reverted to the state before the most recent upgrade
INFO_REVERT_DESCRIPTION_INTERACTIVE_1221=Prompt for any required information \
 rather than fail
INFO_REVERT_DESCRIPTION_SILENT_1222=Perform a silent reversion
INFO_REVERT_DESCRIPTION_SILENT_1222=Perform a quiet reversion
SEVERE_ERR_DSCFG_ERROR_MISSING_NON_INTERACTIVE_ARG_1223=The argument "--%s" \
 must be specified when this application is used non-interactively
SEVERE_ERR_DSCFG_ERROR_CANNOT_READ_CONSOLE_INPUT_1224=The response could not \

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/Application.java

@@ -596,13 +596,13 @@
  /**
   * Makes available a <code>UserInteraction</code> class that can be used
   * by the application to interact with the user.  If the user has requested
   * a silent session this method returns null.
   * a quiet session this method returns null.
   * @return UserInteraction object
   */
  public UserInteraction userInteraction() {
    // Note:  overridden in GuiApplication
    UserInteraction ui = null;
    if (!getUserData().isSilent()) {
    if (!getUserData().isQuiet()) {
      ui = new CliUserInteraction();
    }
    return ui;

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/CliApplicationHelper.java

@@ -67,7 +67,7 @@

  private BooleanArgument interactiveArg = null;

  private BooleanArgument silentArg = null;
  private BooleanArgument quietArg = null;

  /**
   * Interactively prompts (on standard output) the user to provide a string
@@ -254,24 +254,24 @@
  }

  /**
   * Returns <CODE>true</CODE> if this is a silent uninstall and
   * Returns <CODE>true</CODE> if this is a quiet uninstall and
   * <CODE>false</CODE> otherwise.
   * @param args the arguments passed in the command line.
   * @return <CODE>true</CODE> if this is a silent uninstall and
   * @return <CODE>true</CODE> if this is a quiet uninstall and
   * <CODE>false</CODE> otherwise.
   */
  protected boolean isSilent(String[] args)
  protected boolean isQuiet(String[] args)
  {
    boolean isSilent = false;
    for (int i=0; i<args.length && !isSilent; i++)
    boolean isQuiet = false;
    for (int i=0; i<args.length && !isQuiet; i++)
    {
      if (args[i].equalsIgnoreCase("--silentUninstall") ||
          args[i].equalsIgnoreCase("-s"))
      if (args[i].equalsIgnoreCase("--quiet") ||
          args[i].equalsIgnoreCase("-Q"))
      {
        isSilent = true;
        isQuiet = true;
      }
    }
    return isSilent;
    return isQuiet;
  }

  /**
@@ -310,15 +310,15 @@
  }

  /**
   * Returns <CODE>true</CODE> if this is a silent session and
   * Returns <CODE>true</CODE> if this is a quiet session and
   * <CODE>false</CODE> otherwise.  This method relies on the a previous
   * call to createArgumentParser having been made and the parser
   * having been used to parse the arguments.
   * @return <CODE>true</CODE> if this is a silent uninstall and
   * @return <CODE>true</CODE> if this is a quiet uninstall and
   * <CODE>false</CODE> otherwise.
   */
  protected boolean isSilent() {
    return silentArg != null && silentArg.isPresent();
  protected boolean isQuiet() {
    return quietArg != null && quietArg.isPresent();
  }

  /**
@@ -362,12 +362,12 @@
                   null);
      argParser.addArgument(interactiveArg);

      silentArg =
      quietArg =
           new BooleanArgument("silent session",
                   SecureConnectionCliParser.SILENT_OPTION_SHORT,
                   SecureConnectionCliParser.SILENT_OPTION_LONG,
                   SecureConnectionCliParser.QUIET_OPTION_SHORT,
                   SecureConnectionCliParser.QUIET_OPTION_LONG,
                   null);
      argParser.addArgument(silentArg);
      argParser.addArgument(quietArg);

    } catch (ArgumentException e) {
      LOG.log(Level.INFO, "error", e);

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/Launcher.java

@@ -357,7 +357,7 @@
  private void preExit(CliApplication cliApp) {
    if (cliApp != null) {
      UserData ud = cliApp.getUserData();
      if (ud != null && !ud.isSilent()) {
      if (ud != null && !ud.isQuiet()) {

        // Add an extra space systematically
        System.out.println();

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/QuickSetupCli.java

@@ -87,7 +87,7 @@
                new PlainTextProgressMessageFormatter();
        cliApp.setUserData(userData);
        cliApp.setProgressMessageFormatter(formatter);
        if (!userData.isSilent()) {
        if (!userData.isQuiet()) {
          cliApp.addProgressUpdateListener(
                  new ProgressUpdateListener() {
                    public void progressUpdate(ProgressUpdateEvent ev) {

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/UserData.java

@@ -81,7 +81,7 @@

  private Map<ServerDescriptor, Integer> remoteWithNoReplicationPort;

  private boolean silent;
  private boolean quiet;

  private boolean interactive;

@@ -449,23 +449,23 @@
  /**
   * Sets whether or not this session should print messages to the
   * console if in CLI mode.
   * @param silent where true indicates this sesssion should be silent
   * @param quiet where true indicates this sesssion should be quiet
   */
  public void setSilent(boolean silent) {
    this.silent = silent;
  public void setQuiet(boolean quiet) {
    this.quiet = quiet;
  }

  /**
   * Indicates whether or not the user has requested silent mode.
   * Indicates whether or not the user has requested quiet mode.
   * <p>
   * Silent mode in the CLI means that nothing is written to output including
   * Quiet mode in the CLI means that nothing is written to output including
   * prompts for information and whether or not to continue an operation
   * experiencing errors.
   *
   * @return boolean where true indicates this session should be silent.
   * @return boolean where true indicates this session should be quiet.
   */
  public boolean isSilent() {
    return this.silent;
  public boolean isQuiet() {
    return this.quiet;
  }

  /**
@@ -509,7 +509,7 @@
   * @return boolean where true indicates this session should be interactive
   */
  public boolean isInteractive() {
    return !this.silent && this.interactive;
    return !this.quiet && this.interactive;
  }

  /**

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/installer/InstallLauncher.java

@@ -108,7 +108,7 @@
    BooleanArgument   addBaseEntry;
    BooleanArgument   cliMode;
    BooleanArgument   showUsage;
    BooleanArgument   silentInstall;
    BooleanArgument   quietInstall;
    BooleanArgument   skipPortCheck;
    BooleanArgument   enableWindowsService;
    FileBasedArgument rootPWFile;
@@ -126,9 +126,11 @@
          INFO_INSTALLDS_DESCRIPTION_CLI.get());
      argParser.addArgument(cliMode);

      silentInstall = new BooleanArgument("silent", 's', "silentInstall",
      quietInstall = new BooleanArgument("quiet",
          OPTION_SHORT_QUIET,
          OPTION_LONG_QUIET,
          INFO_INSTALLDS_DESCRIPTION_SILENT.get());
      argParser.addArgument(silentInstall);
      argParser.addArgument(quietInstall);

      baseDN = new StringArgument("basedn", OPTION_SHORT_BASEDN,
          OPTION_LONG_BASEDN, false, true, true,

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/ui/GuiApplication.java

@@ -578,7 +578,7 @@
   */
  public UserInteraction userInteraction() {
    UserInteraction ui = null;
    if (!getUserData().isSilent()) {
    if (!getUserData().isQuiet()) {
      if (Utils.isCli()) {
        ui = new CliUserInteraction();
      } else {

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/upgrader/BuildExtractorCliHelper.java

@@ -54,9 +54,9 @@
    throws UserDataException {
    UpgradeUserData uud = super.createUserData(args);

    // Build extractor is always silent whether user
    // Build extractor is always quiet whether user
    // has specified this or not.
    uud.setSilent(true);
    uud.setQuiet(true);

    if (localInstallPackFileNameArg.isPresent()) {
      String localInstallPackFileName =

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/upgrader/ReversionLauncher.java

@@ -41,8 +41,7 @@
import org.opends.server.util.args.FileBasedArgument;
import org.opends.server.util.ServerConstants;
import static org.opends.messages.ToolMessages.*;
import static org.opends.server.tools.ToolConstants.OPTION_SHORT_HELP;
import static org.opends.server.tools.ToolConstants.OPTION_LONG_HELP;
import static org.opends.server.tools.ToolConstants.*;

import java.io.File;

@@ -86,7 +85,7 @@
  private BooleanArgument showUsage;
  private FileBasedArgument dir;
  private BooleanArgument mostRecent;
  private BooleanArgument silent;
  private BooleanArgument quiet;
  private BooleanArgument interactive;

  /**
@@ -191,9 +190,11 @@
          INFO_REVERT_DESCRIPTION_INTERACTIVE.get());
      argParser.addArgument(interactive);

      silent = new BooleanArgument("silent", 's', "silent",
      quiet = new BooleanArgument("quiet",
              OPTION_SHORT_QUIET,
              OPTION_LONG_QUIET,
          INFO_REVERT_DESCRIPTION_SILENT.get());
      argParser.addArgument(silent);
      argParser.addArgument(quiet);

      showUsage = new BooleanArgument("showusage", OPTION_SHORT_HELP,
        OPTION_LONG_HELP,

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/upgrader/UpgradeLauncher.java

@@ -178,7 +178,7 @@
        INFO_UPGRADE_LAUNCHER_USAGE_DESCRIPTION.get(), false);
    BooleanArgument showUsage;
    FileBasedArgument file;
    BooleanArgument silent;
    BooleanArgument quiet;
    BooleanArgument interactive;
    try
    {
@@ -196,12 +196,12 @@
          SecureConnectionCliParser.INTERACTIVE_OPTION_LONG,
          INFO_UPGRADE_DESCRIPTION_INTERACTIVE.get());
      argParser.addArgument(interactive);
      silent = new BooleanArgument(
          SecureConnectionCliParser.SILENT_OPTION_LONG,
          SecureConnectionCliParser.SILENT_OPTION_SHORT,
          SecureConnectionCliParser.SILENT_OPTION_LONG,
      quiet = new BooleanArgument(
          SecureConnectionCliParser.QUIET_OPTION_LONG,
          SecureConnectionCliParser.QUIET_OPTION_SHORT,
          SecureConnectionCliParser.QUIET_OPTION_LONG,
          INFO_UPGRADE_DESCRIPTION_SILENT.get());
      argParser.addArgument(silent);
      argParser.addArgument(quiet);
      showUsage = new BooleanArgument("showusage", OPTION_SHORT_HELP,
        OPTION_LONG_HELP,
        INFO_DESCRIPTION_USAGE.get());

 opendj-sdk/opends/src/quicksetup/org/opends/quicksetup/upgrader/UpgraderCliHelper.java

@@ -62,7 +62,7 @@
    ArgumentParser ap = createArgumentParser();
    try {
      ap.parseArguments(args);
      uud.setSilent(isSilent());
      uud.setQuiet(isQuiet());
      uud.setInteractive(isInteractive());

      // There is no need to check/validate the file argument

 opendj-sdk/opends/src/server/org/opends/server/admin/client/cli/SecureConnectionCliParser.java

@@ -165,13 +165,13 @@
  static public final Character INTERACTIVE_OPTION_SHORT = 'i';

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

  /** Long form of the option for specifying a noninteractive session. */
  static public final String INTERACTIVE_OPTION_LONG = "interactive";

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

  /**
   * The tracer object for the debug logger.

 opendj-sdk/opends/src/server/org/opends/server/tools/ImportLDIF.java

@@ -365,7 +365,8 @@
      argParser.addArgument(isEncrypted);


      quietMode = new BooleanArgument("quietmode", 'Q', "quiet",
      quietMode = new BooleanArgument("quietmode", OPTION_SHORT_QUIET,
                                      OPTION_LONG_QUIET,
                                      INFO_LDIFIMPORT_DESCRIPTION_QUIET.get());
      argParser.addArgument(quietMode);


 opendj-sdk/opends/src/server/org/opends/server/tools/InstallDS.java

@@ -178,7 +178,7 @@
    BooleanArgument   cliMode;
    BooleanArgument   testOnly;
    BooleanArgument   showUsage;
    BooleanArgument   silentInstall;
    BooleanArgument   quietInstall;
    BooleanArgument   skipPortCheck;
    BooleanArgument   enableWindowsService;
    FileBasedArgument rootPWFile;
@@ -231,10 +231,11 @@
              INFO_INSTALLDS_DESCRIPTION_CLI.get());
      argParser.addArgument(cliMode);

      silentInstall = new BooleanArgument(
              "silent", 's', "silentInstall",
      quietInstall = new BooleanArgument(
              "quiet", OPTION_SHORT_QUIET,
              OPTION_LONG_QUIET,
              INFO_INSTALLDS_DESCRIPTION_SILENT.get());
      argParser.addArgument(silentInstall);
      argParser.addArgument(quietInstall);

      baseDN = new StringArgument(
              "basedn", OPTION_SHORT_BASEDN,
@@ -432,8 +433,8 @@
    String configClassName = configClass.getValue();


    // If this isn't a silent install, then print the version string.
    if (! silentInstall.isPresent())
    // If this isn't a quiet install, then print the version string.
    if (! quietInstall.isPresent())
    {
      System.out.println(versionString);
      System.out.println();
@@ -491,7 +492,7 @@

    // Determine the LDAP port number.
    int ldapPortNumber;
    if (silentInstall.isPresent() || ldapPort.isPresent())
    if (quietInstall.isPresent() || ldapPort.isPresent())
    {
      try
      {
@@ -564,7 +565,7 @@

//  Determine the JMX port number.
    int jmxPortNumber;
    if (silentInstall.isPresent() || jmxPort.isPresent())
    if (quietInstall.isPresent() || jmxPort.isPresent())
    {
      try
      {
@@ -660,7 +661,7 @@
        }
      }
    }
    else if (silentInstall.isPresent())
    else if (quietInstall.isPresent())
    {
      rootDNs = new LinkedList<DN>();
      try
@@ -703,7 +704,7 @@
    {
      rootPassword = rootPWFile.getValue();
    }
    else if (silentInstall.isPresent())
    else if (quietInstall.isPresent())
    {
      Message message = ERR_INSTALLDS_NO_ROOT_PASSWORD.get(
              rootPWString.getLongIdentifier(),
@@ -743,7 +744,7 @@
        }
      }
    }
    else if (silentInstall.isPresent())
    else if (quietInstall.isPresent())
    {
      try
      {
@@ -795,7 +796,7 @@
        return 1;
      }
    }
    else if (silentInstall.isPresent())
    else if (quietInstall.isPresent())
    {
      populateType = POPULATE_TYPE_LEAVE_EMPTY;
    }
@@ -859,7 +860,7 @@
    // If we are in Windows ask if the server must run as a windows service.
    if (SetupUtils.isWindows())
    {
      if (silentInstall.isPresent())
      if (quietInstall.isPresent())
      {
        enableService = enableWindowsService.isPresent();
      }
@@ -907,7 +908,7 @@
    String[] configureDSArguments = new String[argList.size()];
    argList.toArray(configureDSArguments);

    if (! silentInstall.isPresent())
    if (! quietInstall.isPresent())
    {
      System.out.println();

@@ -926,7 +927,7 @@
    if (populateType == POPULATE_TYPE_BASE_ONLY)
    {
      // Create a temporary LDIF file that will hold the entry to add.
      if (! silentInstall.isPresent())
      if (! quietInstall.isPresent())
      {
        Message message = INFO_INSTALLDS_STATUS_CREATING_BASE_LDIF.get();
        System.out.println(wrapText(message, MAX_LINE_WIDTH));
@@ -988,7 +989,7 @@

    if ((ldifFiles != null) && (! ldifFiles.isEmpty()))
    {
      if (! silentInstall.isPresent())
      if (! quietInstall.isPresent())
      {
        Message message = INFO_INSTALLDS_STATUS_IMPORTING_LDIF.get();
        System.out.println(wrapText(message, MAX_LINE_WIDTH));
@@ -1082,7 +1083,7 @@
    }

    // If we've gotten here, then everything seems to have gone smoothly.
    if (! silentInstall.isPresent())
    if (! quietInstall.isPresent())
    {
      Message message = INFO_INSTALLDS_STATUS_SUCCESS.get();
      System.out.println(wrapText(message, MAX_LINE_WIDTH));

 opendj-sdk/opends/src/server/org/opends/server/tools/ToolConstants.java

@@ -645,5 +645,15 @@
   * Value for the server root option long form.
   */
  public static final String OPTION_LONG_SERVER_ROOT = "serverRoot";

  /**
   * Value for the quiet option short form
   */
  public static final Character OPTION_SHORT_QUIET = 'Q';

  /**
   * Value for the quiet option long form
   */
  public static final String OPTION_LONG_QUIET = "quiet";
}


 opendj-sdk/opends/src/server/org/opends/server/tools/dsconfig/DSConfig.java

@@ -293,7 +293,7 @@
      verboseArgument = new BooleanArgument("verbose", 'v', "verbose",
          INFO_DESCRIPTION_VERBOSE.get());

      quietArgument = new BooleanArgument("quiet", 'q', "quiet",
      quietArgument = new BooleanArgument("quiet", 'Q', "quiet",
          INFO_DESCRIPTION_QUIET.get());

      scriptFriendlyArgument = new BooleanArgument("script-friendly", 's',

 opendj-sdk/opends/tests/unit-tests-testng/src/server/org/opends/quicksetup/TestUtilities.java

@@ -96,7 +96,7 @@
      args.add(new File(root, "setup.bat").getPath());
    }
    args.add("--cli");
    args.add("-s");
    args.add("-Q");
    args.add("-p");
    args.add(Integer.toString(ldapPort));
    args.add("-x");