All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.vertx.db2client.impl.drda.DRDAConstants Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (C) 2019,2020 IBM Corporation
 *
 * 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 io.vertx.db2client.impl.drda;

import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeFormatterBuilder;
import java.time.temporal.ChronoField;

public class DRDAConstants {
    // Value to use when padding non-character data in ddm objects.
    public static final byte NON_CHAR_DDM_DATA_PAD_BYTE = 0x00;

    // Maximum size of External Name.
    public static final int EXTNAM_MAXSIZE = 255;

    // Minimum agent level required by protocol.
    public static final int MIN_AGENT_MGRLVL = 3;

    // Minimum communications tcpip manager level required by protocol.
    public static final int MIN_CMNTCPIP_MGRLVL = 5;

    // Minimum LU6.2 Conversational Communications Manager
    public static final int MIN_CMNAPPC_MGRLVL = 3;

    // Minimum rdb manager level required by protocol.
    public static final int MIN_RDB_MGRLVL = 3;

    // Minimum secmgr manager level required by protocol.
    public static final int MIN_SECMGR_MGRLVL = 5;

    // Minimum sqlam manager level required by protocol.
    public static final int MIN_SQLAM_MGRLVL = 4;

    // Minimum xa manager level required by protocol.
    public static final int MIN_XAMGR_MGRLVL = 7;

    // Minimum secmgr manager level required by protocol.
    public static final int MIN_SYNCPTMGR_MGRLVL = 5;

    // Minimum sqlam manager level required by protocol.
    public static final int MIN_RSYNCMGR_MGRLVL = 5;

    // Minimum unicodemgr manager level required by protocol
    public static final int MIN_UNICODE_MGRLVL = 0;

    // Maximun Password size.
    public static final int PASSWORD_MAXSIZE = 255;

    // Fixed PRDDTA application id fixed length.
    public static final int PRDDTA_APPL_ID_FIXED_LEN = 20;

    // PRDDTA Accounting Suffix Length byte offset.
    public static final int PRDDTA_ACCT_SUFFIX_LEN_BYTE = 55;

    // PRDDTA Length byte offset.
    public static final int PRDDTA_LEN_BYTE = 0;

    // Maximum PRDDTA size.
    public static final int PRDDTA_MAXSIZE = 255;

    // PRDDTA platform id.
    public static final String PRDDTA_PLATFORM_ID = "JVM               ";

    // Fixed PRDDTA user id fixed length.
    public static final int PRDDTA_USER_ID_FIXED_LEN = 8;

    // Identifier Length for fixed length rdb name
    public static final int PKG_IDENTIFIER_FIXED_LEN = 18;

    // Maximum RDBNAM Identifier Length
    public static final int RDBNAM_MAX_LEN = 1024;

    // Maximum RDB Identifier Length
    public static final int PKG_IDENTIFIER_MAX_LEN = 255;

    // Fixed pkgcnstkn length
    public static final int PKGCNSTKN_FIXED_LEN = 8;

    // Maximum length of a security token.
    // Anything greater than 32763 bytes of SECTKN would require extended length DDMs.
    // This seems like an impossible upper bound limit right now so set
    // max to 32763 and cross bridge later.
    public static final int SECTKN_MAXSIZE = 32763;

    // Server class name of the ClientDNC product.
    public static final String SRVCLSNM_JVM = "QDB2/JVM";

    // Maximum size of SRVNAM Name.
    public static final int SRVNAM_MAXSIZE = 255;

    // Manager is NA or not usued.
    public static final int MGRLVL_NA = 0;

    // Manager Level 5 constant.
    public static final int MGRLVL_5 = 0x05;

    // Manager Level 7 constant.
    public static final int MGRLVL_7 = 0x07;

    // @AGG added for default targetSqlam
    public static final int TARGET_SQL_AM = 0x07; // 0x0B;

    // Indicates userid/encrypted password security mechanism.
    public static final int SECMEC_EUSRIDPWD = 0x09;

