Mercurial > hg > release > thermostat-0.4
view common/core/src/main/java/com/redhat/thermostat/common/utils/OSGIUtils.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 | 0375b44c73d4 |
children |
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.common.utils; import java.util.Dictionary; import org.osgi.framework.BundleContext; import org.osgi.framework.FrameworkUtil; import org.osgi.framework.ServiceReference; import org.osgi.framework.ServiceRegistration; public class OSGIUtils { // TODO: Maybe we should stick this singleton into an ApplicationContext? private static OSGIUtils instance = new OSGIUtils(); public static OSGIUtils getInstance() { return instance; } // This is only here to be used by test code. public static void setInstance(OSGIUtils utils) { instance = utils; } /** * Gets a service and never return null. It will throw a NullPointerException * before it returns. * * @param clazz * @return The best matching service implementation for the requested clazz. */ @SuppressWarnings({ "rawtypes", "unchecked" }) public <E extends Object> E getService(Class<E> clazz) { BundleContext ctx = FrameworkUtil.getBundle(getClass()).getBundleContext(); ServiceReference ref = ctx.getServiceReference(clazz.getName()); return (E) ctx.getService(ref); } @SuppressWarnings({ "rawtypes", "unchecked" }) public <E extends Object> E getServiceAllowNull(Class<E> clazz) { BundleContext ctx = FrameworkUtil.getBundle(getClass()).getBundleContext(); ServiceReference ref = ctx.getServiceReference(clazz.getName()); if (ref == null) { return null; } return (E) ctx.getService(ref); } @SuppressWarnings("rawtypes") public <E extends Object> ServiceRegistration registerService(Class<? extends E> serviceClass, E service) { return registerService(serviceClass, service, null); } @SuppressWarnings("rawtypes") public <E extends Object> ServiceRegistration registerService(Class<? extends E> serviceClass, E service, Dictionary<String, ?> properties) { BundleContext ctx = FrameworkUtil.getBundle(getClass()).getBundleContext(); return ctx.registerService(serviceClass.getName(), service, properties); } }