1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* SonarQube
* Copyright (C) 2009-2025 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.application.command;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.process.MessageException;
import org.sonar.process.Props;
import static java.lang.String.format;
import static java.util.Objects.requireNonNull;
import static java.util.stream.Collectors.joining;
public class JvmOptions<T extends JvmOptions> {
private static final String JVM_OPTION_NOT_NULL_ERROR_MESSAGE = "a JVM option can't be null";
private final HashMap<String, String> mandatoryOptions = new HashMap<>();
private final LinkedHashSet<String> options = new LinkedHashSet<>();
public JvmOptions() {
this(Collections.emptyMap());
}
public JvmOptions(Map<String, String> mandatoryJvmOptions) {
requireNonNull(mandatoryJvmOptions, JVM_OPTION_NOT_NULL_ERROR_MESSAGE)
.entrySet()
.stream()
.filter(e -> {
requireNonNull(e.getKey(), "JVM option prefix can't be null");
if (e.getKey().trim().isEmpty()) {
throw new IllegalArgumentException("JVM option prefix can't be empty");
}
requireNonNull(e.getValue(), "JVM option value can't be null");
return true;
}).forEach(e -> {
String key = e.getKey().trim();
String value = e.getValue().trim();
mandatoryOptions.put(key, value);
add(key + value);
});
}
public T addFromMandatoryProperty(Props props, String propertyName) {
String value = props.nonNullValue(propertyName);
if (!value.isEmpty()) {
String splitRegex = " (?=-)";
List<String> jvmOptions = Arrays.stream(value.split(splitRegex)).map(String::trim).toList();
checkOptionFormat(propertyName, jvmOptions);
checkMandatoryOptionOverwrite(propertyName, jvmOptions);
options.addAll(jvmOptions);
}
return castThis();
}
private static void checkOptionFormat(String propertyName, List<String> jvmOptionsFromProperty) {
List<String> invalidOptions = jvmOptionsFromProperty.stream()
.filter(JvmOptions::isInvalidOption)
.toList();
if (!invalidOptions.isEmpty()) {
throw new MessageException(format(
"a JVM option can't be empty and must start with '-'. The following JVM options defined by property '%s' are invalid: %s",
propertyName,
invalidOptions.stream()
.collect(joining(", "))));
}
}
private void checkMandatoryOptionOverwrite(String propertyName, List<String> jvmOptionsFromProperty) {
List<Match> matches = jvmOptionsFromProperty.stream()
.map(jvmOption -> new Match(jvmOption, mandatoryOptionFor(jvmOption)))
.filter(match -> match.mandatoryOption() != null)
.toList();
if (!matches.isEmpty()) {
throw new MessageException(format(
"a JVM option can't overwrite mandatory JVM options. The following JVM options defined by property '%s' are invalid: %s",
propertyName,
matches.stream()
.map(m -> m.option() + " overwrites " + m.mandatoryOption.getKey() + m.mandatoryOption.getValue())
.collect(joining(", "))));
}
}
/**
* Add an option.
* Argument is trimmed before being added.
*
* @throws IllegalArgumentException if argument is empty or does not start with {@code -}.
*/
public T add(String str) {
requireNonNull(str, JVM_OPTION_NOT_NULL_ERROR_MESSAGE);
String value = str.trim();
if (isInvalidOption(value)) {
throw new IllegalArgumentException("a JVM option can't be empty and must start with '-'");
}
checkMandatoryOptionOverwrite(value);
options.add(value);
return castThis();
}
private void checkMandatoryOptionOverwrite(String value) {
Map.Entry<String, String> overriddenMandatoryOption = mandatoryOptionFor(value);
if (overriddenMandatoryOption != null) {
throw new MessageException(String.format(
"a JVM option can't overwrite mandatory JVM options. %s overwrites %s",
value,
overriddenMandatoryOption.getKey() + overriddenMandatoryOption.getValue()));
}
}
@CheckForNull
private Map.Entry<String, String> mandatoryOptionFor(String jvmOption) {
return mandatoryOptions.entrySet().stream()
.filter(s -> jvmOption.startsWith(s.getKey()) && !jvmOption.equals(s.getKey() + s.getValue()))
.findFirst()
.orElse(null);
}
private static boolean isInvalidOption(String value) {
return value.isEmpty() || !value.startsWith("-");
}
@SuppressWarnings("unchecked")
private T castThis() {
return (T) this;
}
public List<String> getAll() {
return new ArrayList<>(options);
}
@Override
public String toString() {
return options.toString();
}
private record Match(String option, Map.Entry<String, String> mandatoryOption) {
private Match(String option, @Nullable Map.Entry<String, String> mandatoryOption) {
this.option = option;
this.mandatoryOption = mandatoryOption;
}
}
}
|
