Skip to content

Commit db40048

Browse files
committed
Be a lot more consistent in config regarding enabled
We get rid of .enable= configuration properties in favor of enabled= as most of our properties were already using this pattern.
1 parent fd3a7bf commit db40048

File tree

85 files changed

+283
-110
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+283
-110
lines changed

core/deployment/src/main/java/io/quarkus/deployment/SnapStartConfig.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ public interface SnapStartConfig {
2323
* Default value is dependent on extensions deployed
2424
* (i.e. when using AWS Lambda extensions, this will be set to true by default)
2525
*/
26+
Optional<Boolean> enabled();
27+
28+
/**
29+
* Enable/Disable SnapStart integration
30+
* <p>
31+
* Default value is dependent on extensions deployed
32+
* (i.e. when using AWS Lambda extensions, this will be set to true by default)
33+
*
34+
* @deprecated use {@code quarkus.snapstart.enabled} instead
35+
*/
36+
@Deprecated(since = "3.26", forRemoval = true)
2637
Optional<Boolean> enable();
2738

2839
/**

core/deployment/src/main/java/io/quarkus/deployment/SnapStartProcessor.java

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,10 @@ public void processSnapStart(BuildProducer<PreloadClassesEnabledBuildItem> prelo
3232
SnapStartRecorder recorder,
3333
SnapStartConfig config,
3434
Optional<SnapStartDefaultValueBuildItem> defaultVal) {
35-
if (config.enable().isPresent()) {
36-
if (!config.enable().get().booleanValue()) {
35+
Optional<Boolean> snapstartEnabled = config.enable().isPresent() ? config.enable() : config.enabled();
36+
37+
if (snapstartEnabled.isPresent()) {
38+
if (!snapstartEnabled.get().booleanValue()) {
3739
return;
3840
}
3941

@@ -54,8 +56,10 @@ public void generateClassListFromApplication(
5456
TransformedClassesBuildItem transformedClasses,
5557
ApplicationArchivesBuildItem applicationArchivesBuildItem,
5658
List<GeneratedClassBuildItem> generatedClasses) {
57-
if (config.enable().isPresent()) {
58-
if (!config.enable().get()) {
59+
Optional<Boolean> snapstartEnabled = config.enable().isPresent() ? config.enable() : config.enabled();
60+
61+
if (snapstartEnabled.isPresent()) {
62+
if (!snapstartEnabled.get().booleanValue()) {
5963
return;
6064
}
6165
} else if (defaultVal == null || !defaultVal.isPresent() || !defaultVal.get().isDefaultValue()) {

core/runtime/src/main/java/io/quarkus/runtime/logging/LogRuntimeConfig.java

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,16 @@ interface FileConfig {
178178
* If file logging should be enabled
179179
*/
180180
@WithDefault("false")
181-
boolean enable();
181+
boolean enabled();
182+
183+
/**
184+
* If file logging should be enabled
185+
*
186+
* @deprecated use {@code quarkus.log.file.enabled} instead
187+
*/
188+
// when dropping this property also adjust OpenTelemetryLogHandler
189+
@Deprecated(since = "3.26", forRemoval = true)
190+
Optional<Boolean> enable();
182191

183192
/**
184193
* The log format
@@ -269,11 +278,20 @@ interface RotationConfig {
269278
}
270279

271280
interface ConsoleConfig {
281+
272282
/**
273283
* If console logging should be enabled
274284
*/
275285
@WithDefault("true")
276-
boolean enable();
286+
boolean enabled();
287+
288+
/**
289+
* If console logging should be enabled
290+
*
291+
* @deprecated use {@code quarkus.log.console.enabled} instead
292+
*/
293+
@Deprecated(since = "3.26", forRemoval = true)
294+
Optional<Boolean> enable();
277295

278296
/**
279297
* If console logging should go to {@link System#err} instead of {@link System#out}.
@@ -331,7 +349,15 @@ interface SyslogConfig {
331349
* If syslog logging should be enabled
332350
*/
333351
@WithDefault("false")
334-
boolean enable();
352+
boolean enabled();
353+
354+
/**
355+
* If syslog logging should be enabled
356+
*
357+
* @deprecated use {@code quarkus.log.syslog.enabled} instead
358+
*/
359+
@Deprecated(since = "3.26", forRemoval = true)
360+
Optional<Boolean> enable();
335361

336362
/**
337363
*
@@ -442,7 +468,15 @@ interface SocketConfig {
442468
* If socket logging should be enabled
443469
*/
444470
@WithDefault("false")
445-
boolean enable();
471+
boolean enabled();
472+
473+
/**
474+
* If socket logging should be enabled
475+
*
476+
* @deprecated use {@code quarkus.log.socket.enabled} instead
477+
*/
478+
@Deprecated(since = "3.26", forRemoval = true)
479+
Optional<Boolean> enable();
446480

447481
/**
448482
*
@@ -507,10 +541,18 @@ interface CleanupFilterConfig {
507541
interface AsyncConfig {
508542

509543
/**
510-
* Indicates whether to log asynchronously
544+
* Whether to log asynchronously
511545
*/
512546
@WithDefault("false")
513-
boolean enable();
547+
boolean enabled();
548+
549+
/**
550+
* Whether to log asynchronously
551+
*
552+
* @deprecated use {@code .enabled} instead
553+
*/
554+
@Deprecated(since = "3.26", forRemoval = true)
555+
Optional<Boolean> enable();
514556

515557
/**
516558
* Indicates whether to log asynchronously

core/runtime/src/main/java/io/quarkus/runtime/logging/LoggingSetupRecorder.java

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ public void accept(String loggerName, CleanupFilterConfig config) {
185185
ArrayList<Handler> handlers = new ArrayList<>(
186186
3 + additionalHandlers.size() + (config.handlers().isPresent() ? config.handlers().get().size() : 0));
187187

188-
if (config.console().enable()) {
188+
if (config.console().enable().orElse(config.console().enabled())) {
189189
Handler consoleHandler = configureConsoleHandler(config.console(), consoleRuntimeConfig.getValue(), errorManager,
190190
cleanupFiler,
191191
namedFilters, possibleConsoleFormatters, possibleBannerSupplier, launchMode, includeFilters);
@@ -211,20 +211,20 @@ public void close() throws SecurityException {
211211
});
212212
}
213213

214-
if (config.file().enable()) {
214+
if (config.file().enable().orElse(config.file().enabled())) {
215215
handlers.add(configureFileHandler(config.file(), errorManager, cleanupFiler, namedFilters, possibleFileFormatters,
216216
includeFilters));
217217
}
218218

219-
if (config.syslog().enable()) {
219+
if (config.syslog().enable().orElse(config.syslog().enabled())) {
220220
Handler syslogHandler = configureSyslogHandler(config.syslog(), errorManager, cleanupFiler, namedFilters,
221221
possibleSyslogFormatters, includeFilters);
222222
if (syslogHandler != null) {
223223
handlers.add(syslogHandler);
224224
}
225225
}
226226

227-
if (config.socket().enable()) {
227+
if (config.socket().enable().orElse(config.socket().enabled())) {
228228
final Handler socketHandler = configureSocketHandler(config.socket(), errorManager, cleanupFiler,
229229
namedFilters, possibleSocketFormatters, includeFilters);
230230
if (socketHandler != null) {
@@ -342,7 +342,7 @@ public static void initializeBuildTimeLogging(
342342
LogCleanupFilter logCleanupFilter = new LogCleanupFilter(filterElements, dummy);
343343

344344
ArrayList<Handler> handlers = new ArrayList<>(3);
345-
if (config.console().enable()) {
345+
if (config.console().enable().orElse(config.console().enabled())) {
346346
Handler consoleHandler = configureConsoleHandler(config.console(), consoleConfig, errorManager, logCleanupFilter,
347347
emptyMap(), emptyList(), new RuntimeValue<>(Optional.empty()), launchMode, false);
348348
errorManager = consoleHandler.getErrorManager();
@@ -417,7 +417,7 @@ private static Map<String, Handler> createNamedHandlers(
417417
Map<String, Handler> namedHandlers = new HashMap<>();
418418
for (Entry<String, ConsoleConfig> consoleConfigEntry : config.consoleHandlers().entrySet()) {
419419
ConsoleConfig namedConsoleConfig = consoleConfigEntry.getValue();
420-
if (!namedConsoleConfig.enable()) {
420+
if (!namedConsoleConfig.enable().orElse(namedConsoleConfig.enabled())) {
421421
continue;
422422
}
423423
final Handler consoleHandler = configureConsoleHandler(namedConsoleConfig, consoleRuntimeConfig,
@@ -427,7 +427,7 @@ private static Map<String, Handler> createNamedHandlers(
427427
}
428428
for (Entry<String, FileConfig> fileConfigEntry : config.fileHandlers().entrySet()) {
429429
FileConfig namedFileConfig = fileConfigEntry.getValue();
430-
if (!namedFileConfig.enable()) {
430+
if (!namedFileConfig.enable().orElse(namedFileConfig.enabled())) {
431431
continue;
432432
}
433433
final Handler fileHandler = configureFileHandler(namedFileConfig, errorManager, cleanupFilter, namedFilters,
@@ -436,7 +436,7 @@ private static Map<String, Handler> createNamedHandlers(
436436
}
437437
for (Entry<String, LogRuntimeConfig.SyslogConfig> sysLogConfigEntry : config.syslogHandlers().entrySet()) {
438438
LogRuntimeConfig.SyslogConfig namedSyslogConfig = sysLogConfigEntry.getValue();
439-
if (!namedSyslogConfig.enable()) {
439+
if (!namedSyslogConfig.enable().orElse(namedSyslogConfig.enabled())) {
440440
continue;
441441
}
442442
final Handler syslogHandler = configureSyslogHandler(namedSyslogConfig, errorManager, cleanupFilter,
@@ -447,7 +447,7 @@ private static Map<String, Handler> createNamedHandlers(
447447
}
448448
for (Entry<String, SocketConfig> socketConfigEntry : config.socketHandlers().entrySet()) {
449449
SocketConfig namedSocketConfig = socketConfigEntry.getValue();
450-
if (!namedSocketConfig.enable()) {
450+
if (!namedSocketConfig.enable().orElse(namedSocketConfig.enabled())) {
451451
continue;
452452
}
453453
final Handler socketHandler = configureSocketHandler(namedSocketConfig, errorManager, cleanupFilter,
@@ -621,11 +621,13 @@ private static Handler configureConsoleHandler(
621621
consoleHandler.setErrorManager(defaultErrorManager);
622622
applyFilter(includeFilters, defaultErrorManager, cleanupFilter, config.filter(), namedFilters, consoleHandler);
623623

624-
Handler handler = config.async().legacyEnable().orElse(config.async().enable())
624+
boolean asyncEnabled = config.async().legacyEnable().orElse(config.async().enable().orElse(config.async().enabled()));
625+
626+
Handler handler = asyncEnabled
625627
? createAsyncHandler(config.async(), config.level(), consoleHandler)
626628
: consoleHandler;
627629

628-
if (color && launchMode.isDevOrTest() && !config.async().enable()) {
630+
if (color && launchMode.isDevOrTest() && !asyncEnabled) {
629631
final Handler delegate = handler;
630632
handler = new ExtHandler() {
631633
@Override
@@ -717,7 +719,7 @@ private static Handler configureFileHandler(final FileConfig config, final Error
717719
handler.getErrorManager().error("Multiple file formatters were activated", null, ErrorManager.GENERIC_FAILURE);
718720
}
719721

720-
if (config.async().legacyEnable().orElse(config.async().enable())) {
722+
if (config.async().legacyEnable().orElse(config.async().enable().orElse(config.async().enabled()))) {
721723
return createAsyncHandler(config.async(), config.level(), handler);
722724
}
723725
return handler;
@@ -804,7 +806,7 @@ private static Handler configureSyslogHandler(final LogRuntimeConfig.SyslogConfi
804806
ErrorManager.GENERIC_FAILURE);
805807
}
806808

807-
if (config.async().legacyEnable().orElse(config.async().enable())) {
809+
if (config.async().legacyEnable().orElse(config.async().enable().orElse(config.async().enabled()))) {
808810
return createAsyncHandler(config.async(), config.level(), handler);
809811
}
810812
return handler;
@@ -851,7 +853,7 @@ private static Handler configureSocketHandler(final LogRuntimeConfig.SocketConfi
851853
ErrorManager.GENERIC_FAILURE);
852854
}
853855

854-
if (config.async().legacyEnable().orElse(config.async().enable())) {
856+
if (config.async().legacyEnable().orElse(config.async().enable().orElse(config.async().enabled()))) {
855857
return createAsyncHandler(config.async(), config.level(), handler);
856858
}
857859
return handler;

extensions/elytron-security-properties-file/deployment/src/test/resources/application-form-auth.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Logging
22
#quarkus.log.level=DEBUG
3-
#quarkus.log.console.enable=true
3+
#quarkus.log.console.enabled=true
44
#quarkus.log.console.level=DEBUG
5-
#quarkus.log.file.enable=true
5+
#quarkus.log.file.enabled=true
66
#quarkus.log.file.path=/tmp/trace.log
77
#quarkus.log.file.level=TRACE
88
#quarkus.log.file.format=%d{HH:mm:ss} %-5p [%c{2.}]] (%t) %s%e%n

extensions/elytron-security-properties-file/deployment/src/test/resources/application.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ quarkus.security.users.file.roles=test-roles.properties
44
quarkus.security.users.file.plain-text=true
55

66
#quarkus.log.level=DEBUG
7-
#quarkus.log.console.enable=true
7+
#quarkus.log.console.enabled=true
88
#quarkus.log.console.level=DEBUG
9-
#quarkus.log.file.enable=true
9+
#quarkus.log.file.enabled=true
1010
# Send output to a trace.log file under the /tmp directory
1111
#quarkus.log.file.path=/tmp/trace.log
1212
#quarkus.log.file.level=TRACE

extensions/keycloak-authorization/deployment/src/main/java/io/quarkus/keycloak/pep/deployment/KeycloakPolicyEnforcerBuildStep.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public static class IsEnabled implements BooleanSupplier {
4949
KeycloakPolicyEnforcerBuildTimeConfig config;
5050

5151
public boolean getAsBoolean() {
52-
return config.policyEnforcer().enable();
52+
return config.policyEnforcer().enable().orElse(config.policyEnforcer().enabled());
5353
}
5454
}
5555
}

extensions/keycloak-authorization/runtime/src/main/java/io/quarkus/keycloak/pep/runtime/KeycloakPolicyEnforcerBuildTimeConfig.java

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package io.quarkus.keycloak.pep.runtime;
22

3+
import java.util.Optional;
4+
35
import io.quarkus.runtime.annotations.ConfigGroup;
46
import io.quarkus.runtime.annotations.ConfigRoot;
57
import io.smallrye.config.ConfigMapping;
@@ -24,6 +26,14 @@ interface KeycloakPolicyEnforcerEnableStatus {
2426
* Enables policy enforcement.
2527
*/
2628
@WithDefault("false")
27-
boolean enable();
29+
boolean enabled();
30+
31+
/**
32+
* Enables policy enforcement.
33+
*
34+
* @deprecated use {@code quarkus.keycloak.policy-enforcer.enabled} instead
35+
*/
36+
@Deprecated(since = "3.26", forRemoval = true)
37+
Optional<Boolean> enable();
2838
}
2939
}

extensions/logging-json/deployment/src/test/resources/application-console-json-formatter-custom.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
quarkus.log.level=INFO
2-
quarkus.log.console.enable=true
2+
quarkus.log.console.enabled=true
33
quarkus.log.console.level=WARNING
44
quarkus.log.console.json.enabled=true
55
quarkus.log.console.json.pretty-print=true
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
quarkus.log.level=INFO
2-
quarkus.log.console.enable=true
2+
quarkus.log.console.enabled=true
33
quarkus.log.console.level=WARNING
44
quarkus.log.console.format=%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n
55
quarkus.log.console.json.enabled=true

0 commit comments

Comments
 (0)