view tools/src/main/java/com/redhat/thermostat/tools/cli/ConnectCommand.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
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.tools.cli;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.osgi.framework.ServiceRegistration;

import com.redhat.thermostat.common.cli.ArgumentSpec;
import com.redhat.thermostat.common.cli.CommandContext;
import com.redhat.thermostat.common.cli.CommandException;
import com.redhat.thermostat.common.cli.SimpleArgumentSpec;
import com.redhat.thermostat.common.cli.SimpleCommand;
import com.redhat.thermostat.common.config.ClientPreferences;
import com.redhat.thermostat.common.storage.ConnectionException;
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.tools.LocaleResources;
import com.redhat.thermostat.tools.Translate;
import com.redhat.thermostat.utils.keyring.Keyring;

/**
 * Command in order to persistently connect to a database. Available only in
 * shell.
 * 
 * This commands registers a connection service. If this service is available,
 * it can be used to retrieve a DB connection.
 * 
 */
public class ConnectCommand extends SimpleCommand {

    private static final String NAME = "connect";
    private static final String USAGE = "connect -d <url> [-u <username>] [-p <password>]";
    private static final String DESC = Translate.localize(LocaleResources.COMMAND_CONNECT_DESCRIPTION);
    
    private ClientPreferences prefs;
    
    @SuppressWarnings("rawtypes")
    @Override
    public void run(CommandContext ctx) throws CommandException {
        DbService service = OSGIUtils.getInstance().getServiceAllowNull(DbService.class);
        if (service != null) {
            // Already connected, bail out
            throw new CommandException(Translate.localize(LocaleResources.COMMAND_CONNECT_ALREADY_CONNECTED));
        }
        if (prefs == null) {
            prefs = new ClientPreferences(OSGIUtils.getInstance().getService(Keyring.class));
        }
        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(Translate.localize(LocaleResources.COMMAND_CONNECT_FAILED_TO_CONNECT, dbUrl), ex);
        }
        ServiceRegistration registration = OSGIUtils.getInstance().registerService(DbService.class, service);
        service.setServiceRegistration(registration);
    }

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public String getDescription() {
        return DESC;
    }

    @Override
    public String getUsage() {
        return USAGE;
    }

    @Override
    public Collection<ArgumentSpec> getAcceptedArguments() {
        List<ArgumentSpec> acceptedArgs = new ArrayList<>();
        acceptedArgs.add(new SimpleArgumentSpec(CommonCommandOptions.DB_URL_ARG, "d", CommonCommandOptions.DB_URL_DESC, true, true));
        acceptedArgs.add(new SimpleArgumentSpec(CommonCommandOptions.USERNAME_ARG, "u", CommonCommandOptions.USERNAME_DESC, false, true));
        acceptedArgs.add(new SimpleArgumentSpec(CommonCommandOptions.PASSWORD_ARG, "p", CommonCommandOptions.PASSWORD_DESC, false, true));
        return acceptedArgs;
    }
    
    @Override
    public boolean isAvailableOutsideShell() {
        return false;
    }
    
    @Override
    public boolean isStorageRequired() {
        return false;
    }

}