Merge pull request #665 from aguibert/db-metadata

Initial database metadata API

Author: aguibert

vertx-db2-client/src/main/java/io/vertx/db2client/impl/DB2DatabaseMetadata.java

@@ -0,0 +1,58 @@
+package io.vertx.db2client.impl;
+
+import java.util.Objects;
+
+import io.vertx.sqlclient.spi.DatabaseMetadata;
+
+public class DB2DatabaseMetadata implements DatabaseMetadata {
+
+  private final boolean isZOS;
+  private final String productName;
+  private final String fullVersion;
+  private final int majorVersion;
+  private final int minorVersion;
+
+  public DB2DatabaseMetadata(String serverReleaseLevel) {
+    Objects.requireNonNull(serverReleaseLevel, "No server release level (SRVRLSLV) returned by server");
+    fullVersion = serverReleaseLevel;
+    if (serverReleaseLevel.startsWith("SQL")) {
+      isZOS = false;
+      productName = "DB2 for Linux/Unix/Windows";
+    } else if (serverReleaseLevel.startsWith("DSN")) {
+      isZOS = true;
+      productName = "DB2 for z/OS";
+    } else {
+      throw new IllegalArgumentException("Received unknown server product release level: " + serverReleaseLevel);
+    }
+    if (serverReleaseLevel.length() < 7) {
+      throw new IllegalArgumentException("Unable to determine server major/minor version from release level: " + serverReleaseLevel);
+    }
+    majorVersion = Integer.parseInt(serverReleaseLevel.substring(3, 5));
+    minorVersion = Integer.parseInt(serverReleaseLevel.substring(5, 7));
+  }
+
+  public boolean isZOS() {
+    return isZOS;
+  }
+
+  @Override
+  public String productName() {
+    return productName;
+  }
+  
+  @Override
+  public String fullVersion() {
+    return fullVersion;
+  }
+
+  @Override
+  public int majorVersion() {
+    return majorVersion;
+  }
+
+  @Override
+  public int minorVersion() {
+    return minorVersion;
+  }
+
+}

vertx-db2-client/src/main/java/io/vertx/db2client/impl/DB2SocketConnection.java

@@ -25,6 +25,7 @@
 import io.vertx.core.net.impl.NetSocketInternal;
 import io.vertx.db2client.impl.codec.DB2Codec;
 import io.vertx.db2client.impl.command.InitialHandshakeCommand;
+import io.vertx.db2client.impl.drda.ConnectionMetaData;
 import io.vertx.sqlclient.impl.Connection;
 import io.vertx.sqlclient.impl.QueryResultHandler;
 import io.vertx.sqlclient.impl.SocketConnectionBase;
@@ -33,11 +34,13 @@
 import io.vertx.sqlclient.impl.command.QueryCommandBase;
 import io.vertx.sqlclient.impl.command.SimpleQueryCommand;
 import io.vertx.sqlclient.impl.command.TxCommand;
