Add nullability to FirebirdBlob and FBBlob* classes

Author: mrotteveel

src/main/org/firebirdsql/jaybird/props/PropertyConstants.java

@@ -36,7 +36,7 @@ public final class PropertyConstants {
     static final boolean DEFAULT_IGNORE_PROCEDURE_TYPE = false;
     static final boolean DEFAULT_WIRE_COMPRESSION = false;
     public static final int DEFAULT_BLOB_BUFFER_SIZE = 16384;
-    static final int MIN_BLOB_BUFFER_SIZE = 512;
+    public static final int MIN_BLOB_BUFFER_SIZE = 512;
     public static final int DEFAULT_PAGE_CACHE_SIZE = 0;
     static final boolean DEFAULT_USE_SERVER_BATCH = true;
     public static final int DEFAULT_SERVER_BATCH_BUFFER_SIZE = 0;

src/main/org/firebirdsql/jdbc/FBBlob.java

@@ -30,9 +30,12 @@
 import org.firebirdsql.gds.ng.listeners.TransactionListener;
 import org.firebirdsql.gds.ng.wire.InlineBlob;
 import org.firebirdsql.jaybird.props.DatabaseConnectionProperties;
+import org.firebirdsql.jaybird.props.PropertyConstants;
 import org.firebirdsql.jaybird.util.SQLExceptionChainBuilder;
+import org.firebirdsql.jdbc.FBObjectListener.BlobListener;
 import org.firebirdsql.util.InternalApi;
 import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 import java.io.*;
 import java.sql.Blob;
@@ -41,7 +44,6 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.Collections;
 import java.util.HashSet;
 
 import static java.util.Objects.requireNonNull;
@@ -62,22 +64,23 @@
  * </p>
  */
 @InternalApi
+@NullMarked
 public final class FBBlob implements FirebirdBlob, TransactionListener {
 
     private static final System.Logger logger = System.getLogger(FBBlob.class.getName());
 
     private boolean isNew;
     private long blobId;
     @SuppressWarnings("java:S3077")
-    private volatile GDSHelper gdsHelper;
-    private FBObjectListener.BlobListener blobListener;
+    private volatile @Nullable GDSHelper gdsHelper;
+    private BlobListener blobListener;
     private final Config config;
 
-    private final Collection<FBBlobInputStream> inputStreams = Collections.synchronizedSet(new HashSet<>());
-    private FBBlobOutputStream blobOut;
-    private InlineBlob cachedInlineBlob;
+    private final Collection<FBBlobInputStream> inputStreams = new HashSet<>();
+    private @Nullable FBBlobOutputStream blobOut;
+    private @Nullable InlineBlob cachedInlineBlob;
 
-    private FBBlob(GDSHelper c, boolean isNew, FBObjectListener.BlobListener blobListener, Config config) {
+    private FBBlob(GDSHelper c, boolean isNew, @Nullable BlobListener blobListener, Config config) {
         gdsHelper = c;
         this.isNew = isNew;
         this.blobListener = blobListener != null ? blobListener : FBObjectListener.NoActionBlobListener.instance();
@@ -95,7 +98,7 @@ private FBBlob(GDSHelper c, boolean isNew, FBObjectListener.BlobListener blobLis
      *         blob configuration (cannot be {@code null})
      * @since 5
      */
-    public FBBlob(GDSHelper c, FBObjectListener.BlobListener blobListener, Config config) {
+    public FBBlob(GDSHelper c, @Nullable BlobListener blobListener, Config config) {
         this(c, true, blobListener, config);
     }
 
@@ -112,7 +115,7 @@ public FBBlob(GDSHelper c, FBObjectListener.BlobListener blobListener, Config co
      *         blob configuration (cannot be {@code null})
      * @since 5
      */
-    public FBBlob(GDSHelper c, long blobId, FBObjectListener.BlobListener blobListener, Config config) {
+    public FBBlob(GDSHelper c, long blobId, @Nullable BlobListener blobListener, Config config) {
         this(c, false, blobListener, config);
         this.blobId = blobId;
     }
@@ -135,7 +138,7 @@ Config config() {
      */
     FbBlob openBlob() throws SQLException {
         try (var ignored = withLock()) {
-            checkClosed();
+            GDSHelper gdsHelper = requireOpenGDSHelper();
             if (isNew) {
                 throw new SQLException("No Blob ID is available in new Blob object",
                         SQLStateConstants.SQL_STATE_GENERAL_ERROR);
@@ -164,8 +167,8 @@ FbBlob openBlob() throws SQLException {
      * @since 5
      */
     FbBlob createBlob() throws SQLException {
-        try (LockCloseable ignored = withLock()) {
-            checkClosed();
+        try (var ignored = withLock()) {
+            GDSHelper gdsHelper = requireOpenGDSHelper();
             // For historic reasons we allow creating an output blob even if this is not a new blob. This may need to
             // be reconsidered in the future
             return gdsHelper.createBlob(config);
@@ -231,8 +234,8 @@ public InputStream getBinaryStream(long pos, long length) throws SQLException {
      *         if something went wrong
      */
     public byte[] getInfo(byte[] items, int bufferLength) throws SQLException {
-        try (LockCloseable ignored = withLock()) {
-            checkClosed();
+        try (var ignored = withLock()) {
+            GDSHelper gdsHelper = requireOpenGDSHelper();
             blobListener.executionStarted(this);
             // TODO Does it make sense to close blob here?
             try (FbBlob blob = gdsHelper.openBlob(blobId, config)) {
@@ -246,7 +249,7 @@ public byte[] getInfo(byte[] items, int bufferLength) throws SQLException {
     @Override
     public long length() throws SQLException {
         try (var ignored = withLock()) {
-            checkClosed();
+            checkOpen();
             blobListener.executionStarted(this);
             try (FbBlob blob = openBlob()) {
                 return blob.length();
@@ -269,7 +272,7 @@ public boolean isSegmented() throws SQLException {
     @Override
     public FBBlob detach() throws SQLException {
         try (var ignored = withLock()) {
-            checkClosed();
+            GDSHelper gdsHelper = requireOpenGDSHelper();
             var blobCopy = new FBBlob(gdsHelper, blobId, blobListener, config);
             if (cachedInlineBlob != null) {
                 blobCopy.cachedInlineBlob = cachedInlineBlob.copy();
@@ -343,8 +346,8 @@ public byte[] getBytes() throws SQLException {
 
     @Override
     public InputStream getBinaryStream() throws SQLException {
-        try (LockCloseable ignored = withLock()) {
-            checkClosed();
+        try (var ignored = withLock()) {
+            checkOpen();
             FBBlobInputStream blobstream = new FBBlobInputStream(this);
             inputStreams.add(blobstream);
             return blobstream;
@@ -384,8 +387,8 @@ public int setBytes(long pos, byte[] bytes, int offset, int len) throws SQLExcep
 
     @Override
     public OutputStream setBinaryStream(long pos) throws SQLException {
-        try (LockCloseable ignored = withLock()) {
-            checkClosed();
+        try (var ignored = withLock()) {
+            checkOpen();
             blobListener.executionStarted(this);
 
             if (blobOut != null) {
@@ -430,6 +433,7 @@ public long getBlobId() throws SQLException {
     void setBlobId(long blobId) {
         try (LockCloseable ignored = withLock()) {
             this.blobId = blobId;
+            GDSHelper gdsHelper = this.gdsHelper;
             if (isNew && gdsHelper != null) {
                 FbTransaction currentTransaction = gdsHelper.getCurrentTransaction();
                 if (currentTransaction != null) {
@@ -456,7 +460,7 @@ public void copyBytes(byte[] bytes, int pos, int len) throws SQLException {
      * @return The buffer length
      */
     int getBufferLength() {
-        return config.blobBufferSize();
+        return Math.max(PropertyConstants.MIN_BLOB_BUFFER_SIZE, config.blobBufferSize());
     }
 
     /**
@@ -466,7 +470,9 @@ int getBufferLength() {
      *         InputStream that has been closed.
      */
     void notifyClosed(FBBlobInputStream stream) {
-        inputStreams.remove(stream);
+        try (var ignored = withLock()) {
+            inputStreams.remove(stream);
+        }
     }
 
     /**
@@ -647,18 +653,36 @@ public void copyCharacterStream(Reader reader) throws SQLException {
     public void transactionStateChanged(FbTransaction transaction, TransactionState newState,
             TransactionState previousState) {
         if (newState == TransactionState.COMMITTED || newState == TransactionState.ROLLED_BACK) {
-            try (LockCloseable ignored = withLock()) {
+            try {
                 free();
             } catch (SQLException e) {
                 logger.log(System.Logger.Level.ERROR, "Error calling free on blob during transaction end", e);
             }
         }
     }
 
-    private void checkClosed() throws SQLException {
+    /**
+     * Checks if this blob is open.
+     * <p>
+     * If the method also requires use of the {@code GDSHelper} object, use {@link #requireOpenGDSHelper()} instead.
+     * </p>
+     *
+     * @throws SQLException
+     *         if this blob is currently not open (does not have a {@code GDSHelper}).
+     * @see #requireOpenGDSHelper()
+     */
+    private void checkOpen() throws SQLException {
+        if (gdsHelper == null) {
+            throw FbExceptionBuilder.toException(JaybirdErrorCodes.jb_blobClosed);
+        }
+    }
+
+    private GDSHelper requireOpenGDSHelper() throws SQLException {
+        GDSHelper gdsHelper = this.gdsHelper;
         if (gdsHelper == null) {
             throw FbExceptionBuilder.toException(JaybirdErrorCodes.jb_blobClosed);
         }
+        return gdsHelper;
     }
 
     /**