Mercurial > hg > release > thermostat-0.7
view vm-heap-analysis/command/src/main/java/com/redhat/thermostat/vm/heap/analysis/command/internal/SaveHeapDumpToFileCommand.java @ 1045:3526e4183714
Remove OSGIUtils
This commit removes OSGIUtils. This class duplicated a lot of
functionality from BundleContext, and hides some important details about
OSGi such as where the underlying BundleContext comes from. For
instance, when developing the Eclipse client, at first the common-core
bundle wasn't started. This lead to NPEs in OSGIUtils because it uses
the BundleContext of the common-core bundle and not the bundle of the
calling class or the bundle containing the requested service. Another
problem with OSGIUtils is from several cases in Thermostat where we are
using getService instead of getServiceAllowNull, which throws NPEs if
the requested service is not registered.
Uses of OSGIUtils have been replaced with either a ServiceTracker for
long-running tasks (e.g. GUI), or for shell commands using a
BundleContext and checking the ServiceReference for null and throwing a
meaningful exception.
Reviewed-by: jerboaa, vanaltj, neugens
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-March/006104.html
author | Elliott Baron <ebaron@redhat.com> |
---|---|
date | Fri, 22 Mar 2013 12:01:35 -0400 |
parents | e765c145d124 |
children |
line wrap: on
line source
/* * Copyright 2012, 2013 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.vm.heap.analysis.command.internal; import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.FileNotFoundException; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import org.osgi.framework.BundleContext; import org.osgi.framework.FrameworkUtil; import org.osgi.framework.ServiceReference; import com.redhat.thermostat.common.cli.AbstractCommand; import com.redhat.thermostat.common.cli.Arguments; import com.redhat.thermostat.common.cli.CommandContext; import com.redhat.thermostat.common.cli.CommandException; import com.redhat.thermostat.common.locale.Translate; import com.redhat.thermostat.common.utils.StreamUtils; import com.redhat.thermostat.vm.heap.analysis.command.locale.LocaleResources; import com.redhat.thermostat.vm.heap.analysis.common.HeapDAO; import com.redhat.thermostat.vm.heap.analysis.common.model.HeapInfo; public class SaveHeapDumpToFileCommand extends AbstractCommand { private static final Translate<LocaleResources> translator = LocaleResources.createLocalizer(); private static final String NAME = "save-heap-dump-to-file"; private static final String HEAP_ID_ARGUMENT = "heapId"; private static final String FILE_NAME_ARGUMENT = "file"; private final FileStreamCreator creator; private final BundleContext context; public SaveHeapDumpToFileCommand() { this(FrameworkUtil.getBundle(SaveHeapDumpToFileCommand.class).getBundleContext(), new FileStreamCreator()); } SaveHeapDumpToFileCommand(BundleContext context, FileStreamCreator creator) { this.context = context; this.creator = creator; } @Override public String getName() { return NAME; } @Override public void run(CommandContext ctx) throws CommandException { ServiceReference ref = context.getServiceReference(HeapDAO.class.getName()); if (ref == null) { throw new CommandException(translator.localize(LocaleResources.HEAP_SERVICE_UNAVAILABLE)); } HeapDAO heapDAO = (HeapDAO) context.getService(ref); try { run(ctx, heapDAO); } finally { context.ungetService(ref); heapDAO = null; } } private void run(CommandContext ctx, HeapDAO heapDAO) throws CommandException { Arguments args = ctx.getArguments(); String heapId = args.getArgument(HEAP_ID_ARGUMENT); if (heapId == null) { throw new CommandException(translator.localize(LocaleResources.HEAP_ID_REQUIRED)); } String filename = args.getArgument(FILE_NAME_ARGUMENT); if (filename == null) { throw new CommandException(translator.localize(LocaleResources.FILE_REQUIRED)); } HeapInfo heapInfo = heapDAO.getHeapInfo(heapId); try (InputStream heapStream = heapDAO.getHeapDumpData(heapInfo)) { if (heapStream != null) { try { saveHeapDump(heapStream, filename); ctx.getConsole().getOutput().println(translator.localize(LocaleResources.COMMAND_SAVE_HEAP_DUMP_SAVED_TO_FILE, filename)); } catch (IOException e) { ctx.getConsole().getOutput().println(translator.localize(LocaleResources.COMMAND_SAVE_HEAP_DUMP_ERROR_SAVING, e.getMessage())); } } else { ctx.getConsole().getOutput().println(translator.localize(LocaleResources.HEAP_ID_NOT_FOUND, heapId)); } } catch (IOException e) { throw new CommandException(translator.localize(LocaleResources.COMMAND_SAVE_HEAP_DUMP_ERROR_CLOSING_STREAM, e.getMessage())); } } private void saveHeapDump(InputStream heapStream, String filename) throws FileNotFoundException, IOException { try (BufferedInputStream bis = new BufferedInputStream(heapStream); BufferedOutputStream bout = new BufferedOutputStream(creator.createOutputStream(filename))) { StreamUtils.copyStream(bis, bout); } } static class FileStreamCreator { public OutputStream createOutputStream(String filename) throws FileNotFoundException { return new FileOutputStream(filename); } } }