1 /* 2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 package jdk.tools.jlink.internal; 26 27 import java.io.DataOutputStream; 28 29 import java.io.IOException; 30 import java.util.ArrayList; 31 import java.util.LinkedHashMap; 32 import java.util.List; 33 import java.util.Map; 34 import java.util.Map.Entry; 35 import jdk.tools.jlink.builder.ImageBuilder; 36 import jdk.tools.jlink.Jlink; 37 import jdk.tools.jlink.plugin.Plugin; 38 import jdk.tools.jlink.plugin.PluginException; 39 import jdk.tools.jlink.plugin.Plugin.Category; 40 import jdk.tools.jlink.plugin.ModulePool; 41 42 /** 43 * Plugins configuration. 44 */ 45 public final class ImagePluginConfiguration { 46 47 private static final List<Category> CATEGORIES_ORDER = new ArrayList<>(); 48 49 static { 50 CATEGORIES_ORDER.add(Category.FILTER); 51 CATEGORIES_ORDER.add(Category.TRANSFORMER); 52 CATEGORIES_ORDER.add(Category.MODULEINFO_TRANSFORMER); 53 CATEGORIES_ORDER.add(Category.SORTER); 54 CATEGORIES_ORDER.add(Category.COMPRESSOR); 55 CATEGORIES_ORDER.add(Category.METAINFO_ADDER); 56 CATEGORIES_ORDER.add(Category.VERIFIER); 57 CATEGORIES_ORDER.add(Category.PROCESSOR); 58 CATEGORIES_ORDER.add(Category.PACKAGER); 59 } 60 61 private ImagePluginConfiguration() { 62 } 63 64 /* 65 * Create a stack of plugins from a a configuration. 66 */ 67 public static ImagePluginStack parseConfiguration(Jlink.PluginsConfiguration pluginsConfiguration) 68 throws Exception { 69 if (pluginsConfiguration == null) { 70 return new ImagePluginStack(); 71 } 72 Map<Category, List<Plugin>> plugins = new LinkedHashMap<>(); 73 for (Category cat : CATEGORIES_ORDER) { 74 plugins.put(cat, new ArrayList<>()); 75 } 76 77 List<String> seen = new ArrayList<>(); 78 // split into categories and check for plugin with same name. 79 for (Plugin plug : pluginsConfiguration.getPlugins()) { 80 if (seen.contains(plug.getName())) { 81 throw new Exception("Plugin " + plug.getName() 82 + " added more than once to stack "); 83 } 84 seen.add(plug.getName()); 85 Category category = plug.getType(); 86 if (category == null) { 87 throw new PluginException("Invalid category for " 88 + plug.getName()); 89 } 90 List<Plugin> lst = plugins.get(category); 91 lst.add(plug); 92 } 93 94 List<Plugin> orderedPlugins = new ArrayList<>(); 95 plugins.entrySet().stream().forEach((entry) -> { 96 orderedPlugins.addAll(entry.getValue()); 97 }); 98 Plugin lastSorter = null; 99 for (Plugin plugin : orderedPlugins) { 100 if (plugin.getName().equals(pluginsConfiguration.getLastSorterPluginName())) { 101 lastSorter = plugin; 102 break; 103 } 104 } 105 if (pluginsConfiguration.getLastSorterPluginName() != null && lastSorter == null) { 106 throw new IOException("Unknown last plugin " 107 + pluginsConfiguration.getLastSorterPluginName()); 108 } 109 ImageBuilder builder = pluginsConfiguration.getImageBuilder(); 110 if (builder == null) { 111 // This should be the case for jimage only creation or post-install. 112 builder = new ImageBuilder() { 113 114 @Override 115 public DataOutputStream getJImageOutputStream() { 116 throw new PluginException("No directory setup to store files"); 117 } 118 119 @Override 120 public ExecutableImage getExecutableImage() { 121 throw new PluginException("No directory setup to store files"); 122 } 123 124 @Override 125 public void storeFiles(ModulePool files) { 126 throw new PluginException("No directory setup to store files"); 127 } 128 }; 129 } 130 131 return new ImagePluginStack(builder, orderedPlugins, lastSorter); 132 } 133 }