    // Indicates userid only security mechanism.
    public static final int SECMEC_USRIDONL = 0x04;

    // Indicates userid/encrypted password security mechanism.
    public static final int SECMEC_USRENCPWD = 0x07;

    // Indicates userid/password security mechanism.
    public static final int SECMEC_USRIDPWD = 0x03;

    // Indicates Encrypted userid and Encrypted Security-sensitive Data security
    // mechanism
    public static final int SECMEC_EUSRIDDTA = 0x0C;

    // Indicates Encrypted userid,Encrypted password and Encrypted
    // Security-sensitive Data security mechanism
    public static final int SECMEC_EUSRPWDDTA = 0x0D;

    // Indicates userid with strong password substitute security mechanism.
    public static final int SECMEC_USRSSBPWD = 0x08;

    // IEEE ASCII constant.
    public static final String SYSTEM_ASC = "QTDSQLASC";

    // Maximum size of User Name.
    public static final int USRID_MAXSIZE = 255;

    // Maximum size of a DDM block
    public static final int DATA_STREAM_STRUCTURE_MAX_LENGTH = 32767;

    ///////////////////////
    //
    // DRDA Type constants.
    //
    ///////////////////////

    public  static final int DRDA_TYPE_INTEGER = 0x02;
    public  static final int DRDA_TYPE_NINTEGER = 0x03;
    public  static final int DRDA_TYPE_SMALL = 0x04;
    public  static final int DRDA_TYPE_NSMALL = 0x05;
    public  static final int DRDA_TYPE_1BYTE_INT = 0x06;
    public  static final int DRDA_TYPE_N1BYTE_INT = 0x07;
    public  static final int DRDA_TYPE_FLOAT16 = 0x08;
    public  static final int DRDA_TYPE_NFLOAT16 = 0x09;
    public  static final int DRDA_TYPE_FLOAT8 = 0x0A;
    public  static final int DRDA_TYPE_NFLOAT8 = 0x0B;
    public  static final int DRDA_TYPE_FLOAT4 = 0x0C;
    public  static final int DRDA_TYPE_NFLOAT4 = 0x0D;
    public  static final int DRDA_TYPE_DECIMAL = 0x0E;
    public  static final int DRDA_TYPE_NDECIMAL = 0x0F;
    public  static final int DRDA_TYPE_ZDECIMAL = 0x10;
    public  static final int DRDA_TYPE_NZDECIMAL = 0x11;
    public  static final int DRDA_TYPE_NUMERIC_CHAR = 0x12;
    public  static final int DRDA_TYPE_NNUMERIC_CHAR = 0x13;
    public  static final int DRDA_TYPE_RSET_LOC = 0x14;
    public  static final int DRDA_TYPE_NRSET_LOC = 0x15;
    public  static final int DRDA_TYPE_INTEGER8 = 0x16;
    public  static final int DRDA_TYPE_NINTEGER8 = 0x17;
    public  static final int DRDA_TYPE_LOBLOC = 0x18;
    public  static final int DRDA_TYPE_NLOBLOC = 0x19;
    public  static final int DRDA_TYPE_CLOBLOC = 0x1A;
    public  static final int DRDA_TYPE_NCLOBLOC = 0x1B;
    public  static final int DRDA_TYPE_DBCSCLOBLOC = 0x1C;
    public  static final int DRDA_TYPE_NDBCSCLOBLOC = 0x1D;
    public  static final int DRDA_TYPE_ROWID = 0x1E;
    public  static final int DRDA_TYPE_NROWID = 0x1F;
    public  static final int DRDA_TYPE_DATE = 0x20;
    public  static final int DRDA_TYPE_NDATE = 0x21;
    public  static final int DRDA_TYPE_TIME = 0x22;
    public  static final int DRDA_TYPE_NTIME = 0x23;
    public  static final int DRDA_TYPE_TIMESTAMP = 0x24;
    public  static final int DRDA_TYPE_NTIMESTAMP = 0x25;
    public  static final int DRDA_TYPE_FIXBYTE = 0x26;
    public  static final int DRDA_TYPE_NFIXBYTE = 0x27;
    public  static final int DRDA_TYPE_VARBYTE = 0x28;
    public  static final int DRDA_TYPE_NVARBYTE = 0x29;
    public  static final int DRDA_TYPE_LONGVARBYTE = 0x2A;
    public  static final int DRDA_TYPE_NLONGVARBYTE = 0x2B;
    public  static final int DRDA_TYPE_NTERMBYTE = 0x2C;
    public  static final int DRDA_TYPE_NNTERMBYTE = 0x2D;
    public  static final int DRDA_TYPE_CSTR = 0x2E;
    public  static final int DRDA_TYPE_NCSTR = 0x2F;
    public  static final int DRDA_TYPE_CHAR = 0x30;
    public  static final int DRDA_TYPE_NCHAR = 0x31;
    public  static final int DRDA_TYPE_VARCHAR = 0x32;
    public  static final int DRDA_TYPE_NVARCHAR = 0x33;
    public  static final int DRDA_TYPE_LONG = 0x34;
    public  static final int DRDA_TYPE_NLONG = 0x35;
    public  static final int DRDA_TYPE_GRAPHIC = 0x36;
    public  static final int DRDA_TYPE_NGRAPHIC = 0x37;
    public  static final int DRDA_TYPE_VARGRAPH = 0x38;
    public  static final int DRDA_TYPE_NVARGRAPH = 0x39;
    public  static final int DRDA_TYPE_LONGRAPH = 0x3A;
    public  static final int DRDA_TYPE_NLONGRAPH = 0x3B;
    public  static final int DRDA_TYPE_MIX = 0x3C;
    public  static final int DRDA_TYPE_NMIX = 0x3D;
    public  static final int DRDA_TYPE_VARMIX = 0x3E;
    public  static final int DRDA_TYPE_NVARMIX = 0x3F;
    public  static final int DRDA_TYPE_LONGMIX = 0x40;
    public  static final int DRDA_TYPE_NLONGMIX = 0x41;
    public  static final int DRDA_TYPE_CSTRMIX = 0x42;
    public  static final int DRDA_TYPE_NCSTRMIX = 0x43;
    public  static final int DRDA_TYPE_PSCLBYTE = 0x44;
    public  static final int DRDA_TYPE_NPSCLBYTE = 0x45;
    public  static final int DRDA_TYPE_LSTR = 0x46;
    public  static final int DRDA_TYPE_NLSTR = 0x47;
    public  static final int DRDA_TYPE_LSTRMIX = 0x48;
    public  static final int DRDA_TYPE_NLSTRMIX = 0x49;
    public  static final int DRDA_TYPE_SDATALINK = 0x4C;
    public  static final int DRDA_TYPE_NSDATALINK = 0x4D;
    public  static final int DRDA_TYPE_MDATALINK = 0x4E;
    public  static final int DRDA_TYPE_NMDATALINK = 0x4F;

