jdk/src/jdk.jlink/share/classes/jdk/tools/jlink/internal/packager/AppRuntimeImageBuilder.java
author mchung
Sun, 19 Jun 2016 16:46:49 -0700
changeset 39125 e97953d38291
parent 38320 e24c7029e8ba
child 39308 f6517755057f
permissions -rw-r--r--
8155955: packager needs to determine the root modules to create JRE image Reviewed-by: alanb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
37779
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     1
/*
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     2
 * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     4
 *
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    10
 *
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    15
 * accompanied this code).
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    16
 *
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    20
 *
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    23
 * questions.
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    24
 */
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    25
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    26
package jdk.tools.jlink.internal.packager;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    27
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    28
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    29
import jdk.tools.jlink.Jlink;
39125
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
    30
import jdk.tools.jlink.builder.DefaultImageBuilder;
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
    31
import jdk.tools.jlink.internal.JlinkTask;
37779
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    32
import jdk.tools.jlink.plugin.Plugin;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    33
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    34
import java.io.File;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    35
import java.io.IOException;
39125
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
    36
import java.lang.module.ModuleFinder;
37779
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    37
import java.nio.file.Path;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    38
import java.util.ArrayList;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    39
import java.util.Collections;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    40
import java.util.List;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    41
import java.util.Map;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    42
import java.util.Set;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    43
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    44
/**
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    45
 * AppRuntimeImageBuilder is a private API used only by the Java Packager to generate
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    46
 * a Java runtime image using jlink. AppRuntimeImageBuilder encapsulates the
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    47
 * arguments that jlink requires to generate this image. To create the image call the
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    48
 * build() method.
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    49
 */
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    50
public final class AppRuntimeImageBuilder {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    51
    private Path outputDir = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    52
    private List<Path> modulePath = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    53
    private Set<String> addModules = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    54
    private Set<String> limitModules = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    55
    private String excludeFileList = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    56
    private Map<String, String> userArguments = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    57
    private Boolean stripNativeCommands = null;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    58
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    59
    public AppRuntimeImageBuilder() {}
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    60
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    61
    public void setOutputDir(Path value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    62
        outputDir = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    63
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    64
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    65
    public void setModulePath(List<Path> value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    66
        modulePath = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    67
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    68
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    69
    public void setAddModules(Set<String> value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    70
        addModules = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    71
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    72
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    73
    public void setLimitModules(Set<String> value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    74
        limitModules = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    75
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    76
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    77
    public void setExcludeFileList(String value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    78
        excludeFileList = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    79
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    80
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    81
    public void setStripNativeCommands(boolean value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    82
        stripNativeCommands = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    83
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    84
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    85
    public void setUserArguments(Map<String, String> value) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    86
        userArguments = value;
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    87
    }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    88
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    89
    public void build() throws IOException {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    90
        // jlink main arguments
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    91
        Jlink.JlinkConfiguration jlinkConfig = new Jlink.JlinkConfiguration(
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    92
            new File("").toPath(), // Unused
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    93
            modulePath, addModules, limitModules);
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    94
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    95
        // plugin configuration
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    96
        List<Plugin> plugins = new ArrayList<Plugin>();
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    97
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    98
        if (stripNativeCommands) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
    99
            plugins.add(Jlink.newPlugin(
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   100
                        "strip-native-commands",
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   101
                        Collections.singletonMap("strip-native-commands", "on"),
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   102
                        null));
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   103
        }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   104
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   105
        if (excludeFileList != null && !excludeFileList.isEmpty()) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   106
            plugins.add(Jlink.newPlugin(
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   107
                        "exclude-files",
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   108
                        Collections.singletonMap("exclude-files", excludeFileList),
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   109
                        null));
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   110
        }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   111
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   112
        // add user supplied jlink arguments
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   113
        for (Map.Entry<String, String> entry : userArguments.entrySet()) {
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   114
            String key = entry.getKey();
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   115
            String value = entry.getValue();
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   116
            plugins.add(Jlink.newPlugin(key,
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   117
                                        Collections.singletonMap(key, value),
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   118
                                        null));
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   119
        }
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   120
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   121
        plugins.add(Jlink.newPlugin("installed-modules", Collections.emptyMap(), null));
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   122
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   123
        // build the image
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   124
        Jlink.PluginsConfiguration pluginConfig = new Jlink.PluginsConfiguration(
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   125
            plugins, new DefaultImageBuilder(outputDir), null);
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   126
        Jlink jlink = new Jlink();
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   127
        jlink.build(jlinkConfig, pluginConfig);
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   128
    }
39125
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   129
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   130
    /**
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   131
     * Returns a ModuleFinder that limits observability to the given root
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   132
     * modules, their transitive dependences, plus a set of other modules.
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   133
     */
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   134
    public static ModuleFinder moduleFinder(List<Path> modulepaths,
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   135
                                            Set<String> roots,
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   136
                                            Set<String> otherModules) {
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   137
        return JlinkTask.newModuleFinder(modulepaths, roots, otherModules);
e97953d38291 8155955: packager needs to determine the root modules to create JRE image
mchung
parents: 38320
diff changeset
   138
    }
37779
7c84df693837 8154956: Module system implementation refresh (4/2016)
alanb
parents:
diff changeset
   139
}