1 /*
2 * Copyright (c) 2018, 2020, 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
26 package jdk.incubator.jpackage.internal;
27
28 import java.util.HashMap;
29 import jdk.incubator.jpackage.internal.Arguments.CLIOptions;
30
31 /**
32 * ValidOptions
33 *
34 * Two basic methods for validating command line options.
35 *
36 * initArgs()
37 * Computes the Map of valid options for each mode on this Platform.
38 *
39 * checkIfSupported(CLIOptions arg)
40 * Determine if the given arg is valid on this platform.
41 *
42 * checkIfImageSupported(CLIOptions arg)
43 * Determine if the given arg is valid for creating app image.
44 *
45 * checkIfInstallerSupported(CLIOptions arg)
46 * Determine if the given arg is valid for creating installer.
47 *
48 */
49 class ValidOptions {
50
51 enum USE {
52 ALL, // valid in all cases
53 LAUNCHER, // valid when creating a launcher
54 INSTALL // valid when creating an installer
55 }
56
57 private static final HashMap<String, USE> options = new HashMap<>();
58
59
60 // initializing list of mandatory arguments
61 static {
62 options.put(CLIOptions.NAME.getId(), USE.ALL);
63 options.put(CLIOptions.VERSION.getId(), USE.ALL);
64 options.put(CLIOptions.OUTPUT.getId(), USE.ALL);
65 options.put(CLIOptions.TEMP_ROOT.getId(), USE.ALL);
66 options.put(CLIOptions.VERBOSE.getId(), USE.ALL);
67 options.put(CLIOptions.PREDEFINED_RUNTIME_IMAGE.getId(), USE.ALL);
68 options.put(CLIOptions.RESOURCE_DIR.getId(), USE.ALL);
69 options.put(CLIOptions.DESCRIPTION.getId(), USE.ALL);
70 options.put(CLIOptions.VENDOR.getId(), USE.ALL);
71 options.put(CLIOptions.COPYRIGHT.getId(), USE.ALL);
72 options.put(CLIOptions.PACKAGE_TYPE.getId(), USE.ALL);
73
74 options.put(CLIOptions.INPUT.getId(), USE.LAUNCHER);
75 options.put(CLIOptions.MODULE.getId(), USE.LAUNCHER);
76 options.put(CLIOptions.MODULE_PATH.getId(), USE.LAUNCHER);
77 options.put(CLIOptions.ADD_MODULES.getId(), USE.LAUNCHER);
78 options.put(CLIOptions.MAIN_JAR.getId(), USE.LAUNCHER);
79 options.put(CLIOptions.APPCLASS.getId(), USE.LAUNCHER);
80 options.put(CLIOptions.ICON.getId(), USE.LAUNCHER);
81 options.put(CLIOptions.ARGUMENTS.getId(), USE.LAUNCHER);
82 options.put(CLIOptions.JAVA_OPTIONS.getId(), USE.LAUNCHER);
83 options.put(CLIOptions.ADD_LAUNCHER.getId(), USE.LAUNCHER);
84 options.put(CLIOptions.BIND_SERVICES.getId(), USE.LAUNCHER);
85 options.put(CLIOptions.JLINK_OPTIONS.getId(), USE.LAUNCHER);
86
87 options.put(CLIOptions.LICENSE_FILE.getId(), USE.INSTALL);
88 options.put(CLIOptions.INSTALL_DIR.getId(), USE.INSTALL);
89 options.put(CLIOptions.PREDEFINED_APP_IMAGE.getId(), USE.INSTALL);
90
91 options.put(CLIOptions.FILE_ASSOCIATIONS.getId(),
92 (Platform.getPlatform() == Platform.MAC) ? USE.ALL : USE.INSTALL);
93
94 if (Platform.getPlatform() == Platform.WINDOWS) {
95 options.put(CLIOptions.WIN_CONSOLE_HINT.getId(), USE.LAUNCHER);
96
97 options.put(CLIOptions.WIN_MENU_HINT.getId(), USE.INSTALL);
98 options.put(CLIOptions.WIN_MENU_GROUP.getId(), USE.INSTALL);
99 options.put(CLIOptions.WIN_SHORTCUT_HINT.getId(), USE.INSTALL);
100 options.put(CLIOptions.WIN_DIR_CHOOSER.getId(), USE.INSTALL);
101 options.put(CLIOptions.WIN_UPGRADE_UUID.getId(), USE.INSTALL);
102 options.put(CLIOptions.WIN_PER_USER_INSTALLATION.getId(),
103 USE.INSTALL);
104 }
105
106 if (Platform.getPlatform() == Platform.MAC) {
107 options.put(CLIOptions.MAC_SIGN.getId(), USE.ALL);
108 options.put(CLIOptions.MAC_BUNDLE_NAME.getId(), USE.ALL);
109 options.put(CLIOptions.MAC_BUNDLE_IDENTIFIER.getId(), USE.ALL);
110 options.put(CLIOptions.MAC_BUNDLE_SIGNING_PREFIX.getId(), USE.ALL);
111 options.put(CLIOptions.MAC_SIGNING_KEY_NAME.getId(), USE.ALL);
112 options.put(CLIOptions.MAC_SIGNING_KEYCHAIN.getId(), USE.ALL);
113 }
114
115 if (Platform.getPlatform() == Platform.LINUX) {
116 options.put(CLIOptions.LINUX_BUNDLE_NAME.getId(), USE.INSTALL);
117 options.put(CLIOptions.LINUX_DEB_MAINTAINER.getId(), USE.INSTALL);
118 options.put(CLIOptions.LINUX_CATEGORY.getId(), USE.INSTALL);
119 options.put(CLIOptions.LINUX_RPM_LICENSE_TYPE.getId(), USE.INSTALL);
120 options.put(CLIOptions.LINUX_PACKAGE_DEPENDENCIES.getId(),
121 USE.INSTALL);
122 options.put(CLIOptions.LINUX_MENU_GROUP.getId(), USE.INSTALL);
123 options.put(CLIOptions.RELEASE.getId(), USE.INSTALL);
124 options.put(CLIOptions.LINUX_SHORTCUT_HINT.getId(), USE.INSTALL);
125 }
126 }
127
128 static boolean checkIfSupported(CLIOptions arg) {
129 return options.containsKey(arg.getId());
130 }
131
132 static boolean checkIfImageSupported(CLIOptions arg) {
133 USE use = options.get(arg.getId());
134 return USE.ALL == use || USE.LAUNCHER == use;
135 }
136
137 static boolean checkIfInstallerSupported(CLIOptions arg) {
138 USE use = options.get(arg.getId());
139 return USE.ALL == use || USE.INSTALL == use;
140 }
141 }