Closing InputStream Too Early on setBinaryStream()

This section describes an error condition where executeUpdate() gives an exception if the InputStream is closed too early.

The program in the previous tutorial worked nicely. But if you make a mistake by placing the bodyIn.close() statement before ps.executeUpdate(), you will get an IOException when ps.executeUpdate() is called. The reason is simple, reading of binary data from the InputStream is done at the time of executeUpdate() call. Here is a test program:

/* SqlServerBlobSetBinaryStreamError.java
 * Copyright (c) HerongYang.com. All Rights Reserved.
 */
import java.io.*;
import java.sql.*;
public class SqlServerBlobSetBinaryStreamError {
  public static void main(String [] args) {
    Connection con = null;
    try {
      com.microsoft.sqlserver.jdbc.SQLServerDataSource ds
        = new com.microsoft.sqlserver.jdbc.SQLServerDataSource();
      ds.setServerName("localhost");
//      ds.setPortNumber(60782);
      ds.setInstanceName("SQLEXPRESS");
      ds.setDatabaseName("AdventureWorks2019");
      ds.setUser("Herong");
      ds.setPassword("T0pSecret");
      con = ds.getConnection();

// Deleting the record for re-testing
      String subject = "Test of setBinaryStream() method error";
      Statement sta = con.createStatement();
      sta.executeUpdate("DELETE FROM Image WHERE Subject = '"
        +subject+"'");

// Inserting CLOB value with PreparedStatement.setBinaryStream()
      PreparedStatement ps = con.prepareStatement(
        "INSERT INTO Image (Subject, Body) VALUES (?,?)");
      ps.setString(1, subject);
      InputStream bodyIn =
        new FileInputStream("SqlServerBlobSetBinaryStream.class");
      File fileIn = new File("SqlServerBlobSetBinaryStream.class");
      ps.setBinaryStream(2, bodyIn, (int) fileIn.length());

// Error - Closing the InputStream too early.
      bodyIn.close();

      int count = ps.executeUpdate();
      ps.close();

// Retrieving BLOB value with getBytes()
      sta = con.createStatement();
      ResultSet res = sta.executeQuery("SELECT * FROM Image"
        +" WHERE Subject = '"+subject+"'");
      res.next();
      System.out.println("The inserted record: ");
      System.out.println("   Subject = "+res.getString("Subject"));
      System.out.println("   Body = "
        +new String(res.getBytes("Body"),0,32));
      res.close();

      sta.close();
      con.close();
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

The IOException with newer JDK. The message tells me that the Reader is closed.

herong> java -cp .;mssql-jdbc-9.4.1.jre16.jar \
  SqlServerBlobSetBinaryStreamError

com.microsoft.sqlserver.jdbc.SQLServerException:
An error occurred while reading the value from the stream object.
Error: "java.io.IOException: Stream Closed"
  at com.microsoft.sqlserver.jdbc.TDSWriter.error(IOBuffer.java:3576)
  at com.microsoft.sqlserver.jdbc.TDSWriter.writeStream(IOBuffer.ja...
  at com.microsoft.sqlserver.jdbc.TDSWriter.writeRPCInputStream(IOB...
  at com.microsoft.sqlserver.jdbc.DTV$SendByRPCOp.execute(dtv.java:...
  at com.microsoft.sqlserver.jdbc.DTV.executeOp(dtv.java:1460)
  at com.microsoft.sqlserver.jdbc.DTV.sendByRPC(dtv.java:1503)
  ...

However, with JDK 1.6, the error message doesn't tell me that the Reader is closed.

herong> Progra~1\java\jdk1.6.0_02\bin\java \
   -cp .;sqljdbc.jar SqlServerBlobSetBinaryStreamError

Exception: java.io.IOException: Read error
com.microsoft.sqlserver.jdbc.SQLServerException:
  java.io.IOException: Read error
  at com.microsoft.sqlserver.jdbc.SQLServerException
    .makeFromDriverError(...)
  at com.microsoft.sqlserver.jdbc.IOBuffer
    .bufferAppendRPCInputStream(...)
  at com.microsoft.sqlserver.jdbc.DTV$SendByRPCOp.execute(...)
  at com.microsoft.sqlserver.jdbc.DTV.executeOp(Unknown Source)
  at com.microsoft.sqlserver.jdbc.DTV.sendByRPC(Unknown Source)
  at com.microsoft.sqlserver.jdbc.Parameter.sendByRPC(...)
  at com.microsoft.sqlserver.jdbc.SQLServerPreparedStatement
   .sendParamsByRPC(...)
  at com.microsoft.sqlserver.jdbc.SQLServerPreparedStatement
    .doPrepExec(...)
  at com.microsoft.sqlserver.jdbc.SQLServerPreparedStatement
    .executeUpdate(...)
  at SqlServerBlobSetBinaryStreamError.main(SqlServerBlob...java:40)

Table of Contents

 About This Book

 JDBC (Java Database Connectivity) Introduction

 JDK (Java SE) Installation

 Microsoft SQL Server Express Edition

 Microsoft JDBC Driver for SQL Server

 Microsoft JDBC Driver - Query Statements and Result Sets

 Microsoft JDBC Driver - DatabaseMetaData Object

 Microsoft JDBC Driver - DDL Statements

 Microsoft JDBC Driver - DML Statements

 SQL Server - PreparedStatement

 SQL Server CLOB (Character Large Object) - TEXT

SQL Server BLOB (Binary Large Object) - BLOB

 Overview of BLOB (Binary Large Object)

 Create Tables with CLOB Columns

 Inserting BLOB Values with SQL INSERT Statements

 Inserting BLOB Values with setBytes() Method

 Inserting BLOB Values with setBinaryStream() Method

Closing InputStream Too Early on setBinaryStream()

 Retrieving BLOB Values with getBytes() Method

 Retrieving BLOB Values with getBinaryStream() Method

 Retrieving BLOB Values with getBlob() Method

 Inserting BLOB Values with setBlob() Method

 Using Connection Pool with JDBC

 JDBC-ODBC Bridge Driver - sun.jdbc.odbc.JdbcOdbcDriver

 JDBC-ODBC Bridge Driver - Flat Text Files

 JDBC-ODBC Bridge Driver - MS Access

 JDBC-ODBC Bridge Driver - MS SQL Server

 Archived Tutorials

 References

 Full Version in PDF/EPUB