Mercurial > hg > release > thermostat-0.5
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/HelpCommand.java @ 915:0f4271d4e334
Change common options implementation.
This patch removes the old CommonCommandOptions class. Common options - dbUrl,
logLevel, username, password - are now automatically added if the "options"
list in command.properties contains "special" option names such as
AUTO_DB_OPTIONS (dbUrl, username, password) and AUTO_LOG_OPTION (logLevel). If
these are present thermostat adds options as requested automatically. Note that
all automatic options are optional. The required property can be
changed/overridden by using a <option-name>.required key in command.properties
and adding <option-name> to the "options" list AFTER the AUTO_* option.
I've also cleaned up the command.properties files and help command output.
command.properties don't need to maintain "thermostat" any longer. Moreover,
help output contains the description of the command as well. Example:
$ ./distribution/target/bin/thermostat help agent
usage: thermostat agent [-d <url> [-u <user> -p <password>]] [-s] [--debug] [-l
<level>]
starts and stops the thermostat agent
thermostat agent
-d,--dbUrl <dbUrl> connect to the given URL
-l,--logLevel <logLevel> sets the log level for this invocation. Possible
values for <level> in decreasing severity are:
SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
and OFF.
-p,--password <password> the password to use for authentication
-s,--saveOnExit save the data on exit
-u,--username <username> the username to use for authentication
-v,--debug launch with debug console enabled
Finally, this should be the last patch required in order to drop the
storage-core dependency of common-core, since it removes the need for
client-cli to depend on the launcher bundle.
It fixes PR1200 too.
Reviewed-by: ebaron, vanaltj
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-January/005118.html
author | Severin Gehwolf <sgehwolf@redhat.com> |
---|---|
date | Fri, 11 Jan 2013 19:23:03 +0100 |
parents | d07e5cc900a3 |
children | ccac9bcabaa0 |
line wrap: on
line source
/* * Copyright 2012 Red Hat, Inc. * * This file is part of Thermostat. * * Thermostat is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published * by the Free Software Foundation; either version 2, or (at your * option) any later version. * * Thermostat is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with Thermostat; see the file COPYING. If not see * <http://www.gnu.org/licenses/>. * * Linking this code with other modules is making a combined work * based on this code. Thus, the terms and conditions of the GNU * General Public License cover the whole combination. * * As a special exception, the copyright holders of this code give * you permission to link this code with independent modules to * produce an executable, regardless of the license terms of these * independent modules, and to copy and distribute the resulting * executable under terms of your choice, provided that you also * meet, for each linked independent module, the terms and conditions * of the license of that module. An independent module is a module * which is not derived from or based on this code. If you modify * this code, you may extend this exception to your version of the * library, but you are not obligated to do so. If you do not wish * to do so, delete this exception statement from your version. */ package com.redhat.thermostat.launcher.internal; import java.io.PrintWriter; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.List; import org.apache.commons.cli.HelpFormatter; import org.apache.commons.cli.Options; import org.osgi.framework.BundleContext; import org.osgi.framework.FrameworkUtil; import org.osgi.framework.ServiceReference; import com.redhat.thermostat.common.cli.Arguments; import com.redhat.thermostat.common.cli.CommandContext; import com.redhat.thermostat.common.cli.CommandInfo; import com.redhat.thermostat.common.cli.CommandInfoNotFoundException; import com.redhat.thermostat.common.cli.CommandInfoSource; import com.redhat.thermostat.common.cli.SimpleCommand; import com.redhat.thermostat.common.cli.TableRenderer; import com.redhat.thermostat.common.locale.Translate; public class HelpCommand extends SimpleCommand { private static final Translate<LocaleResources> translator = LocaleResources.createLocalizer(); private static final int COMMANDS_COLUMNS_WIDTH = 14; private static final String NAME = "help"; private static final String APP_NAME = "thermostat"; private static final CommandInfoComparator comparator = new CommandInfoComparator(); @Override public void run(CommandContext ctx) { Arguments args = ctx.getArguments(); List<String> nonParsed = args.getNonOptionArguments(); if (nonParsed.isEmpty()) { printCommandSummaries(ctx); } else { printCommandUsage(ctx, nonParsed.get(0)); } } private void printCommandSummaries(CommandContext ctx) { BundleContext context = FrameworkUtil.getBundle(getClass()).getBundleContext(); ServiceReference infosRef = context.getServiceReference(CommandInfoSource.class); CommandInfoSource infos = (CommandInfoSource) context.getService(infosRef); ctx.getConsole().getOutput().print(translator.localize(LocaleResources.COMMAND_HELP_COMMAND_LIST_HEADER)); TableRenderer renderer = new TableRenderer(2, COMMANDS_COLUMNS_WIDTH); Collection<CommandInfo> commandInfos = infos.getCommandInfos(); context.ungetService(infosRef); List<CommandInfo> sortedCommandInfos = new ArrayList<>(commandInfos); Collections.sort(sortedCommandInfos, comparator); for (CommandInfo info : sortedCommandInfos) { printCommandSummary(renderer, info); } renderer.render(ctx.getConsole().getOutput()); } private void printCommandSummary(TableRenderer renderer, CommandInfo info) { renderer.printLine(" " + info.getName(), info.getDescription()); } private void printCommandUsage(CommandContext ctx, String cmdName) { BundleContext context = FrameworkUtil.getBundle(getClass()).getBundleContext(); ServiceReference infosRef = context.getServiceReference(CommandInfoSource.class); CommandInfoSource infos = (CommandInfoSource) context.getService(infosRef); try { CommandInfo info = infos.getCommandInfo(cmdName); printHelp(ctx, info); } catch (CommandInfoNotFoundException notFound) { ctx.getConsole().getOutput().print(translator.localize(LocaleResources.UNKNOWN_COMMAND, cmdName)); printCommandSummaries(ctx); } finally { context.ungetService(infosRef); } } private void printHelp(CommandContext ctx, CommandInfo info) { HelpFormatter helpFormatter = new HelpFormatter(); PrintWriter pw = new PrintWriter(ctx.getConsole().getOutput()); Options options = info.getOptions(); String name = APP_NAME + " " + info.getName(); String usage = APP_NAME + " " + info.getUsage() + "\n" + info.getDescription(); helpFormatter.printHelp(pw, 80, usage, name, options, 2, 4, null); pw.flush(); } @Override public String getName() { return NAME; } @Override public boolean isStorageRequired() { return false; } private static class CommandInfoComparator implements Comparator<CommandInfo> { @Override public int compare(CommandInfo o1, CommandInfo o2) { // this command ('help') is always listed first if (o1.getName().equals(o2.getName())) { return 0; } if (o1.getName().equals(NAME)) { return -1; } if (o2.getName().equals(NAME)) { return 1; } return o1.getName().compareTo(o2.getName()); } } }