    // --- Override LIDs 0x50 - 0xAF

    // this type is shown in the DRDA spec, volume 1, in the
    // section on SQLUDTGRP
    public  static final int DRDA_TYPE_UDT = 0x50;
    public  static final int DRDA_TYPE_NUDT = 0x51;

    public  static final int DRDA_TYPE_LOBBYTES = 0xC8;
    public  static final int DRDA_TYPE_NLOBBYTES = 0xC9;
    public  static final int DRDA_TYPE_LOBCSBCS = 0xCA;
    public  static final int DRDA_TYPE_NLOBCSBCS = 0xCB;
    public  static final int DRDA_TYPE_LOBCDBCS = 0xCC;
    public  static final int DRDA_TYPE_NLOBCDBCS = 0xCD;
    public  static final int DRDA_TYPE_LOBCMIXED = 0xCE;
    public  static final int DRDA_TYPE_NLOBCMIXED = 0xCF;

    public  static final int DRDA_TYPE_BOOLEAN = 0xBE;
    public  static final int DRDA_TYPE_NBOOLEAN = 0xBF;

    // This is the maximum size which a udt can serialize to in order to
    // be transported across DRDA
    public static final int MAX_DRDA_UDT_SIZE = DATA_STREAM_STRUCTURE_MAX_LENGTH;

