Mercurial > hg > release > thermostat-0.5
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/PluginConfigurationParser.java @ 936:1936ad067842
Make it easier to install plugins
Reviewed-by: jerboaa, neugens
Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-January/005355.html
PR 1254
author | Omair Majid <omajid@redhat.com> |
---|---|
date | Mon, 28 Jan 2013 16:03:37 -0500 |
parents | |
children |
line wrap: on
line source
/* * Copyright 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.launcher.internal; import java.io.File; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.IOException; import java.io.InputStream; import java.util.ArrayList; import java.util.Collections; import java.util.List; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import org.apache.commons.cli.Options; import org.w3c.dom.Document; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import org.xml.sax.SAXException; import com.redhat.thermostat.common.Pair; import com.redhat.thermostat.launcher.internal.PluginConfiguration.CommandExtensions; import com.redhat.thermostat.launcher.internal.PluginConfiguration.NewCommand; public class PluginConfigurationParser { // no state :) public PluginConfiguration parse(File configurationFile) throws FileNotFoundException { return parse(new FileInputStream(configurationFile)); } public PluginConfiguration parse(InputStream configurationStream) { try { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); DocumentBuilder builder = factory.newDocumentBuilder(); Document xmlDoc = builder.parse(configurationStream); Node rootNode = xmlDoc.getFirstChild(); if (rootNode == null) { throw new PluginConfigurationParseException("no configuration found"); } return parseRootElement(rootNode); } catch (ParserConfigurationException | SAXException | IOException exception) { throw new PluginConfigurationParseException("failed to parse plugin configuration", exception); } } private PluginConfiguration parseRootElement(Node root) { List<NewCommand> newCommands = Collections.emptyList(); List<CommandExtensions> extensions = Collections.emptyList(); Pair<List<NewCommand>, List<CommandExtensions>> commands = new Pair<>(newCommands, extensions); if (root.getNodeName().equals("plugin")) { NodeList nodes = root.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("commands")) { commands = parseCommands(node); } } } return new PluginConfiguration(commands.getFirst(), commands.getSecond()); } private Pair<List<NewCommand>, List<CommandExtensions>> parseCommands(Node commandsNode) { List<NewCommand> newCommands = new ArrayList<NewCommand>(); List<CommandExtensions> extendedCommands = new ArrayList<CommandExtensions>(); NodeList childNodes = commandsNode.getChildNodes(); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("new")) { newCommands.add(parseNewCommand(node)); } else if (node.getNodeName().equals("existing")) { extendedCommands.add(parseAdditionsToExistingCommand(node)); } } return new Pair<>(newCommands, extendedCommands); } private CommandExtensions parseAdditionsToExistingCommand(Node commandNode) { String name = null; List<String> bundles = new ArrayList<>(); List<String> dependencies = new ArrayList<>(); NodeList nodes = commandNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("name")) { name = node.getTextContent(); } else if (node.getNodeName().equals("bundles")) { String[] bundleNames = node.getTextContent().split(","); for (String bundleName : bundleNames) { if (bundleName.trim().length() == 0) { continue; } bundles.add(bundleName.trim()); } } else if (node.getNodeName().equals("dependencies")) { String[] dependencyNames = node.getTextContent().split(","); for (String bundleName : dependencyNames) { if (bundleName.trim().length() == 0) { continue; } dependencies.add(bundleName); } } } return new CommandExtensions(name, bundles, dependencies); } private NewCommand parseNewCommand(Node commandNode) { String name = null; String usage = null; String description = null; Options options = null; List<String> bundles = new ArrayList<>(); List<String> dependencies = new ArrayList<>(); NodeList nodes = commandNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("name")) { name = node.getTextContent(); } else if (node.getNodeName().equals("usage")) { usage = node.getTextContent(); } else if (node.getNodeName().equals("description")) { description = node.getTextContent(); } else if (node.getNodeName().equals("arguments")) { options = parseArguments(node); } else if (node.getNodeName().equals("bundles")) { String[] bundleNames = node.getTextContent().split(","); for (String bundleName : bundleNames) { if (bundleName.trim().length() == 0) { continue; } bundles.add(bundleName); } } else if (node.getNodeName().equals("dependencies")) { String[] dependencyNames = node.getTextContent().split(","); for (String bundleName : dependencyNames) { if (bundleName.trim().length() == 0) { continue; } dependencies.add(bundleName); } } } return new NewCommand(name, usage, description, options, bundles, dependencies); } private Options parseArguments(Node argumentsNode) { // need to identify a way to express arguments return null; } }