Mercurial > hg > release > thermostat-0.4
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/LauncherImpl.java @ 636:9e4437930235
Add DB connection service
This should improve usability of the Thermostat shell. In particular in a
remote setup. The current situation is that if a shell is fired up it does not
make a connection to storage. So if a user has storage set up to bind to a
"public" IP, 192.1.1.129 say, then mongo requires username/password for
connections. This results in bad usability of the shell:
./bin/thermostat shell
Thermostat > ping
Could not connect to db mongodb://192.168.1.14:27518
(creds are missing or incorrect host IP in user prefs)
Thermostat > ping --username blah --password blah -d
mongodb://example.org
(works)
Thermostat > list-vms --username blah --password blah -d ...
(i.e. a user needs to pass credential info for every command on the
shell).
This patch introduces a "connect" and "disconnect" command which
establishes a DB connection on demand and registers a DbService. The
above shell session becomes:
./bin/thermostat shell
Thermostat > ping
Could not connect to db mongodb://192.168.1.14:27518
Thermostat > connect -d mongodb://192.168.1.14:27518 -u blah -p blah
Thermostat > ping agent-id
(works)
Thermostat > list-vms
(works)
Thermostat > disconnect
(disconnects from mongo storage at 192.168.1.14:27518)
Thermostat > ping
Could not connect to db mongodb://192.168.1.14:27518
Details of the patch:
-----------------------------------------------------------------
1. It removes AppContextSetup/AppContextSetupImpl
2. Modifies LauncherImpl in order to use the new DbService (i.e.
other use cases remain the same)
3. OSGIUtils now returns the ServiceRegistration for registered
services.
4. Added a method which allows services to be null to OSGIUtils.
Existing getService() throws a NPE if the service reference is
null (bundleContext.getServiceReference(clazz)).
5. Adds ConnectCommand ("connect" on shell)
6. Adds DisconnectCommand ("disconnect" on shell)
7. Tests
Reviewed-by: omajid
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2012-September/003341.html
PR1164
author | Severin Gehwolf <sgehwolf@redhat.com> |
---|---|
date | Fri, 21 Sep 2012 18:17:41 +0200 |
parents | fda64c331b67 |
children | 73c182a706fc |
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.IOException; import java.io.PrintStream; import java.util.Arrays; import java.util.Collection; import java.util.concurrent.Semaphore; import java.util.logging.Level; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleException; import org.osgi.framework.ServiceRegistration; import com.redhat.thermostat.bundles.OSGiRegistry; import com.redhat.thermostat.common.ActionListener; import com.redhat.thermostat.common.ActionNotifier; import com.redhat.thermostat.common.TimerFactory; import com.redhat.thermostat.common.Version; import com.redhat.thermostat.common.appctx.ApplicationContext; import com.redhat.thermostat.common.cli.ArgumentSpec; import com.redhat.thermostat.common.cli.Arguments; import com.redhat.thermostat.common.cli.Command; import com.redhat.thermostat.common.cli.CommandContext; import com.redhat.thermostat.common.cli.CommandContextFactory; import com.redhat.thermostat.common.cli.CommandException; import com.redhat.thermostat.common.cli.CommandRegistry; import com.redhat.thermostat.common.config.ClientPreferences; import com.redhat.thermostat.common.config.InvalidConfigurationException; import com.redhat.thermostat.common.storage.ConnectionException; import com.redhat.thermostat.common.tools.ApplicationState; import com.redhat.thermostat.common.tools.BasicCommand; import com.redhat.thermostat.common.utils.LoggingUtils; import com.redhat.thermostat.common.utils.OSGIUtils; import com.redhat.thermostat.launcher.CommonCommandOptions; import com.redhat.thermostat.launcher.DbService; import com.redhat.thermostat.launcher.DbServiceFactory; import com.redhat.thermostat.launcher.Launcher; import com.redhat.thermostat.utils.keyring.Keyring; public class LauncherImpl implements Launcher { private static final String UNKNOWN_COMMAND_MESSAGE = "unknown command '%s'\n"; private ClientPreferences prefs; private String[] args; private CommandContextFactory cmdCtxFactory; private int usageCount = 0; private final Semaphore argsBarrier = new Semaphore(0); private BundleContext context; private OSGiRegistry registry; public LauncherImpl(BundleContext context, CommandContextFactory cmdCtxFactory, OSGiRegistry registry) { this.context = context; this.cmdCtxFactory = cmdCtxFactory; this.registry = registry; } @Override public synchronized void run() { run(null); } @Override public synchronized void run(Collection<ActionListener<ApplicationState>> listeners) { usageCount++; try { argsBarrier.acquire(); } catch (InterruptedException e) { e.printStackTrace(); } try { // TODO move this logging init out where it's not part of every command launch initLogging(); if (hasNoArguments()) { runHelpCommand(); } else if (isVersionQuery()) { // We want to print the version of core // thermostat, so we use the no-arg constructor of Version Version coreVersion = new Version(); cmdCtxFactory.getConsole().getOutput().println(coreVersion.getVersionInfo()); } else { runCommandFromArguments(listeners); } } finally { args = null; usageCount--; if (isLastLaunch()) { shutdown(); } } } @Override public void setArgs(String[] args) { this.args = args; argsBarrier.release(); } private boolean isLastLaunch() { return usageCount == 0; } private void shutdown() throws InternalError { try { TimerFactory tf = ApplicationContext.getInstance().getTimerFactory(); if (tf != null) { tf.shutdown(); } context.getBundle(0).stop(); } catch (BundleException e) { throw (InternalError) new InternalError().initCause(e); } } public void setPreferences(ClientPreferences prefs) { this.prefs = prefs; } private void initLogging() { try { LoggingUtils.loadGlobalLoggingConfig(); } catch (InvalidConfigurationException e) { System.err.println("WARNING: Could not read global Thermostat logging configuration."); } try { LoggingUtils.loadUserLoggingConfig(); } catch (InvalidConfigurationException e) { // We intentionally ignore this. } } private boolean hasNoArguments() { return args.length == 0; } private void runHelpCommand() { runCommand("help", new String[0], null); } private void runCommandFromArguments(Collection<ActionListener<ApplicationState>> listeners) { runCommand(args[0], Arrays.copyOfRange(args, 1, args.length), listeners); } private void runCommand(String cmdName, String[] cmdArgs, Collection<ActionListener<ApplicationState>> listeners) { try { parseArgsAndRunCommand(cmdName, cmdArgs, listeners); } catch (CommandException e) { cmdCtxFactory.getConsole().getError().println(e.getMessage()); } } private void parseArgsAndRunCommand(String cmdName, String[] cmdArgs, Collection<ActionListener<ApplicationState>> listeners) throws CommandException { PrintStream out = cmdCtxFactory.getConsole().getOutput(); try { registry.addBundlesFor(cmdName); } catch (BundleException | IOException e) { // If this happens we definitely need to do something about it, and the // trace will be immeasurably helpful in figuring out what is wrong. out.println("Could not load necessary bundles for: " + cmdName); e.printStackTrace(out); return; } Command cmd = getCommand(cmdName); if (cmd == null) { out.print(String.format(UNKNOWN_COMMAND_MESSAGE, cmdName)); runHelpCommand(); return; } if (listeners != null && cmd instanceof BasicCommand) { BasicCommand basicCmd = (BasicCommand) cmd; ActionNotifier<ApplicationState> notifier = basicCmd.getNotifier(); for (ActionListener<ApplicationState> listener : listeners) { notifier.addActionListener(listener); } } CommonCommandOptions commonOpts = new CommonCommandOptions(); Collection<ArgumentSpec> acceptedOptions = commonOpts.getAcceptedOptionsFor(cmd); Arguments args = parseCommandArguments(cmdArgs, acceptedOptions); setupLogLevel(args); CommandContext ctx = setupCommandContext(cmd, args); cmd.run(ctx); } private void setupLogLevel(Arguments args) { if (args.hasArgument(CommonCommandOptions.LOG_LEVEL_ARG)) { String levelOption = args.getArgument(CommonCommandOptions.LOG_LEVEL_ARG); setLogLevel(levelOption); } } private void setLogLevel(String levelOption) { try { Level level = Level.parse(levelOption); LoggingUtils.setGlobalLogLevel(level); } catch (IllegalArgumentException ex) { // Ignore this, use default loglevel. } } private Command getCommand(String cmdName) { CommandRegistry registry = cmdCtxFactory.getCommandRegistry(); Command cmd = registry.getCommand(cmdName); return cmd; } private Arguments parseCommandArguments(String[] cmdArgs, Collection<ArgumentSpec> acceptedArguments) throws CommandLineArgumentParseException { CommandLineArgumentsParser cliArgsParser = new CommandLineArgumentsParser(); cliArgsParser.addArguments(acceptedArguments); Arguments args = cliArgsParser.parse(cmdArgs); return args; } @SuppressWarnings("rawtypes") private CommandContext setupCommandContext(Command cmd, Arguments args) throws CommandException { CommandContext ctx = cmdCtxFactory.createContext(args); if (prefs == null) { prefs = new ClientPreferences(OSGIUtils.getInstance().getService(Keyring.class)); } if (cmd.isStorageRequired()) { DbService service = OSGIUtils.getInstance().getServiceAllowNull(DbService.class); if (service == null) { String dbUrl = ctx.getArguments().getArgument(CommonCommandOptions.DB_URL_ARG); if (dbUrl == null) { dbUrl = prefs.getConnectionUrl(); } String username = ctx.getArguments().getArgument(CommonCommandOptions.USERNAME_ARG); String password = ctx.getArguments().getArgument(CommonCommandOptions.PASSWORD_ARG); service = DbServiceFactory.createDbService(username, password, dbUrl); try { service.connect(); } catch (ConnectionException ex) { throw new CommandException("Could not connect to: " + dbUrl, ex); } ServiceRegistration registration = OSGIUtils.getInstance().registerService(DbService.class, service); service.setServiceRegistration(registration); } } return ctx; } private boolean isVersionQuery() { return args[0].equals(Version.VERSION_OPTION); } }