+import io.vertx.sqlclient.spi.DatabaseMetadata;
 
 public class DB2SocketConnection extends SocketConnectionBase {
 
   private DB2Codec codec;
   private Handler<Void> closeHandler;
+  public final ConnectionMetaData connMetadata = new ConnectionMetaData();
 
   public DB2SocketConnection(NetSocketInternal socket, 
       boolean cachePreparedStatements, 
@@ -90,6 +93,11 @@ public void handleClose(Throwable t) {
     super.handleClose(t);
     context().runOnContext(closeHandler);
   }
+  
+  @Override
+  public DatabaseMetadata getDatabaseMetaData() {
+    return connMetadata.dbMetadata;
+  }
 
   public DB2SocketConnection closeHandler(Handler<Void> handler) {
     closeHandler = handler;

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/CloseConnectionCommandCodec.java

@@ -30,15 +30,15 @@ class CloseConnectionCommandCodec extends CommandCodec<Void, CloseConnectionComm
   void encode(DB2Encoder encoder) {
     super.encode(encoder);
     ByteBuf packet = allocateBuffer();
-    DRDAQueryRequest closeCursor = new DRDAQueryRequest(packet, encoder.connMetadata);
+    DRDAQueryRequest closeCursor = new DRDAQueryRequest(packet, encoder.socketConnection.connMetadata);
     closeCursor.buildRDBCMM();
     closeCursor.completeCommand();
     sendNonSplitPacket(packet);
   }
 
   @Override
   void decodePayload(ByteBuf payload, int payloadLength) {
-    DRDAQueryResponse closeCursor = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse closeCursor = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     closeCursor.readLocalCommit();
     encoder.chctx.channel().close();
   }

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/CloseCursorCommandCodec.java

@@ -42,15 +42,15 @@ void encode(DB2Encoder encoder) {
     statement.closeQuery(query);
 
     ByteBuf packet = allocateBuffer();
-    DRDAQueryRequest closeCursor = new DRDAQueryRequest(packet, encoder.connMetadata);
-    closeCursor.buildCLSQRY(statement.section, encoder.connMetadata.databaseName, query.queryInstanceId);
+    DRDAQueryRequest closeCursor = new DRDAQueryRequest(packet, encoder.socketConnection.connMetadata);
+    closeCursor.buildCLSQRY(statement.section, encoder.socketConnection.connMetadata.databaseName, query.queryInstanceId);
     closeCursor.completeCommand();
     sendNonSplitPacket(packet);
   }
 
   @Override
   void decodePayload(ByteBuf payload, int payloadLength) {
-    DRDAQueryResponse closeCursor = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse closeCursor = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     closeCursor.readCursorClose();
     completionHandler.handle(CommandResponse.success(null));
   }

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/DB2Encoder.java

@@ -25,7 +25,6 @@
 import io.vertx.db2client.impl.DB2SocketConnection;
 import io.vertx.db2client.impl.command.InitialHandshakeCommand;
 import io.vertx.db2client.impl.command.PingCommand;
-import io.vertx.db2client.impl.drda.ConnectionMetaData;
 import io.vertx.sqlclient.impl.command.CloseConnectionCommand;
 import io.vertx.sqlclient.impl.command.CloseCursorCommand;
 import io.vertx.sqlclient.impl.command.CloseStatementCommand;
@@ -40,11 +39,10 @@ class DB2Encoder extends ChannelOutboundHandlerAdapter {
 
   private static final Logger LOG = LoggerFactory.getLogger(DB2Encoder.class);
 
-  public final ConnectionMetaData connMetadata = new ConnectionMetaData();
   private final ArrayDeque<CommandCodec<?, ?>> inflight;
   ChannelHandlerContext chctx;
 
-  DB2SocketConnection socketConnection;
+  final DB2SocketConnection socketConnection;
 
   DB2Encoder(ArrayDeque<CommandCodec<?, ?>> inflight, DB2SocketConnection db2SocketConnection) {
     this.inflight = inflight;

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/ExtendedBatchQueryCommandCodec.java

@@ -77,7 +77,7 @@ void encodeUpdate(DRDAQueryRequest req) {
 
   void decodeQuery(ByteBuf payload) {
     boolean hasMoreResults = true;
-    DRDAQueryResponse resp = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse resp = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     for (int i = 0; i < params.size(); i++) {
       if (LOG.isDebugEnabled())
         LOG.debug("Decode query " + i);
@@ -91,7 +91,7 @@ void decodeQuery(ByteBuf payload) {
   }
 
   void decodeUpdate(ByteBuf payload) {
-    DRDAQueryResponse updateResponse = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse updateResponse = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     for (int i = 0; i < params.size(); i++) {
       handleUpdateResult(updateResponse);
     }

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/ExtendedQueryCommandBaseCodec.java

@@ -50,10 +50,10 @@ void encodePreparedQuery(DRDAQueryRequest queryRequest, QueryInstance queryInsta
 
     Object[] inputs = sanitize(params);
     if (queryInstance.cursor == null) {
-      queryRequest.writeOpenQuery(statement.section, encoder.connMetadata.databaseName, cmd.fetch(),
+      queryRequest.writeOpenQuery(statement.section, encoder.socketConnection.connMetadata.databaseName, cmd.fetch(),
           ResultSet.TYPE_FORWARD_ONLY, statement.paramDesc.paramDefinitions(), inputs);
     } else {
-      queryRequest.writeFetch(statement.section, encoder.connMetadata.databaseName, cmd.fetch(),
+      queryRequest.writeFetch(statement.section, encoder.socketConnection.connMetadata.databaseName, cmd.fetch(),
           queryInstance.queryInstanceId);
     }
   }
@@ -62,7 +62,7 @@ void encodePreparedUpdate(DRDAQueryRequest queryRequest, Tuple params) {
     Object[] inputs = sanitize(params);
     boolean outputExpected = false; // TODO @AGG implement later, is true if result set metadata num columns > 0
     boolean chainAutoCommit = true;
-    queryRequest.writeExecute(statement.section, encoder.connMetadata.databaseName,
+    queryRequest.writeExecute(statement.section, encoder.socketConnection.connMetadata.databaseName,
         statement.paramDesc.paramDefinitions(), inputs, outputExpected, chainAutoCommit);
     // TODO: for auto generated keys we also need to flow a writeOpenQuery
   }

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/ExtendedQueryCommandCodec.java

@@ -45,15 +45,15 @@ void encodeUpdate(DRDAQueryRequest req) {
   }
 
   void decodeQuery(ByteBuf payload) {
-    DRDAQueryResponse resp = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse resp = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     RowResultDecoder<?, R> decoder = decodePreparedQuery(payload, resp, queryInstance);
     boolean hasMoreResults = !decoder.isQueryComplete();
     handleQueryResult(decoder);
     completionHandler.handle(CommandResponse.success(hasMoreResults));
   }
 
   void decodeUpdate(ByteBuf payload) {
-    DRDAQueryResponse updateResponse = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse updateResponse = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     handleUpdateResult(updateResponse);
     if (cmd.autoCommit()) {
       updateResponse.readLocalCommit();

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/InitialHandshakeCommandCodec.java

@@ -50,7 +50,7 @@ private static enum ConnectionState {
   @Override
   void encode(DB2Encoder encoder) {
     super.encode(encoder);
-    encoder.connMetadata.databaseName = cmd.database();
+    encoder.socketConnection.connMetadata.databaseName = cmd.database();
     encoder.socketConnection.closeHandler(h -> {
       if (status == ConnectionState.CONNECTING) {
         // Sometimes DB2 closes the connection when sending an invalid Database name.
@@ -64,7 +64,7 @@ void encode(DB2Encoder encoder) {
 
     ByteBuf packet = allocateBuffer();
     int packetStartIdx = packet.writerIndex();
-    DRDAConnectRequest connectRequest = new DRDAConnectRequest(packet, encoder.connMetadata);
+    DRDAConnectRequest connectRequest = new DRDAConnectRequest(packet, encoder.socketConnection.connMetadata);
     connectRequest.buildEXCSAT(DRDAConstants.EXTNAM, // externalName,
         0x0A, // targetAgent,
         DRDAConstants.TARGET_SQL_AM, // targetSqlam,
@@ -91,7 +91,7 @@ void encode(DB2Encoder encoder) {
 
   @Override
   void decodePayload(ByteBuf payload, int payloadLength) {
-    DRDAConnectResponse response = new DRDAConnectResponse(payload, encoder.connMetadata);
+    DRDAConnectResponse response = new DRDAConnectResponse(payload, encoder.socketConnection.connMetadata);
     response.readExchangeServerAttributes();
     // readAccessSecurity can throw a DB2Exception if there are problems connecting.
     // In that case, we want to catch that exception and

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/PrepareStatementCodec.java

@@ -56,9 +56,9 @@ private void sendStatementPrepareCommand() {
     ByteBuf packet = allocateBuffer();
     // encode packet header
     int packetStartIdx = packet.writerIndex();
-    DRDAQueryRequest prepareCommand = new DRDAQueryRequest(packet, encoder.connMetadata);
-    section = encoder.connMetadata.sectionManager.getSection(cmd.sql());
-    String dbName = encoder.connMetadata.databaseName;
+    DRDAQueryRequest prepareCommand = new DRDAQueryRequest(packet, encoder.socketConnection.connMetadata);
+    section = encoder.socketConnection.connMetadata.sectionManager.getSection(cmd.sql());
+    String dbName = encoder.socketConnection.connMetadata.databaseName;
     prepareCommand.writePrepareDescribeOutput(cmd.sql(), dbName, section);
     prepareCommand.writeDescribeInput(section, dbName);
     prepareCommand.completeCommand();
@@ -72,7 +72,7 @@ private void sendStatementPrepareCommand() {
   void decodePayload(ByteBuf payload, int payloadLength) {
     switch (commandHandlerState) {
     case INIT:
-      DRDAQueryResponse response = new DRDAQueryResponse(payload, encoder.connMetadata);
+      DRDAQueryResponse response = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
       response.readPrepareDescribeInputOutput();
       rowDesc = response.getOutputColumnMetaData();
       paramDesc = response.getInputColumnMetaData();

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/QueryCommandBaseCodec.java

@@ -48,7 +48,7 @@ void encode(DB2Encoder encoder) {
 
     ByteBuf packet = allocateBuffer();
     int packetStartIdx = packet.writerIndex();
-    DRDAQueryRequest req = new DRDAQueryRequest(packet, encoder.connMetadata);
+    DRDAQueryRequest req = new DRDAQueryRequest(packet, encoder.socketConnection.connMetadata);
     if (isQuery) {
       encodeQuery(req);
     } else {

vertx-db2-client/src/main/java/io/vertx/db2client/impl/codec/SimpleQueryCommandCodec.java

@@ -36,18 +36,18 @@ class SimpleQueryCommandCodec<T> extends QueryCommandBaseCodec<T, SimpleQueryCom
 
   @Override
   void encodeQuery(DRDAQueryRequest queryCommand) {
-    querySection = encoder.connMetadata.sectionManager.getSection(cmd.sql());
-    queryCommand.writePrepareDescribeOutput(cmd.sql(), encoder.connMetadata.databaseName, querySection);
+    querySection = encoder.socketConnection.connMetadata.sectionManager.getSection(cmd.sql());
+    queryCommand.writePrepareDescribeOutput(cmd.sql(), encoder.socketConnection.connMetadata.databaseName, querySection);
     // fetchSize=0 triggers default fetch size (64) to be used (TODO @AGG this
     // should be configurable)
     // @AGG hard coded to TYPE_FORWARD_ONLY
-    queryCommand.writeOpenQuery(querySection, encoder.connMetadata.databaseName, 0, ResultSet.TYPE_FORWARD_ONLY);
+    queryCommand.writeOpenQuery(querySection, encoder.socketConnection.connMetadata.databaseName, 0, ResultSet.TYPE_FORWARD_ONLY);
   }
 
   @Override
   void encodeUpdate(DRDAQueryRequest updateCommand) {
-    querySection = encoder.connMetadata.sectionManager.getSection(cmd.sql());
-    updateCommand.writeExecuteImmediate(cmd.sql(), querySection, encoder.connMetadata.databaseName);
+    querySection = encoder.socketConnection.connMetadata.sectionManager.getSection(cmd.sql());
+    updateCommand.writeExecuteImmediate(cmd.sql(), querySection, encoder.socketConnection.connMetadata.databaseName);
     if (cmd.autoCommit()) {
       updateCommand.buildRDBCMM();
     }
@@ -61,7 +61,7 @@ void encodeUpdate(DRDAQueryRequest updateCommand) {
   }
 
   void decodeUpdate(ByteBuf payload) {
-    DRDAQueryResponse updateResponse = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse updateResponse = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     querySection.release();
 
     int updatedCount = (int) updateResponse.readExecuteImmediate();
@@ -83,7 +83,7 @@ static <A, T> T emptyResult(Collector<Row, A, T> collector) {
   void decodeQuery(ByteBuf payload) {
     querySection.release();
 
-    DRDAQueryResponse resp = new DRDAQueryResponse(payload, encoder.connMetadata);
+    DRDAQueryResponse resp = new DRDAQueryResponse(payload, encoder.socketConnection.connMetadata);
     resp.readPrepareDescribeOutput();
     resp.readBeginOpenQuery();
     columnDefinitions = resp.getOutputColumnMetaData();

vertx-db2-client/src/main/java/io/vertx/db2client/impl/drda/ConnectionMetaData.java

@@ -17,28 +17,22 @@
 
 import java.nio.charset.Charset;
 
+import io.vertx.db2client.impl.DB2DatabaseMetadata;
+
 public class ConnectionMetaData {
 
   public String databaseName;
+  public DB2DatabaseMetadata dbMetadata;
   public final SectionManager sectionManager = new SectionManager();
 
-  private boolean isZos;
   private Charset currentCCSID = CCSIDConstants.EBCDIC;
 
-  public void setZos(boolean isZos) {
-    this.isZos = isZos;
-    if (isZos && currentCCSID != CCSIDConstants.UTF8) {
-      currentCCSID = CCSIDConstants.UTF8;
-      sectionManager.configureForZOS();
-    }
+  public Charset getCCSID() {
+    return currentCCSID;
   }
 
   public boolean isZos() {
-    return isZos;
-  }
-  
-  public Charset getCCSID() {
-    return currentCCSID;
+    return dbMetadata.isZOS();
   }
 
 }

vertx-db2-client/src/main/java/io/vertx/db2client/impl/drda/DRDAConnectRequest.java

@@ -76,10 +76,10 @@ public void buildACCRDB(String rdbnam,
 //            constructCrrtkn();
 //        }
 
-        if (!metadata.isZos()) {
-          Objects.requireNonNull(crrtkn);
-          buildCRRTKN(crrtkn);
-        }
+//        if (!metadata.isZos()) {
+//          Objects.requireNonNull(crrtkn);
+//          buildCRRTKN(crrtkn);
+//        }
 
         // This specifies the single-byte, double-byte
         // and mixed-byte CCSIDs of the Scalar Data Arrays (SDAs) in the identified
@@ -340,9 +340,9 @@ private void buildTYPDEFOVR(boolean sendCcsidSbc, int ccsidSbc, boolean sendCcsi
             writeScalar2Bytes(CodePoint.CCSIDMBC, ccsidMbc);
         }
 
-        if (metadata.isZos()) {
-          writeScalar2Bytes(CodePoint.CCSIDXML, ccsidMbc);
-        }
+//        if (metadata.isZos()) {
+//          writeScalar2Bytes(CodePoint.CCSIDXML, ccsidMbc);
+//        }
 
         updateLengthBytes();