Deal with xml dateTime

Author: leonardehrenfried

bindings.xjb

@@ -7,8 +7,8 @@
 
   <jxb:bindings>
     <jxb:globalBindings underscoreBinding="asCharInWord">
-      <xjc:javaType name="java.time.LocalDateTime" xmlType="xs:dateTime" adapter="org.rutebanken.util.LocalDateTimeISO8601XmlAdapter" />
-      <xjc:javaType name="java.time.ZonedDateTime" xmlType="xs:dateTime" adapter="org.rutebanken.util.ZonedDateTimeISO8601XmlAdapter" />
+      <xjc:javaType name="org.rutebanken.time.XmlDateTime" xmlType="xs:dateTime" adapter="org.rutebanken.util.XmlDateTimeAdapter" />
+      <!--<xjc:javaType name="java.time.ZonedDateTime" xmlType="xs:dateTime" adapter="org.rutebanken.util.ZonedDateTimeISO8601XmlAdapter" />-->
       <xjc:javaType name="java.time.LocalTime" xmlType="xs:time" adapter="org.rutebanken.util.LocalTimeISO8601XmlAdapter" />
       <xjc:javaType name="java.time.LocalDateTime" xmlType="xs:date" adapter="org.rutebanken.util.LocalDateXmlAdapter" />
       <xjc:javaType name="java.time.Duration" xmlType="xs:duration" adapter="org.rutebanken.util.DurationXmlAdapter" />

pom.xml

@@ -74,7 +74,7 @@
 
         <!-- Unit test frameworks versions -->
         <assertj.core.version>3.22.0</assertj.core.version>
-        <junit.version>5.8.2</junit.version>
+        <junit.version>5.11.1</junit.version>
 
         <!-- Maven plugin versions  -->
         <nexus-staging-maven-plugin.version>1.6.13</nexus-staging-maven-plugin.version>
@@ -163,6 +163,12 @@
             <version>${junit.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter</artifactId>
+            <version>5.11.1</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>
@@ -175,6 +181,7 @@
             <version>${slf4j.version}</version>
             <scope>test</scope>
         </dependency>
+
     </dependencies>
 
     <build>

src/main/java/org/rutebanken/time/XmlDateTime.java

@@ -0,0 +1,52 @@
+package org.rutebanken.time;
+
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
+import java.util.Objects;
+
+/**
+ * A wrapper type to represent the fact that xml xml dateTime can both include local and zoned
+ * date times.
+ */
+public class XmlDateTime {
+
+  private ZonedDateTime zonedDateTime;
+  private LocalDateTime localDateTime;
+
+  public XmlDateTime(ZonedDateTime zonedDateTime) {
+    this.zonedDateTime = Objects.requireNonNull(zonedDateTime);
+  }
+
+  public XmlDateTime(LocalDateTime localDateTime) {
+    this.localDateTime = Objects.requireNonNull(localDateTime);
+  }
+
+  public ZonedDateTime atZone(ZoneId zoneId) {
+    return zonedDateTime != null ? zonedDateTime.withZoneSameInstant(zoneId) : localDateTime.atZone(zoneId);
+  }
+
+  /**
+   * Returns true if the date time included a zone id (time zone).
+   */
+  public boolean isZoned() {
+    return zonedDateTime != null;
+  }
+
+  /**
+   * Returns true if the date time did no include a zone id (time zone).
+   */
+  public boolean isLocal() {
+    return localDateTime != null;
+  }
+
+  @Override
+  public String toString() {
+    if(zonedDateTime != null) {
+      return zonedDateTime.toString();
+    }
+    else {
+      return localDateTime.toString();
+    }
+  }
+}

src/main/java/org/rutebanken/util/XmlDateTimeAdapter.java

@@ -0,0 +1,65 @@
+/*
+ * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by
+ * the European Commission - subsequent versions of the EUPL (the "Licence");
+ * You may not use this work except in compliance with the Licence.
+ * You may obtain a copy of the Licence at:
+ *
+ *   https://joinup.ec.europa.eu/software/page/eupl
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the Licence is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the Licence for the specific language governing permissions and
+ * limitations under the Licence.
+ */
+
+package org.rutebanken.util;
+
+import jakarta.xml.bind.annotation.adapters.XmlAdapter;
+import java.time.LocalDateTime;
+import java.time.ZoneId;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.time.format.DateTimeFormatterBuilder;
+import java.time.temporal.ChronoField;
+import org.rutebanken.time.XmlDateTime;
+
+public class XmlDateTimeAdapter extends XmlAdapter<String, XmlDateTime> {
+
+	public static final DateTimeFormatter formatter = new DateTimeFormatterBuilder()
+		.parseCaseInsensitive()
+		.parseLenient()
+		.append(DateTimeFormatter.ISO_LOCAL_DATE_TIME)
+		.optionalStart()
+		.parseStrict()
+		.appendOffset("+HH:MM:ss", "Z")
+		.parseLenient()
+		.optionalEnd()
+		.optionalStart()
+		.appendOffset("+HHmmss", "Z")
+		.optionalEnd()
+		.toFormatter();
+
+	@Override
+	public XmlDateTime unmarshal(String inputDate) {
+		var temporal = formatter.parse(inputDate);
+		if(temporal.isSupported(ChronoField.OFFSET_SECONDS)) {
+			var zdt = ZonedDateTime.from(temporal);
+			return new XmlDateTime(zdt);
+		}
+		else {
+			var ldt = LocalDateTime.from(temporal);
+			return new XmlDateTime(ldt);
+		}
+	}
+
+	@Override
+	public String marshal(XmlDateTime inputDate) {
+		if(inputDate != null) {
+			return formatter.format(inputDate.atZone(ZoneId.of("UTC")));
+		} else {
+			return null;
+		}
+	}
+
+}

src/test/java/org/rutebanken/util/XmlDateTimeAdapterTest.java

@@ -0,0 +1,38 @@
+package org.rutebanken.util;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+
+class XmlDateTimeAdapterTest {
+
+  @ParameterizedTest
+  @ValueSource(strings = {
+    "2025-02-13T17:30:15+02:00",
+    "2025-02-13T17:30:15+0200",
+    "2025-02-13T17:30:15Z",
+    "2025-02-13T17:30:15.010+02:00",
+    "2025-02-13T17:30:15.0+02:00",
+    "2025-02-13T17:30:15.100+02:00",
+    "2025-02-13T17:30:15.099+02:00",
+    "2025-02-13T17:30:15.99+02:00",
+  })
+  void withZone(String input){
+    var adapter = new XmlDateTimeAdapter();
+    var time = adapter.unmarshal(input);
+    assertTrue(time.isZoned());
+  }
+
+  @ParameterizedTest
+  @ValueSource(strings = {
+    "2025-02-13T17:30:15",
+    "2025-02-13T17:30:15.10",
+    "2025-02-13T17:30:15.999",
+  })
+  void withoutZone(String input){
+    var adapter = new XmlDateTimeAdapter();
+    var xmlDate = adapter.unmarshal(input);
+    assertTrue(xmlDate.isLocal());
+  }
+}