Fix #77: add codecs for timestamp, time and date types

Author: maximevw

Diff for: CHANGELOG.md

@@ -19,6 +19,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Use an extended implementation of `UdtValue`, including a string representation of the value, for UDT values returned
   by `CassandraResultSet.getObject(String|int)` methods (see issue 
   [#76](https://github.com/ing-bank/cassandra-jdbc-wrapper/issues/76)).
+- Add support for collections of `timestamp`, `date` and `time` values (see issue
+  [#77](https://github.com/ing-bank/cassandra-jdbc-wrapper/issues/77)) by adding specific codecs for 
+  `java.sql.Timestamp`, `java.sql.Date` and `java.sql.Time` types.
 
 ## [4.14.0] - 2024-12-24
 ### Added
@@ -336,6 +339,7 @@ For this version, the changelog lists the main changes comparatively to the late
 - Fix logs in `CassandraConnection` constructor.
 
 [original project]: https://github.com/adejanovski/cassandra-jdbc-wrapper/
+[4.15.0]: https://github.com/ing-bank/cassandra-jdbc-wrapper/compare/v4.14.0...v4.15.0
 [4.14.0]: https://github.com/ing-bank/cassandra-jdbc-wrapper/compare/v4.13.1...v4.14.0
 [4.13.1]: https://github.com/ing-bank/cassandra-jdbc-wrapper/compare/v4.13.0...v4.13.1
 [4.13.0]: https://github.com/ing-bank/cassandra-jdbc-wrapper/compare/v4.12.0...v4.13.0

Diff for: src/main/java/com/ing/data/cassandra/jdbc/CassandraConnection.java

@@ -22,17 +22,6 @@
 import com.datastax.oss.driver.api.core.config.DriverExecutionProfile;
 import com.datastax.oss.driver.api.core.metadata.Metadata;
 import com.datastax.oss.driver.api.core.session.Session;
-import com.datastax.oss.driver.api.core.type.codec.TypeCodec;
-import com.ing.data.cassandra.jdbc.codec.BigintToBigDecimalCodec;
-import com.ing.data.cassandra.jdbc.codec.DecimalToDoubleCodec;
-import com.ing.data.cassandra.jdbc.codec.FloatToDoubleCodec;
-import com.ing.data.cassandra.jdbc.codec.IntToLongCodec;
-import com.ing.data.cassandra.jdbc.codec.LongToIntCodec;
-import com.ing.data.cassandra.jdbc.codec.SmallintToIntCodec;
-import com.ing.data.cassandra.jdbc.codec.TimestampToLongCodec;
-import com.ing.data.cassandra.jdbc.codec.TinyintToIntCodec;
-import com.ing.data.cassandra.jdbc.codec.TinyintToShortCodec;
-import com.ing.data.cassandra.jdbc.codec.VarintToIntCodec;
 import com.ing.data.cassandra.jdbc.optionset.Default;
 import com.ing.data.cassandra.jdbc.optionset.OptionSet;
 import org.apache.commons.lang3.StringUtils;
@@ -48,9 +37,7 @@
 import java.sql.SQLTimeoutException;
 import java.sql.SQLWarning;
 import java.sql.Statement;
-import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Properties;
@@ -69,6 +56,7 @@
 import static com.ing.data.cassandra.jdbc.CassandraResultSet.DEFAULT_HOLDABILITY;
 import static com.ing.data.cassandra.jdbc.CassandraResultSet.DEFAULT_TYPE;
 import static com.ing.data.cassandra.jdbc.utils.AwsUtil.AWS_KEYSPACES_HOSTS_REGEX;
+import static com.ing.data.cassandra.jdbc.utils.DriverUtil.PRECONFIGURED_CODECS;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.safelyRegisterCodecs;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.toStringWithoutSensitiveValues;
 import static com.ing.data.cassandra.jdbc.utils.ErrorConstants.ALWAYS_AUTOCOMMIT;
@@ -245,18 +233,7 @@ public CassandraConnection(final Session cSession, final String currentKeyspace,
         this.serialConsistencyLevel = ConsistencyLevel.SERIAL;
         this.debugMode = debugMode;
         setActiveExecutionProfile(Objects.toString(defaultExecutionProfile, DriverExecutionProfile.DEFAULT_NAME));
-        final List<TypeCodec<?>> codecs = new ArrayList<>();
-        codecs.add(new TimestampToLongCodec());
-        codecs.add(new LongToIntCodec());
-        codecs.add(new IntToLongCodec());
-        codecs.add(new BigintToBigDecimalCodec());
-        codecs.add(new DecimalToDoubleCodec());
-        codecs.add(new FloatToDoubleCodec());
-        codecs.add(new VarintToIntCodec());
-        codecs.add(new SmallintToIntCodec());
-        codecs.add(new TinyintToIntCodec());
-        codecs.add(new TinyintToShortCodec());
-        safelyRegisterCodecs(cSession, codecs);
+        safelyRegisterCodecs(cSession, PRECONFIGURED_CODECS);
     }
 
     /**

Diff for: src/main/java/com/ing/data/cassandra/jdbc/SessionHolder.java

@@ -31,16 +31,6 @@
 import com.datastax.oss.driver.internal.core.loadbalancing.DefaultLoadBalancingPolicy;
 import com.datastax.oss.driver.internal.core.ssl.DefaultSslEngineFactory;
 import com.github.benmanes.caffeine.cache.LoadingCache;
-import com.ing.data.cassandra.jdbc.codec.BigintToBigDecimalCodec;
-import com.ing.data.cassandra.jdbc.codec.DecimalToDoubleCodec;
-import com.ing.data.cassandra.jdbc.codec.FloatToDoubleCodec;
-import com.ing.data.cassandra.jdbc.codec.IntToLongCodec;
-import com.ing.data.cassandra.jdbc.codec.LongToIntCodec;
-import com.ing.data.cassandra.jdbc.codec.SmallintToIntCodec;
-import com.ing.data.cassandra.jdbc.codec.TimestampToLongCodec;
-import com.ing.data.cassandra.jdbc.codec.TinyintToIntCodec;
-import com.ing.data.cassandra.jdbc.codec.TinyintToShortCodec;
-import com.ing.data.cassandra.jdbc.codec.VarintToIntCodec;
 import com.ing.data.cassandra.jdbc.utils.AwsUtil;
 import com.ing.data.cassandra.jdbc.utils.ContactPoint;
 import com.instaclustr.cassandra.driver.auth.KerberosAuthProviderBase;
@@ -69,6 +59,7 @@
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.JSSE_KEYSTORE_PROPERTY;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.JSSE_TRUSTSTORE_PASSWORD_PROPERTY;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.JSSE_TRUSTSTORE_PROPERTY;
+import static com.ing.data.cassandra.jdbc.utils.DriverUtil.PRECONFIGURED_CODECS;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.SINGLE_QUOTE;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.redactSensitiveValuesInJdbcUrl;
 import static com.ing.data.cassandra.jdbc.utils.DriverUtil.toStringWithoutSensitiveValues;
@@ -369,19 +360,8 @@ private Session createSession(final Properties properties) throws SQLException {
             builder.withAuthProvider(new SigV4AuthProvider(awsRegion));
         }
 
-        // Declare and register codecs.
-        final List<TypeCodec<?>> codecs = new ArrayList<>();
-        codecs.add(new TimestampToLongCodec());
-        codecs.add(new LongToIntCodec());
-        codecs.add(new IntToLongCodec());
-        codecs.add(new BigintToBigDecimalCodec());
-        codecs.add(new DecimalToDoubleCodec());
-        codecs.add(new FloatToDoubleCodec());
-        codecs.add(new VarintToIntCodec());
-        codecs.add(new SmallintToIntCodec());
-        codecs.add(new TinyintToIntCodec());
-        codecs.add(new TinyintToShortCodec());
-        builder.addTypeCodecs(codecs.toArray(new TypeCodec[]{}));
+        // Register codecs.
+        builder.addTypeCodecs(PRECONFIGURED_CODECS.toArray(new TypeCodec[]{}));
 
         builder.withKeyspace(keyspace);
         builder.withConfigLoader(driverConfigLoaderBuilder.build());

Diff for: src/main/java/com/ing/data/cassandra/jdbc/codec/SqlDateCodec.java

@@ -0,0 +1,100 @@
+/*
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+package com.ing.data.cassandra.jdbc.codec;
+
+import com.datastax.oss.driver.api.core.ProtocolVersion;
+import com.datastax.oss.driver.api.core.type.DataType;
+import com.datastax.oss.driver.api.core.type.DataTypes;
+import com.datastax.oss.driver.api.core.type.codec.TypeCodec;
+import com.datastax.oss.driver.api.core.type.reflect.GenericType;
+import com.datastax.oss.driver.internal.core.type.codec.DateCodec;
+import com.datastax.oss.driver.internal.core.util.Strings;
+import com.ing.data.cassandra.jdbc.utils.ByteBufferUtil;
+
+import javax.annotation.Nonnull;
+import java.nio.ByteBuffer;
+import java.sql.Date;
+import java.time.LocalDate;
+
+import static java.time.format.DateTimeFormatter.ISO_LOCAL_DATE;
+
+/**
+ * Manages the two-way conversion between the CQL type {@link DataTypes#DATE} and the Java type {@link java.sql.Date}.
+ *
+ * @implNote The CQL type {@code DATE} is stored as an unsigned 32-bit integer.
+ */
+public class SqlDateCodec extends AbstractCodec<Date> implements TypeCodec<Date> {
+
+    /**
+     * Constructor for {@code SqlDateCodec}.
+     */
+    public SqlDateCodec() {
+    }
+
+    @Nonnull
+    @Override
+    public GenericType<Date> getJavaType() {
+        return GenericType.of(Date.class);
+    }
+
+    @Nonnull
+    @Override
+    public DataType getCqlType() {
+        return DataTypes.DATE;
+    }
+
+    @Override
+    public ByteBuffer encode(final Date value, @Nonnull final ProtocolVersion protocolVersion) {
+        if (value == null) {
+            return null;
+        }
+        return ByteBufferUtil.bytes(signedToUnsigned((int) value.toLocalDate().toEpochDay()));
+    }
+
+    @Override
+    public Date decode(final ByteBuffer bytes, @Nonnull final ProtocolVersion protocolVersion) {
+        if (bytes == null) {
+            return null;
+        }
+        // always duplicate the ByteBuffer instance before consuming it!
+        final int readInt = ByteBufferUtil.toInt(bytes.duplicate());
+        return Date.valueOf(LocalDate.ofEpochDay(unsignedToSigned(readInt)));
+    }
+
+    @Override
+    Date parseNonNull(@Nonnull final String value) {
+        // Re-use the parser of the standard DateCodec to handle the formats supported by Cassandra.
+        final LocalDate parsedLocalDate = new DateCodec().parse(value);
+        if (parsedLocalDate == null) {
+            return null;
+        }
+        return Date.valueOf(parsedLocalDate);
+    }
+
+    @Override
+    String formatNonNull(@Nonnull final Date value) {
+        return Strings.quote(ISO_LOCAL_DATE.format(value.toLocalDate()));
+    }
+
+    static int signedToUnsigned(final int signed) {
+        return signed - Integer.MIN_VALUE;
+    }
+
+    static int unsignedToSigned(final int unsigned) {
+        return unsigned + Integer.MIN_VALUE;
+    }
+
+}

Diff for: src/main/java/com/ing/data/cassandra/jdbc/codec/SqlTimeCodec.java

@@ -0,0 +1,93 @@
+/*
+ *
+ *   Licensed under the Apache License, Version 2.0 (the "License");
+ *   you may not use this file except in compliance with the License.
+ *   You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *   Unless required by applicable law or agreed to in writing, software
+ *   distributed under the License is distributed on an "AS IS" BASIS,
+ *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *   See the License for the specific language governing permissions and
+ *   limitations under the License.
+ */
+
+package com.ing.data.cassandra.jdbc.codec;
+
+import com.datastax.oss.driver.api.core.ProtocolVersion;
+import com.datastax.oss.driver.api.core.type.DataType;
+import com.datastax.oss.driver.api.core.type.DataTypes;
+import com.datastax.oss.driver.api.core.type.codec.TypeCodec;
+import com.datastax.oss.driver.api.core.type.reflect.GenericType;
+import com.datastax.oss.driver.internal.core.type.codec.TimeCodec;
+import com.datastax.oss.driver.internal.core.util.Strings;
+import com.ing.data.cassandra.jdbc.utils.ByteBufferUtil;
+
+import javax.annotation.Nonnull;
+import java.nio.ByteBuffer;
+import java.sql.Time;
+import java.time.LocalTime;
+import java.time.format.DateTimeFormatter;
+
+/**
+ * Manages the two-way conversion between the CQL type {@link DataTypes#TIME} and the Java type {@link Time}.
+ */
+public class SqlTimeCodec extends AbstractCodec<Time> implements TypeCodec<Time> {
+
+    /**
+     * The default time format used by the method {@link #formatNonNull(Time)}.
+     */
+    public static final DateTimeFormatter DEFAULT_TIME_FORMAT = DateTimeFormatter.ofPattern("HH:mm:ss.SSSSSSSSS");
+
+    /**
+     * Constructor for {@code SqlTimeCodec}.
+     */
+    public SqlTimeCodec() {
+    }
+
+    @Nonnull
+    @Override
+    public GenericType<Time> getJavaType() {
+        return GenericType.of(Time.class);
+    }
+
+    @Nonnull
+    @Override
+    public DataType getCqlType() {
+        return DataTypes.TIME;
+    }
+
+    @Override
+    public ByteBuffer encode(final Time value, @Nonnull final ProtocolVersion protocolVersion) {
+        if (value == null) {
+            return null;
+        }
+        return ByteBufferUtil.bytes(value.toLocalTime().toNanoOfDay());
+    }
+
+    @Override
+    public Time decode(final ByteBuffer bytes, @Nonnull final ProtocolVersion protocolVersion) {
+        if (bytes == null) {
+            return null;
+        }
+        // always duplicate the ByteBuffer instance before consuming it!
+        return Time.valueOf(LocalTime.ofNanoOfDay(ByteBufferUtil.toLong(bytes.duplicate())));
+    }
+
+    @Override
+    Time parseNonNull(@Nonnull final String value) {
+        // Re-use the parser of the standard TimeCodec to handle the formats supported by Cassandra.
+        final LocalTime parsedLocalTime = new TimeCodec().parse(value);
+        if (parsedLocalTime == null) {
+            return null;
+        }
+        return Time.valueOf(parsedLocalTime);
+    }
+
+    @Override
+    String formatNonNull(@Nonnull final Time value) {
+        return Strings.quote(DEFAULT_TIME_FORMAT.format(value.toLocalTime()));
+    }
+
+}