adding back java8 compatibility

Author: janheise

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        java-version: ["17", "11", "8"]
+        java-version: ["21", "17", "11", "8"]
 
     steps:
       - uses: "actions/checkout@v3"

pom.xml

@@ -73,8 +73,8 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <maven.compiler.source>21</maven.compiler.source>
-        <maven.compiler.target>21</maven.compiler.target>
+        <maven.compiler.source>1.8</maven.compiler.source>
+        <maven.compiler.target>1.8</maven.compiler.target>
         <maven.site.deploy.skip>true</maven.site.deploy.skip>
         <slf4j.version>2.0.17</slf4j.version>
         <jakarta.annotation-api.version>3.0.0</jakarta.annotation-api.version>
@@ -325,15 +325,6 @@
                 <groupId>org.eluder.coveralls</groupId>
                 <artifactId>coveralls-maven-plugin</artifactId>
             </plugin>
-            <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-compiler-plugin</artifactId>
-                <configuration>
-                    <source>21</source>
-                    <target>21</target>
-                    <compilerArgs>--enable-preview</compilerArgs>
-                </configuration>
-            </plugin>
         </plugins>
     </build>
 

src/main/java/com/github/joschi/jadconfig/documentation/ConfigurationDocsGenerator.java

@@ -46,11 +46,13 @@ public void generateDocumentation(DocumentationFormat format, Supplier<List<Obje
     private DocsPrinter createWriter(DocumentationFormat format) throws IOException {
         final FileWriter fileWriter = new FileWriter(format.outputFile(), StandardCharsets.UTF_8);
         // TODO: if the format list expands, introduce DI and factories for printers
-        return switch (format.format()) {
-            case "csv" -> new CsvDocsPrinter(fileWriter);
-            case "conf" -> new ConfigFileDocsPrinter(fileWriter);
-            default -> throw new IllegalArgumentException("Unsupported format " + format.format());
-        };
+        if ("csv".equals(format.format())) {
+            return new CsvDocsPrinter(fileWriter);
+        } else if("conf".equals(format.format())) {
+            return new ConfigFileDocsPrinter(fileWriter);
+        } else {
+            throw new IllegalArgumentException("Unsupported format " + format.format());
+        }
     }
 
     /**

src/main/java/com/github/joschi/jadconfig/documentation/ConfigurationEntry.java

@@ -2,24 +2,62 @@
 
 import jakarta.annotation.Nullable;
 
-/**
- * @param configurationBean Class that defines this configuration entry
- * @param fieldName java field name
- * @param type Java type name, e.g. String or Integer.
- * @param configName configuration property name, as written in the config file
- * @param defaultValue default value declared in the java field, null if not defined
- * @param required if the configuration property is mandatory (needs default or entry in the config file)
- * @param documentation textual documentation of this configuration propery
- */
-public record ConfigurationEntry(
-        Class<?> configurationBean,
-        String fieldName,
-        String type,
-        String configName,
-        @Nullable Object defaultValue,
-        boolean required,
-        String documentation
-) {
+public class ConfigurationEntry {
+    private final Class<?> configurationBean;
+    private final String fieldName;
+    private final String type;
+    private final String configName;
+    private final @Nullable Object defaultValue;
+    private final boolean required;
+    private final String documentation;
+
+    /**
+     * @param configurationBean Class that defines this configuration entry
+     * @param fieldName java field name
+     * @param type Java type name, e.g. String or Integer.
+     * @param configName configuration property name, as written in the config file
+     * @param defaultValue default value declared in the java field, null if not defined
+     * @param required if the configuration property is mandatory (needs default or entry in the config file)
+     * @param documentation textual documentation of this configuration propery
+     */
+    public ConfigurationEntry(Class<?> configurationBean, String fieldName, String type, String configName, @Nullable Object defaultValue, boolean required, String documentation) {
+        this.configurationBean = configurationBean;
+        this.fieldName = fieldName;
+        this.type = type;
+        this.configName = configName;
+        this.defaultValue = defaultValue;
+        this.required = required;
+        this.documentation = documentation;
+    }
+
+    public Class<?> configurationBean() {
+        return configurationBean;
+    }
+
+    public String fieldName() {
+        return fieldName;
+    }
+
+    public String type() {
+        return type;
+    }
+
+    public String configName() {
+        return configName;
+    }
+
+    @Nullable
+    public Object defaultValue() {
+        return defaultValue;
+    }
+
+    public boolean required() {
+        return required;
+    }
+
+    public String documentation() {
+        return documentation;
+    }
 
     public boolean hasPriority() {
         return required && defaultValue == null;

src/main/java/com/github/joschi/jadconfig/documentation/ConfigurationEntryWithSection.java

@@ -1,6 +1,28 @@
 package com.github.joschi.jadconfig.documentation;
 
-public record ConfigurationEntryWithSection(ConfigurationEntry entry, String sectionHeading, String sectionDescription) {
+public class ConfigurationEntryWithSection {
+    private final ConfigurationEntry entry;
+    private final String sectionHeading;
+    private final String sectionDescription;
+
+    public ConfigurationEntryWithSection(ConfigurationEntry entry, String sectionHeading, String sectionDescription) {
+        this.entry = entry;
+        this.sectionHeading = sectionHeading;
+        this.sectionDescription = sectionDescription;
+    }
+
+    public ConfigurationEntry entry() {
+        return entry;
+    }
+
+    public String sectionHeading() {
+        return sectionHeading;
+    }
+
+    public String sectionDescription() {
+        return sectionDescription;
+    }
+
     public boolean hasSection() {
         return sectionHeading != null && !sectionHeading.isBlank();
     }

src/main/java/com/github/joschi/jadconfig/documentation/DocumentationFormat.java

@@ -1,4 +1,19 @@
 package com.github.joschi.jadconfig.documentation;
 
-public record DocumentationFormat(String format, String outputFile) {
+public class DocumentationFormat {
+    private final String format;
+    private final String outputFile;
+
+    public DocumentationFormat(String format, String outputFile) {
+        this.format = format;
+        this.outputFile = outputFile;
+    }
+
+    public String format() {
+        return format;
+    }
+
+    public String outputFile() {
+        return outputFile;
+    }
 }

src/main/java/com/github/joschi/jadconfig/documentation/printers/ConfigFileDocsPrinter.java

@@ -65,11 +65,9 @@ private Optional<String> heading(String heading, int level) {
 
     private static String headingTemplate(int level) {
         if(level == 1) {
-            return """
-                    #####################################
-                    # %s
-                    #####################################
-                    """;
+            return "#####################################\n" +
+                    "# %s\n" +
+                    "#####################################\n";
         } else {
             return "#### %s\n";
         }
@@ -80,11 +78,8 @@ private String fieldToString(ConfigurationEntry field) {
         final boolean forceFillIn = field.required() && field.defaultValue() == null;
 
 
-        String template = """
-                %s
-                %s%s = %s
-
-                """;
+        String template = "%s\n" +
+                "%s%s = %s\n\n";
 
         return String.format(Locale.ROOT, template, formatDocumentation(field), forceFillIn ? "" : "#", field.configName(), wrapValue(field.defaultValue()));
     }

src/main/java/com/github/joschi/jadconfig/documentation/printers/ConfigurationSection.java

@@ -4,7 +4,35 @@
 
 import java.util.List;
 
-public record ConfigurationSection(String heading, String description, List<ConfigurationSection> sections, List<ConfigurationEntry> entries) {
+public class ConfigurationSection {
+    private final String heading;
+    private final String description;
+    private final List<ConfigurationSection> sections;
+    private final List<ConfigurationEntry> entries;
+
+    public ConfigurationSection(String heading, String description, List<ConfigurationSection> sections, List<ConfigurationEntry> entries) {
+        this.heading = heading;
+        this.description = description;
+        this.sections = sections;
+        this.entries = entries;
+    }
+
+    public String heading() {
+        return heading;
+    }
+
+    public String description() {
+        return description;
+    }
+
+    public List<ConfigurationSection> sections() {
+        return sections;
+    }
+
+    public List<ConfigurationEntry> entries() {
+        return entries;
+    }
+
     public boolean hasPriority() {
         return entries.stream().anyMatch(ConfigurationEntry::hasPriority);
     }

src/test/java/com/github/joschi/jadconfig/documentation/GenerateConfigDocumentationTest.java

@@ -88,20 +88,16 @@ private static class DummyConfiguration {
         @Parameter(value = "timeout_sec", validators = PositiveIntegerValidator.class)
         private Integer timeoutSec;
 
-        @Documentation("""
-            You MUST set a secret to secure/pepper the stored user passwords here. Use at least 64 characters.
-            Generate one by using for example: pwgen -N 1 -s 96
-            ATTENTION: This value must be the same on all Graylog and Datanode nodes in the cluster.
-            Changing this value after installation will render all user sessions and encrypted values
-            in the database invalid. (e.g. encrypted access tokens)
-            """)
+        @Documentation("You MUST set a secret to secure/pepper the stored user passwords here. Use at least 64 characters.\n" +
+            "Generate one by using for example: pwgen -N 1 -s 96\n" +
+            "ATTENTION: This value must be the same on all Graylog and Datanode nodes in the cluster.\n" +
+            "Changing this value after installation will render all user sessions and encrypted values\n" +
+            "in the database invalid. (e.g. encrypted access tokens)")
         @Parameter(value = "password_secret", required = true, validators = StringNotBlankValidator.class)
         private String passwordSecret;
 
         @DocumentationSection(heading = "OpenSearch JWT token usage", description = "Communication between Graylog and OpenSearch is secured by JWT.")
-        @Documentation("""
-            This configuration defines interval between token regenerations.
-            """)
+        @Documentation("This configuration defines interval between token regenerations.")
         @Parameter(value = "indexer_jwt_auth_token_caching_duration")
         Duration indexerJwtAuthTokenCachingDuration = Duration.seconds(60);
     }

src/test/java/com/github/joschi/jadconfig/validators/FilePathWritableValidatorTest.java

@@ -30,7 +30,7 @@ public void setUp() {
 
     @Test
     public void testExistingFile(@TempDir Path temp) throws ValidationException, IOException {
-        var tempFile = Files.createFile(temp.resolve("test0.txt"));
+        final Path tempFile = Files.createFile(temp.resolve("test0.txt"));
         validator.validate("Test", tempFile);
     }