Mercurial > hg > release > thermostat-0.9
view launcher/src/main/java/com/redhat/thermostat/launcher/internal/PluginConfigurationParser.java @ 1066:c8d427902c6b
Schema for plugin.xml files
reviewed-by: neugens, omajid, jerboaa, vanaltj
contributed-by: obryan
review-thread: http://icedtea.classpath.org/pipermail/thermostat/2013-April/006307.html
author | Mario Torre <neugens.limasoftware@gmail.com> |
---|---|
date | Mon, 15 Apr 2013 15:45:04 +0200 |
parents | 2bb2a1d1aa03 |
children | dead5cab5a9a |
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.Collection; import java.util.Collections; import java.util.List; import java.util.logging.Logger; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.parsers.ParserConfigurationException; import org.apache.commons.cli.Option; import org.apache.commons.cli.OptionGroup; 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.ErrorHandler; import org.xml.sax.SAXException; import org.xml.sax.SAXParseException; import com.redhat.thermostat.common.Pair; import com.redhat.thermostat.common.utils.LoggingUtils; import com.redhat.thermostat.launcher.internal.PluginConfiguration.CommandExtensions; import com.redhat.thermostat.launcher.internal.PluginConfiguration.NewCommand; /** * Parses the configuration of a plugin as specified in an {@code File} or an * {@code InputStream}. This configuration describes which new commands this * plugin provides as well as additional jars to load for existing commands. * <p> * A example configuration looks like the following: * * <pre> * <?xml version="1.0" encoding="UTF-8"?> <plugin xmlns="http://icedtea.classpath.org/thermostat/plugins/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://icedtea.classpath.org/thermostat/plugins/v1.0"> <commands> <command> <name>platform</name> <description>launches a bare bone Platform Client</description> <options> <group> <required>true</required> <option> <long>optA</long> <short>a</short> <required>true</required> </option> <option> <long>optB</long> <short>b</short> <required>true</required> </option> <option> <long>optC</long> <short>b</short> <required>false</required> </option> <option common="true"> <long>dbUrl</long> </option> <option common="true"> <long>username</long> </option> <option common="true"> <long>password</long> </option> <option common="true"> <long>logLevel</long> </option> </group> <option> <long>heapId</long> <short>h</short> <argument>heapArgument</argument> <required>true</required> <description>the ID of the heapdump to analyze</description> </option> <option> <long>limit</long> <short>L</short> <argument>limitArgument</argument> <required>false</required> <description>limit search to top N results, defaults to 10</description> </option> </options> <bundles> <bundle>thermostat-platform-common-0.6.0-SNAPSHOT.jar</bundle> <bundle>thermostat-platform-swing-0.6.0-SNAPSHOT.jar</bundle> </bundles> <dependencies> <dependency>thermostat-client-core-0.6.0-SNAPSHOT.jar</dependency> </dependencies> </command> <command> <name>platform2</name> <description>launches a bare bone Platform Client</description> <options> <option> <long>heapId2</long> <short>h</short> <argument>heapId2Argument</argument> <required>true</required> <description>the ID of the heapdump to analyze</description> </option> <option> <long>limit2</long> <short>L</short> <argument>limit2Argument</argument> <required>false</required> <description>limit search to top N results, defaults to 10</description> </option> </options> <bundles> <bundle>thermostat-platform-common-0.6.0-SNAPSHOT.jar</bundle> <bundle>thermostat-platform-controllers-0.6.0-SNAPSHOT.jar</bundle> </bundles> <dependencies> <dependency>thermostat-common-core-0.6.0-SNAPSHOT.jar</dependency> </dependencies> </command> </commands> <extensions> <extension> <name>platform3</name> <bundles> <bundle>thermostat-platform-common-0.6.0-SNAPSHOT.jar</bundle> <bundle>thermostat-platform-controllers-0.6.0-SNAPSHOT.jar</bundle> <bundle>thermostat-platform-command-0.6.0-SNAPSHOT.jar</bundle> <bundle>thermostat-platform-common-export-0.6.0-SNAPSHOT.jar</bundle> <bundle>thermostat-platform-swing-0.6.0-SNAPSHOT.jar</bundle> </bundles> <dependencies> <dependency>thermostat-common-core-0.6.0-SNAPSHOT.jar</dependency> <dependency>thermostat-client-core-0.6.0-SNAPSHOT.jar</dependency> </dependencies> </extension> </extensions> </plugin> * </pre> * <p> * This class is thread-safe */ public class PluginConfigurationParser { private static final Logger logger = LoggingUtils.getLogger(PluginConfigurationParser.class); // thread safe because there is no state :) public PluginConfiguration parse(File configurationFile) throws FileNotFoundException { return parse(configurationFile.getParentFile().getName(), new FileInputStream(configurationFile)); } public PluginConfiguration parse(String pluginName, InputStream configurationStream) { try { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); factory.setIgnoringComments(true); DocumentBuilder builder = factory.newDocumentBuilder(); builder.setErrorHandler(new ConfigurationParserErrorHandler()); Document xmlDoc = builder.parse(configurationStream); Node rootNode = xmlDoc.getFirstChild(); if (rootNode == null) { throw new PluginConfigurationParseException("no configuration found"); } return parseRootElement(pluginName, rootNode); } catch (ParserConfigurationException | SAXException | IOException exception) { throw new PluginConfigurationParseException("failed to parse plugin configuration", exception); } } private PluginConfiguration parseRootElement(String pluginName, Node root) { List<NewCommand> commands = Collections.emptyList(); List<CommandExtensions> extensions = Collections.emptyList(); 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(pluginName, node); } else if (node.getNodeName().equals("extensions")) { extensions = parseExtensions(pluginName, node); } } } if (commands.isEmpty() && extensions.isEmpty()) { logger.warning("plugin " + pluginName + " does not extend any command or provide any new commands"); } return new PluginConfiguration(commands, extensions); } private List<NewCommand> parseCommands(String pluginName, Node commandsNode) { List<NewCommand> newCommands = new ArrayList<NewCommand>(); NodeList childNodes = commandsNode.getChildNodes(); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("command")) { NewCommand newCmd = parseNewCommand(pluginName, node); if (newCmd != null) { newCommands.add(newCmd); } } } return newCommands; } private List<CommandExtensions> parseExtensions(String pluginName, Node extensionsNode) { List<CommandExtensions> commandExtensions = new ArrayList<CommandExtensions>(); NodeList childNodes = extensionsNode.getChildNodes(); for (int i = 0; i < childNodes.getLength(); i++) { Node node = childNodes.item(i); if (node.getNodeName().equals("extension")) { CommandExtensions additions = parseAdditionsToExistingCommand(pluginName, node); if (additions != null) { commandExtensions.add(additions); } } } return commandExtensions; } private CommandExtensions parseAdditionsToExistingCommand(String pluginName, 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().trim(); } else if (node.getNodeName().equals("bundles")) { bundles.addAll(parseBundles(pluginName, name, node)); } else if (node.getNodeName().equals("dependencies")) { dependencies.addAll(parseDependencies(pluginName, name, node)); } } if (bundles.isEmpty()) { logger.warning("plugin " + pluginName + " extends the command " + name + " but supplies no bundles"); } if (name == null) { logger.warning("plugin " + pluginName + " provides extensions without specifying the command"); return null; } return new CommandExtensions(name, bundles, dependencies); } private NewCommand parseNewCommand(String pluginName, Node commandNode) { String name = null; String description = null; Options options = new Options(); 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().trim(); } else if (node.getNodeName().equals("description")) { description = node.getTextContent().trim(); } else if (node.getNodeName().equals("options")) { options = parseOptions(node); } else if (node.getNodeName().equals("bundles")) { bundles.addAll(parseBundles(pluginName, name, node)); } else if (node.getNodeName().equals("dependencies")) { dependencies.addAll(parseDependencies(pluginName, name, node)); } } if (bundles.isEmpty()) { logger.warning("plugin " + pluginName + " provides a new command " + name + " but supplies no bundles"); } if (dependencies.isEmpty()) { logger.warning("plugin " + pluginName + " provides a new command " + name + " but lists no dependencies on thermostat"); } if (name == null || description == null) { logger.warning("plugin " + pluginName + " provides an incomplete new command: " + "name='" + name + "', description='" + description + "', options='" + options + "'"); return null; } else { return new NewCommand(name, description, options, bundles, dependencies); } } private Collection<String> parseBundles(String pluginName, String commandName, Node bundlesNode) { List<String> bundles = new ArrayList<>(); NodeList nodes = bundlesNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("bundle")) { String bundleName = node.getTextContent().trim(); bundles.add(bundleName); } } if (bundles.isEmpty()) { logger.warning("plugin " + pluginName + " has an empty bundles element for command " + commandName); } return bundles; } private Collection<String> parseDependencies(String pluginName, String commandName, Node dependenciesNode) { List<String> dependencies = new ArrayList<>(); NodeList nodes = dependenciesNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("dependency")) { String bundleName = node.getTextContent().trim(); dependencies.add(bundleName); } } if (dependencies.isEmpty()) { logger.warning("plugin " + pluginName + " has an empty dependencies element for command " + commandName); } return dependencies; } private Options parseOptions(Node optionsNode) { Options opts = new Options(); NodeList nodes = optionsNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("group")) { OptionGroup group = parseOptionGroup(node); opts.addOptionGroup(group); } else if (node.getNodeName().equals("option")) { Option option = parseOption(node); if (option != null) { opts.addOption(option); } } } return opts; } private OptionGroup parseOptionGroup(Node optionGroupNode) { OptionGroup group = new OptionGroup(); NodeList nodes = optionGroupNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("option")) { Option option = parseOption(node); if (option != null) { group.addOption(option); } } else if (node.getNodeName().equals("required")) { group.setRequired(Boolean.valueOf(node.getTextContent().trim())); } } return group; } private Option parseOption(Node optionNode) { Option option; Node type = optionNode.getAttributes().getNamedItem("common"); if (type != null && Boolean.valueOf(type.getNodeValue())) { option = parseCommonOption(optionNode); } else { option = parseNormalOption(optionNode); } return option; } private Option parseCommonOption(Node optionNode) { String longName = null; String shortName = null; boolean required = false; Option option = null; NodeList nodes = optionNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("long")) { longName = node.getTextContent().trim(); } else if (node.getNodeName().equals("short")) { shortName = node.getTextContent().trim(); } else if (node.getNodeName().equals("required")) { required = Boolean.valueOf(node.getTextContent().trim()); } } List<Option> allKnownOptions = new ArrayList<Option>(); allKnownOptions.addAll(CommonOptions.getDbOptions()); allKnownOptions.add(CommonOptions.getLogOption()); for (Option knownOption : allKnownOptions) { if (knownOption.getOpt().equals(shortName) || knownOption.getLongOpt().equals(longName)) { option = new Option(knownOption.getOpt(), knownOption.getLongOpt(), knownOption.hasArg(), knownOption.getDescription()); option.setRequired(required); option.setArgName(knownOption.getArgName()); return option; } } logger.warning("The option " + longName != null ? longName : shortName + " claims to be a common option but it isn't"); return null; } private Option parseNormalOption(Node optionNode) { String longName = null; String shortName = null; String argument = null; String description = null; boolean required = false; NodeList nodes = optionNode.getChildNodes(); for (int i = 0; i < nodes.getLength(); i++) { Node node = nodes.item(i); if (node.getNodeName().equals("long")) { longName = node.getTextContent().trim(); } else if (node.getNodeName().equals("short")) { shortName = node.getTextContent().trim(); } else if (node.getNodeName().equals("argument")) { argument = node.getTextContent().trim(); } else if (node.getNodeName().equals("description")) { description = node.getTextContent().trim(); } else if (node.getNodeName().equals("required")) { required = Boolean.valueOf(node.getTextContent().trim()); } } Option opt = new Option(shortName, longName, Boolean.parseBoolean(argument), description); opt.setArgName(longName != null? longName : shortName); opt.setRequired(required); return opt; } private static class ConfigurationParserErrorHandler implements ErrorHandler { @Override public void warning(SAXParseException exception) throws SAXException { // no-op } @Override public void fatalError(SAXParseException exception) throws SAXException { throw exception; } @Override public void error(SAXParseException exception) throws SAXException { throw exception; } } }