    ///////////////////////
    //
    // DB2 datatypes
    //
    ///////////////////////

    public  static final  int DB2_SQLTYPE_DATE = 384;        // DATE
    public  static final  int DB2_SQLTYPE_NDATE = 385;
    public  static final  int DB2_SQLTYPE_TIME = 388;        // TIME
    public  static final  int DB2_SQLTYPE_NTIME = 389;
    public  static final  int DB2_SQLTYPE_TIMESTAMP = 392;   // TIMESTAMP
    public  static final  int DB2_SQLTYPE_NTIMESTAMP = 393;
    public  static final  int DB2_SQLTYPE_DATALINK = 396;    // DATALINK
    public  static final  int DB2_SQLTYPE_NDATALINK = 397;

    public  static final  int DB2_SQLTYPE_BLOB = 404;        // BLOB
    public  static final  int DB2_SQLTYPE_NBLOB = 405;
    public  static final  int DB2_SQLTYPE_CLOB = 408;        // CLOB
    public  static final  int DB2_SQLTYPE_NCLOB = 409;
    public  static final  int DB2_SQLTYPE_DBCLOB = 412;      // DBCLOB
    public  static final  int DB2_SQLTYPE_NDBCLOB = 413;

    public  static final  int DB2_SQLTYPE_VARCHAR = 448;     // VARCHAR(i) - varying length string
    public  static final  int DB2_SQLTYPE_NVARCHAR = 449;
    public  static final  int DB2_SQLTYPE_CHAR = 452;        // CHAR(i) - fixed length
    public  static final  int DB2_SQLTYPE_NCHAR = 453;
    public  static final  int DB2_SQLTYPE_LONG = 456;        // LONG VARCHAR - varying length string
    public  static final  int DB2_SQLTYPE_NLONG = 457;
    public  static final  int DB2_SQLTYPE_CSTR = 460;        // SBCS - null terminated
    public  static final  int DB2_SQLTYPE_NCSTR = 461;
    public  static final  int DB2_SQLTYPE_VARGRAPH = 464;    // VARGRAPHIC(i) - varying length
                                                  // graphic string (2 byte length)
    public  static final  int DB2_SQLTYPE_NVARGRAPH = 465;
    public  static final  int DB2_SQLTYPE_GRAPHIC = 468;     // GRAPHIC(i) - fixed length graphic string                                                             */
    public  static final  int DB2_SQLTYPE_NGRAPHIC = 469;
    public  static final  int DB2_SQLTYPE_LONGRAPH = 472;    // LONG VARGRAPHIC(i) - varying length graphic string                                              */
    public  static final  int DB2_SQLTYPE_NLONGRAPH = 473;
    public  static final  int DB2_SQLTYPE_LSTR = 476;        // varying length string for Pascal (1-byte length)                                                     */
    public  static final  int DB2_SQLTYPE_NLSTR = 477;

    public  static final  int DB2_SQLTYPE_FLOAT = 480;       // FLOAT - 4 or 8 byte floating point
    public  static final  int DB2_SQLTYPE_NFLOAT = 481;
    public  static final  int DB2_SQLTYPE_DECIMAL = 484;     // DECIMAL (m,n)
    public  static final  int DB2_SQLTYPE_NDECIMAL = 485;
    public  static final  int DB2_SQLTYPE_ZONED = 488;       // Zoned Decimal -> DECIMAL(m,n)
    public  static final  int DB2_SQLTYPE_NZONED = 489;

    public  static final  int DB2_SQLTYPE_BIGINT = 492;      // BIGINT - 8-byte signed integer
    public  static final  int DB2_SQLTYPE_NBIGINT = 493;
    public  static final  int DB2_SQLTYPE_INTEGER = 496;     // INTEGER
    public  static final  int DB2_SQLTYPE_NINTEGER = 497;
    public  static final  int DB2_SQLTYPE_SMALL = 500;       // SMALLINT - 2-byte signed integer                                                                    */
    public  static final  int DB2_SQLTYPE_NSMALL = 501;

    public  static final  int DB2_SQLTYPE_NUMERIC = 504;     // NUMERIC -> DECIMAL (m,n)
    public  static final  int DB2_SQLTYPE_NNUMERIC = 505;

    public  static final  int DB2_SQLTYPE_ROWID = 904;           // ROWID
    public  static final  int DB2_SQLTYPE_NROWID = 905;
    public  static final  int DB2_SQLTYPE_BLOB_LOCATOR = 960;    // BLOB locator
    public  static final  int DB2_SQLTYPE_NBLOB_LOCATOR = 961;
    public  static final  int DB2_SQLTYPE_CLOB_LOCATOR = 964;    // CLOB locator
    public  static final  int DB2_SQLTYPE_NCLOB_LOCATOR = 965;
    public  static final  int DB2_SQLTYPE_DBCLOB_LOCATOR = 968;  // DBCLOB locator
    public  static final  int DB2_SQLTYPE_NDBCLOB_LOCATOR = 969;

    public  static final  int DB2_SQLTYPE_BOOLEAN = 2436;     // BOOLEAN
    public  static final  int DB2_SQLTYPE_NBOOLEAN = 2437;

    // there is no DB2 type for UDTs. we invent one
    public   static final int DB2_SQLTYPE_FAKE_UDT = 2000;
    public   static final int DB2_SQLTYPE_FAKE_NUDT = 2001;

    // DB2 and DRDA support timestamps with microseconds precision, but not
    // nanoseconds precision: yyyy-mm-dd-hh.mm.ss.ffffff
    // In contrast, JDBC supports full nanoseconds precision: yyyy-mm-dd-hh.mm.ss.fffffffff
    public   static final int DRDA_OLD_TIMESTAMP_LENGTH = 26;
    public   static final int DRDA_TIMESTAMP_LENGTH = 26;
    public   static final int JDBC_TIMESTAMP_LENGTH = 26;

    // Values for the EXTDTA stream status byte.
    // The use of this status byte is a product specific extension. The same
    // goes for the values below, they are not described by DRDA (nor DDM).

    /** Constant indicating a valid stream transfer. */
    public static final byte STREAM_OK = 0x7F;
    /**
     * Constant indicating that the client encountered an error when reading
     * the user stream.
     */
    public static final byte STREAM_READ_ERROR = 0x01;
    /** Constant indicating that the user stream was too short. */
    public static final byte STREAM_TOO_SHORT = 0x02;
    /** Constant indicating that the user stream was too long. */
    public static final byte STREAM_TOO_LONG = 0x04;

    // Product id
    public static final String PRDID = "JNT00001";
    public static final String EXTNAM = "db2jnt_application  " + PRDID + "300";

    static final DateTimeFormatter DB2_DATE_FORMAT = DateTimeFormatter.ofPattern("yyyy'-'MM'-'dd");
    static final DateTimeFormatter DB2_TIME_FORMAT = DateTimeFormatter.ofPattern("HH'.'mm'.'ss");
  static final DateTimeFormatter DB2_TIMESTAMP_FORMAT = new DateTimeFormatterBuilder()
      .append(DateTimeFormatter.ofPattern("yyyy'-'MM'-'dd'-'HH'.'mm'.'ss"))
      .appendFraction(ChronoField.NANO_OF_SECOND, 6, 9, true)
      .toFormatter();

    //
    // // The server release level of this product.
    // // It will be prefixed with PRDID
    // static final String SRVRLSLV;

    private DRDAConstants() {
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy