NetStatementRequest.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.derby.client.net |
 |
 |
Apache Derby |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| LINE_COMMENT | Number of line comments |  |
| SIZE | Size of the file in bytes | |
| EXEC_COMMENTS | Comments in executable code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| RETURNS | Number of return points from functions | |
| PARAMS | Number of formal parameter declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| ELOC | Effective lines of code | |
| LOC | Lines of code | |
| LINES | Number of lines in the source file | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| BLOCKS | Number of blocks | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| COMMENTS | Comment lines | |
| UNIQUE_OPERANDS | Number of unique operands | |
| EXITS | Procedure exits | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| COMPARISONS | Number of comparison operators | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0076 | JAVA0076 Use of magic number | |
| WHITESPACE | Number of whitespace lines | |
| FUNCTIONS | Number of function declarations | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0082 | JAVA0082 Unnecessary widening cast | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0173 | JAVA0173 Unused method parameter | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0171 | JAVA0171 Unused local variable | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0138 | JAVA0138 N parameters defined for method (maximum: M) | |
| NEST_DEPTH | Maximum nesting depth | |
| LOOPS | Number of loops | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0029 | JAVA0029 Private method not used | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
Derby - Class org.apache.derby.client.net.NetStatementRequest
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 org.apache.derby.client.net;
import org.apache.derby.iapi.reference.DRDAConstants;
import org.apache.derby.client.am.Lob;
import org.apache.derby.client.am.Blob;
import org.apache.derby.client.am.Clob;
import org.apache.derby.client.am.ColumnMetaData;
import org.apache.derby.client.am.ResultSet;
import org.apache.derby.client.am.Section;
import org.apache.derby.client.am.SqlException;
import org.apache.derby.client.am.Types;
import org.apache.derby.client.am.ClientMessageId;
import org.apache.derby.client.am.Utils;
import org.apache.derby.shared.common.reference.SQLState;
// For performance, should we worry about the ordering of our DDM command parameters
public class NetStatementRequest extends NetPackageRequest implements StatementRequestInterface {
java.util.ArrayList extdtaPositions_ = null; // Integers: build EXTDTA for column i
int overrideLid_ = FdocaConstants.FIRST_OVERRIDE_LID;
// promototed parameters hold parameters that are promotoed to a different
// data type because they are too large to represent in PROTOCOL otherwise.
// This currently only applies for promotion of (VAR)CHAR -> CLOB and (VAR)BINARY -> BLOB
// The key for this structure is the parameter index. Note that having this
// collection does not eliminate the need for extdtaPositions_ because that
// is still needed for non-promototed LOBs
java.util.HashMap promototedParameters_ = new java.util.HashMap();
NetStatementRequest(NetAgent netAgent, CcsidManager ccsidManager, int bufferSize) {
super(netAgent, ccsidManager, bufferSize);
}
//----------------------------- entry points ---------------------------------
// Write the message to perform an execute immediate.
// The SQL statement sent as command data cannot contain references
// to either input variables or output variables.
//
// preconditions:
public void writeExecuteImmediate(NetStatement materialStatement,
String sql,
Section section) throws SqlException {
buildEXCSQLIMM(section,
false, //sendQryinsid
0); //qryinsid
buildSQLSTTcommandData(sql); // statement follows in sqlstt command data object
}
// Write the message to preform a prepare into.
// Once the SQL statement has been prepared, it is executed until the unit of work, in
// which the PRPSQLSTT command was issued, ends. An exception to this is if
// Keep Dynamic is being used.
//
// preconditions:
public void writePrepareDescribeOutput(NetStatement materialStatement,
String sql,
Section section) throws SqlException {
buildPRPSQLSTT(section,
sql,
true, //sendRtnsqlda
true, //sendTypsqlda
CodePoint.TYPSQLDA_X_OUTPUT); //typsqlda
if (((NetStatement) materialStatement).statement_.cursorAttributesToSendOnPrepare_ != null) {
buildSQLATTRcommandData(((NetStatement) materialStatement).statement_.cursorAttributesToSendOnPrepare_);
}
buildSQLSTTcommandData(sql); // statement follows in sqlstt command data object
}
// Write the message to perform a reprepare.
//
// preconditions:
public void writePrepare(NetStatement materialStatement,
String sql,
Section section) throws SqlException {
buildPRPSQLSTT(section,
sql,
false, //sendRtnsqlda
false, //sendTypsqlda
0); //typsqlda
if (((NetStatement) materialStatement).statement_.cursorAttributesToSendOnPrepare_ != null) {
buildSQLATTRcommandData(((NetStatement) materialStatement).statement_.cursorAttributesToSendOnPrepare_);
}
buildSQLSTTcommandData(sql); // statement follows in sqlstt command data object
}
// Write the message to execute prepared sql statement.
//
// preconditions:
public void writeExecute(NetPreparedStatement materialPreparedStatement,
Section section,
ColumnMetaData parameterMetaData,
Object[] inputs,
int numInputColumns,
boolean outputExpected,
boolean chained) throws SqlException // chained flag for blobs only //dupqry
{
buildEXCSQLSTT(section,
true, // sendOutexp
outputExpected, // outexp
false, // sendPrcnam
null, // prcnam
false, // sendQryblksz
false, // sendMaxrslcnt,
0, // maxrslcnt,
false, // sendMaxblkext
0, // maxblkext
false, // sendRslsetflg
0, // resultSetFlag
false, // sendQryrowset
0); // qryrowset
if (numInputColumns > 0) {
if ((extdtaPositions_ != null) && (!extdtaPositions_.isEmpty())) {
extdtaPositions_.clear(); // reset extdta column position markers
}
boolean overrideExists = buildSQLDTAcommandData(numInputColumns,
parameterMetaData,
inputs);
// can we eleminate the chain argument needed for lobs
buildEXTDTA(parameterMetaData, inputs, chained);
}
}
// Write the message to open a bound or prepared query with input parameters.
// Check this -> For open query with input parameters
//
// preconditions:
public void writeOpenQuery(NetPreparedStatement materialPreparedStatement,
Section section,
int fetchSize,
int resultSetType,
int numInputColumns,
org.apache.derby.client.am.ColumnMetaData parameterMetaData,
Object[] inputs) throws SqlException {
boolean sendQryrowset = checkSendQryrowset(fetchSize, resultSetType);
fetchSize = checkFetchsize(fetchSize, resultSetType);
// think about if there is a way we can call build ddm just passing ddm parameters and not passing the material ps object
// maybe not, if sometimes we need to set the caches hanging off the ps object during the ddm build
// maybe we can extricate conditionals in the build ddm logic outside
buildOPNQRY(section,
sendQryrowset,
fetchSize);
// may be able to merge this with firstContinueQuery_ and push above conditional to common
((NetStatement) materialPreparedStatement).qryrowsetSentOnOpnqry_ = sendQryrowset;
if (numInputColumns > 0) {
if ((extdtaPositions_ != null) && (!extdtaPositions_.isEmpty())) {
extdtaPositions_.clear(); // reset extdta column position markers
}
// is this the best place for this
// EXCSQSTT needs this too
// think about having this method return a boolean to
// indicate the extdta should be built
boolean overrideExists = buildSQLDTAcommandData(numInputColumns,
parameterMetaData,
inputs);
// can we eleminate the chain argument needed for lobs
// do we chain after Extdta's on open, verify this
buildEXTDTA(parameterMetaData,
inputs,
false); //chained, do we chain after Extdta's on open
}
}
// Write the message to open a bound or prepared query without input parameters.
// Check this-> For open query without input parameters
public void writeOpenQuery(NetStatement materialStatement,
Section section,
int fetchSize,
int resultSetType) throws SqlException {
boolean sendQryrowset = checkSendQryrowset(fetchSize, resultSetType);
fetchSize = checkFetchsize(fetchSize, resultSetType);
// think about if there is a way we can call build ddm just passing ddm parameters and not passing the material ps object
// maybe not, if sometimes we need to set the caches hanging off the ps object during the ddm build
// maybe we can extricate conditionals in the build ddm logic outside
buildOPNQRY(section,
sendQryrowset,
fetchSize);
// may be able to merge this with firstContinueQuery_ and push above conditional to common
((NetStatement) materialStatement).qryrowsetSentOnOpnqry_ = sendQryrowset; // net-specific event
}
// Write the message to peform a describe input.
//
public void writeDescribeInput(NetPreparedStatement materialPreparedStatement,
Section section) throws SqlException {
int typsqlda = CodePoint.TYPSQLDA_X_INPUT;
buildDSCSQLSTT(section,
true, //sendTypsqlda
typsqlda);
}
// Write the message to peform a describe output.
//
// preconditions:
public void writeDescribeOutput(NetPreparedStatement materialPreparedStatement,
Section section) throws SqlException {
// pick standard, light, extended sqlda. possibly push this up even more
// right now use SQLAM level as determining factor and go for the most data.
// if standard is the only suported option, don't send the typsqlda
// and let server default to standard. This prevents accidentally sending
// a typsqlda to a downlevel server. typsqlda is only supported at sqlam 6.
//KATHEY CHECK
buildDSCSQLSTT(section,
true, //sendTypsqlda
CodePoint.TYPSQLDA_X_OUTPUT); //typsqlda
}
// Write the message to execute a stored procedure.
//
// preconditions:
public void writeExecuteCall(NetStatement materialStatement,
boolean outputExpected,
String procedureName,
Section section,
int fetchSize,
boolean suppressResultSets, // for batch updates == true
int resultSetType,
ColumnMetaData parameterMetaData,
Object[] inputs) throws SqlException // chain is for blobs
{
// always send QRYROWSET on EXCSQLSTT
boolean sendQryrowset = true;
fetchSize = (fetchSize == 0) ? org.apache.derby.client.am.Configuration.defaultFetchSize : fetchSize;
boolean sendPrcnam = (procedureName != null) ? true : false;
int numParameters = (parameterMetaData != null) ? parameterMetaData.columns_ : 0;
outputExpected = numParameters > 0;
// is it right here to send maxblkext (-1)
buildEXCSQLSTT(section,
true, // sendOutexp
outputExpected, // outexp
sendPrcnam, // sendPrcnam
procedureName, // prcnam
true, // sendQryblksz
!suppressResultSets, // sendMaxrslcnt,
CodePoint.MAXRSLCNT_NOLIMIT, // maxrslcnt,
true, // sendMaxblkext
-1, // maxblkext (-1 for AR capable of receiving entire result set)
true, // sendRslsetflg
calculateResultSetFlags(), // resultSetFlag
sendQryrowset, // sendQryrowset
fetchSize); // qryrowset
if (numParameters > 0) {
if ((extdtaPositions_ != null) && (!extdtaPositions_.isEmpty())) {
extdtaPositions_.clear(); // reset extdta column position markers
}
// is this the best place for this (OPNQRY needs this too)
// think about having this method return a boolean to
// indicate the extdta should be built
boolean overrideExists = buildSQLDTAcommandData(numParameters,
parameterMetaData,
inputs);
buildEXTDTA(parameterMetaData, inputs, false); // no chained autocommit for CALLs
}
((NetStatement) materialStatement).qryrowsetSentOnOpnqry_ = sendQryrowset;
}
// Write the message to execute an SQL Set Statement.
/*
public void writeSetGenericSQLSetInfo (org.apache.derby.client.am.SetGenericSQLSetPiggybackCommand setGenericSQLSetPiggybackCommand,
org.apache.derby.client.am.JDBCSection section) throws SqlException
{
buildEXCSQLSET (section);
java.util.List sqlsttList = setGenericSQLSetPiggybackCommand.getList();
for (int i = 0; i < sqlsttList.size(); i++) {
String sql = (String)sqlsttList.get(i);
// Build SQLSTT only for the SET statement that coming from the server after RLSCONV
buildSQLSTTcommandData (sql);
}
}
*/
//----------------------helper methods----------------------------------------
// These methods are "private protected", which is not a recognized java privilege,
// but means that these methods are private to this class and to subclasses,
// and should not be used as package-wide friendly methods.
// Build the Open Query Command to open a query to a relational database.
// At SQLAM >= 7 we can request the return of a DA, are there
// scenarios where this should currently be done (it is not supported now)
//
// preconditions:
// the sqlam and/or prdid must support command and parameters passed to this method,
// method will not validate against the connection's level of support
//
void buildOPNQRY(Section section,
boolean sendQueryRowSet,
int fetchSize) throws SqlException {
createCommand();
markLengthBytes(CodePoint.OPNQRY);
buildPKGNAMCSN(section);
buildQRYBLKSZ(); // specify a hard coded query block size
if (sendQueryRowSet) {
buildMAXBLKEXT(-1);
buildQRYROWSET(fetchSize);
}
// Tell the server to close forward-only result sets
// implicitly when they are exhausted. The server will ignore
// this parameter if the result set is scrollable.
if (netAgent_.netConnection_.serverSupportsQryclsimp()) {
buildQRYCLSIMP();
}
updateLengthBytes(); // opnqry is complete
}
// Build the Execute Immediate SQL Statement Command to
// execute a non-cursor SQL statement sent as command data.
//
// precondtions:
void buildEXCSQLIMM(Section section,
boolean sendQryinsid,
long qryinsid) throws SqlException {
createCommand();
markLengthBytes(CodePoint.EXCSQLIMM);
buildPKGNAMCSN(section);
buildRDBCMTOK();
if (sendQryinsid) {
buildQRYINSID(qryinsid);
}
updateLengthBytes();
}
// Build the Prepare SQL Statement Command to dynamically binds an
// SQL statement to a section in an existing relational database (RDB) package.
//
// preconditions:
// the sqlam and/or prdid must support command and parameters passed to this method,
// method will not validate against the connection's level of support
void buildPRPSQLSTT(Section section,
String sql,
boolean sendRtnsqlda,
boolean sendTypsqlda,
int typsqlda) throws SqlException {
createCommand();
markLengthBytes(CodePoint.PRPSQLSTT);
buildPKGNAMCSN(section);
if (sendRtnsqlda) {
buildRTNSQLDA();
}
if (sendTypsqlda) {
buildTYPSQLDA(typsqlda);
}
updateLengthBytes();
}
// Build the command to execute an SQL SET Statement.
// Called by NETSetClientPiggybackCommand.write()
//
// preconditions:
// the sqlam and/or prdid must support command and parameters passed to this method,
// method will not validate against the connection's level of support
void buildEXCSQLSET(Section section)
throws SqlException {
createCommand();
markLengthBytes(CodePoint.EXCSQLSET);
buildPKGNAMCSN(section); // is this PKGNAMCSN or PKGNAMCT
updateLengthBytes();
}
// Build the Execute SQL Statement (EXCSQLSTT) Command
// to execute a non-cursor SQL statement previously bound into a named package
// of a relational database (RDB). The SQL statement can optionally include
// references to input variables, output variables, or both.
//
// At SQLAM >= 7 we can get a DA back on this, are there times that we want to request it
// If so, we probably want to pass a parameter indicating the sqldaLevel requested.
//
// preconditions:
// the sqlam and/or prdid must support command and parameters passed to this method,
// method will not validate against the connection's level of support
// Here is the preferred codepoint ordering:
// PKGNAMCSN
// RDBCMTOK
// OUTEXP
// QRYBLKSZ
// MAXBLKEXT
// MAXRSLCNT
// RSLSETFLG
// QRYROWSET
// RTNSQLDA
// TYPSQLDA
// NBRROW
// ATMIND
// PRCNAM
// OUTOVROPT
// RDBNAM
void buildEXCSQLSTT(Section section,
boolean sendOutexp,
boolean outexp,
boolean sendPrcnam,
String prcnam,
boolean sendQryblksz,
boolean sendMaxrslcnt,
int maxrslcnt,
boolean sendMaxblkext,
int maxblkext,
boolean sendRslsetflg,
int resultSetFlag,
boolean sendQryrowset,
int qryrowset) throws SqlException {
createCommand();
markLengthBytes(CodePoint.EXCSQLSTT);
buildPKGNAMCSN(section);
buildRDBCMTOK();
if (sendOutexp) {
buildOUTEXP(outexp);
}
if (sendQryblksz) {
buildQRYBLKSZ();
}
if (sendQryrowset && sendMaxblkext) {
buildMAXBLKEXT(maxblkext);
}
if (sendMaxrslcnt) {
buildMAXRSLCNT(maxrslcnt);
}
if (sendRslsetflg) {
buildRSLSETFLG(resultSetFlag);
}
if (sendQryrowset) {
buildQRYROWSET(qryrowset);
}
if (sendPrcnam) {
buildPRCNAM(prcnam);
}
updateLengthBytes(); // command is complete, update the length bytes
}
// Build the Describe SQL Statement command.
//
// preconditions:
// the sqlam and/or prdid must support command and parameters passed to this method,
// method will not validate against the connection's level of support
void buildDSCSQLSTT(Section section,
boolean sendTypsqlda,
int typsqlda) throws SqlException {
createCommand();
markLengthBytes(CodePoint.DSCSQLSTT);
buildPKGNAMCSN(section);
if (sendTypsqlda) {
buildTYPSQLDA(typsqlda);
}
updateLengthBytes();
}
// Build the SQL Program Variable Data Command Data Object.
// This object contains the input data to an SQL statement
// that an RDB is executing.
//
// preconditions:
boolean buildSQLDTAcommandData(int numInputColumns,
ColumnMetaData parameterMetaData,
Object[] inputRow) throws SqlException {
createEncryptedCommandData();
int loc = offset_;
markLengthBytes(CodePoint.SQLDTA);
int[][] protocolTypesAndLengths = allocateLidAndLengthsArray(parameterMetaData);
java.util.Hashtable protocolTypeToOverrideLidMapping = null;
java.util.ArrayList mddOverrideArray = null;
protocolTypeToOverrideLidMapping =
computeProtocolTypesAndLengths(inputRow, parameterMetaData, protocolTypesAndLengths,
protocolTypeToOverrideLidMapping);
boolean overrideExists = false;
buildFDODSC(numInputColumns,
protocolTypesAndLengths,
overrideExists,
protocolTypeToOverrideLidMapping,
mddOverrideArray);
buildFDODTA(numInputColumns,
protocolTypesAndLengths,
inputRow);
updateLengthBytes(); // for sqldta
if (netAgent_.netConnection_.getSecurityMechanism() ==
NetConfiguration.SECMEC_EUSRIDDTA ||
netAgent_.netConnection_.getSecurityMechanism() ==
NetConfiguration.SECMEC_EUSRPWDDTA) {
encryptDataStream(loc);
}
return overrideExists;
}
// Build the FDOCA Data Descriptor Scalar whose value is a FDOCA
// Descriptor or a segment of an FDOCA Descriptor.
//
// preconditions:
private void buildFDODSC(int numColumns,
int[][] protocolTypesAndLengths,
boolean overrideExists,
java.util.Hashtable overrideMap,
java.util.ArrayList overrideArray) throws SqlException {
markLengthBytes(CodePoint.FDODSC);
buildSQLDTA(numColumns, protocolTypesAndLengths, overrideExists, overrideMap, overrideArray);
updateLengthBytes();
}
// Build the FDOCA SQLDTA Late Row Descriptor.
//
// preconditions:
protected void buildSQLDTA(int numColumns,
int[][] lidAndLengthOverrides,
boolean overrideExists,
java.util.Hashtable overrideMap,
java.util.ArrayList overrideArray) throws SqlException {
// mdd overrides need to be built first if any before the descriptors are built.
if (overrideExists) {
buildMddOverrides(overrideArray);
writeBytes(FdocaConstants.MDD_SQLDTAGRP_TOSEND);
}
buildSQLDTAGRP(numColumns, lidAndLengthOverrides, overrideExists, overrideMap);
if (overrideExists) {
writeBytes(FdocaConstants.MDD_SQLDTA_TOSEND);
}
writeBytes(FdocaConstants.SQLDTA_RLO_TOSEND);
}
// Build the FDOCA SQLDTAGRP Late Group Descriptor.
// preconditions:
protected void buildSQLDTAGRP(int numVars,
int[][] lidAndLengthOverrides,
boolean mddRequired,
java.util.Hashtable overrideMap) throws SqlException {
int n = 0;
int offset = 0;
n = calculateColumnsInSQLDTAGRPtriplet(numVars);
buildTripletHeader(((3 * n) + 3),
FdocaConstants.NGDA_TRIPLET_TYPE,
FdocaConstants.SQLDTAGRP_LID);
do {
writeLidAndLengths(lidAndLengthOverrides, n, offset, mddRequired, overrideMap);
numVars -= n;
if (numVars == 0) {
break;
}
offset += n;
n = calculateColumnsInSQLDTAGRPtriplet(numVars);
buildTripletHeader(((3 * n) + 3),
FdocaConstants.CPT_TRIPLET_TYPE,
0x00);
} while (true);
}
/////////// perf end
protected void buildOUTOVR(ResultSet resultSet,
ColumnMetaData resultSetMetaData) throws SqlException {
createCommandData();
markLengthBytes(CodePoint.OUTOVR);
int[][] outputOverrides =
calculateOUTOVRLidAndLengthOverrides(resultSet, resultSetMetaData);
buildSQLDTARD(resultSetMetaData.columns_, outputOverrides);
updateLengthBytes();
}
private int[][] calculateOUTOVRLidAndLengthOverrides(ResultSet resultSet,
ColumnMetaData resultSetMetaData) {
int numVars = resultSetMetaData.columns_;
int[][] lidAndLengths = new int[numVars][2]; //everything initialized to "default triplet"
for (int i=0; i<numVars; ++i) {
switch (resultSetMetaData.types_[i]) {
case java.sql.Types.BLOB:
lidAndLengths[i][0] = (resultSetMetaData.nullable_[i])
? DRDAConstants.DRDA_TYPE_NLOBLOC
: DRDAConstants.DRDA_TYPE_LOBLOC;
lidAndLengths[i][1] = 4;
break;
case java.sql.Types.CLOB:
lidAndLengths[i][0] = (resultSetMetaData.nullable_[i])
? DRDAConstants.DRDA_TYPE_NCLOBLOC
: DRDAConstants.DRDA_TYPE_CLOBLOC;
lidAndLengths[i][1] = 4;
break;
}
}
return lidAndLengths;
}
protected void buildSQLDTARD(int numColumns, int[][] lidAndLengthOverrides) throws SqlException {
buildSQLCADTA(numColumns, lidAndLengthOverrides);
writeBytes(FdocaConstants.SQLDTARD_RLO_TOSEND);
}
protected void buildSQLCADTA(int numColumns, int[][] lidAndLengthOverrides) throws SqlException {
buildSQLDTAGRP(numColumns, lidAndLengthOverrides, false, null); // false means no mdd override
writeBytes(FdocaConstants.SQLCADTA_RLO_TOSEND);
}
private void buildFDODTA(int numVars,
int[][] protocolTypesAndLengths,
Object[] inputs) throws SqlException {
try
{
Object o = null;
markLengthBytes(CodePoint.FDODTA);
write1Byte(FdocaConstants.NULL_LID); // write the 1-byte row indicator
// write data for each input column
for (int i = 0; i < numVars; i++) {
if (inputs[i] == null) {
if ((protocolTypesAndLengths[i][0] % 2) == 1) {
write1Byte(FdocaConstants.NULL_DATA);
} else {
//bug check
}
} else {
if ((protocolTypesAndLengths[i][0] % 2) == 1) {
write1Byte(FdocaConstants.INDICATOR_NULLABLE);
}
switch (protocolTypesAndLengths[i][0] | 0x01) { // mask out null indicator
case DRDAConstants.DRDA_TYPE_NVARMIX:
case DRDAConstants.DRDA_TYPE_NLONGMIX:
// What to do for server that don't understand 1208 (UTF-8)
// check for a promototed type, and use that instead if it exists
o = retrievePromotedParameterIfExists(i);
if (o == null) {
writeSingleorMixedCcsidLDString((String) inputs[i], netAgent_.typdef_.getCcsidMbcEncoding());
} else { // use the promototed object instead
setFDODTALob(netAgent_.netConnection_.getSecurityMechanism(),
(Clob) o,
protocolTypesAndLengths,
i);
}
break;
case DRDAConstants.DRDA_TYPE_NVARCHAR:
case DRDAConstants.DRDA_TYPE_NLONG:
o = retrievePromotedParameterIfExists(i);
if (o == null) {
} else { // use the promototed object instead
setFDODTALob(netAgent_.netConnection_.getSecurityMechanism(),
(Clob) o,
protocolTypesAndLengths,
i);
}
break;
case DRDAConstants.DRDA_TYPE_NINTEGER:
writeIntFdocaData(((Integer) inputs[i]).intValue());
break;
case DRDAConstants.DRDA_TYPE_NSMALL:
writeShortFdocaData(((Short) inputs[i]).shortValue());
break;
case DRDAConstants.DRDA_TYPE_NFLOAT4:
writeFloat(((Float) inputs[i]).floatValue());
break;
case DRDAConstants.DRDA_TYPE_NFLOAT8:
writeDouble(((Double) inputs[i]).doubleValue());
break;
case DRDAConstants.DRDA_TYPE_NDECIMAL:
writeBigDecimal((java.math.BigDecimal) inputs[i],
(protocolTypesAndLengths[i][1] >> 8) & 0xff, // described precision not actual
protocolTypesAndLengths[i][1] & 0xff); // described scale, not actual
break;
case DRDAConstants.DRDA_TYPE_NDATE:
writeDate((java.sql.Date) inputs[i]);
break;
case DRDAConstants.DRDA_TYPE_NTIME:
writeTime((java.sql.Time) inputs[i]);
break;
case DRDAConstants.DRDA_TYPE_NTIMESTAMP:
writeTimestamp((java.sql.Timestamp) inputs[i]);
break;
case DRDAConstants.DRDA_TYPE_NINTEGER8:
writeLongFdocaData(((Long) inputs[i]).longValue());
break;
case DRDAConstants.DRDA_TYPE_NVARBYTE:
case DRDAConstants.DRDA_TYPE_NLONGVARBYTE:
o = retrievePromotedParameterIfExists(i);
if (o == null) {
writeLDBytes((byte[]) inputs[i]);
} else { // use the promototed object instead
setFDODTALob(netAgent_.netConnection_.getSecurityMechanism(),
(Clob) o,
protocolTypesAndLengths,
i);
}
break;
case DRDAConstants.DRDA_TYPE_NLOBCSBCS:
case DRDAConstants.DRDA_TYPE_NLOBCDBCS:
// check for a promoted Clob
o = retrievePromotedParameterIfExists(i);
if (o == null) {
try {
java.sql.Clob c = (java.sql.Clob) inputs[i];
if( c instanceof Clob &&
( (Clob) c ).willBeLayerBStreamed() ) {
setFDODTALobLengthUnknown( i );
}else{
long dataLength = c.length();
setFDODTALobLength(protocolTypesAndLengths, i, dataLength);
}
} catch (java.sql.SQLException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_ERROR_GETTING_BLOB_LENGTH),
e);
}
} else {
setFDODTALob(netAgent_.netConnection_.getSecurityMechanism(),
(Clob) o,
protocolTypesAndLengths,
i);
}
break;
case DRDAConstants.DRDA_TYPE_NLOBBYTES:
// check for a promoted Clob
o = retrievePromotedParameterIfExists(i);
if (o == null) {
try {
java.sql.Blob b = (java.sql.Blob) inputs[i];
if( b instanceof Blob &&
( (Blob) b ).willBeLayerBStreamed() ) {
setFDODTALobLengthUnknown( i );
}else{
long dataLength = b.length();
setFDODTALobLength(protocolTypesAndLengths, i, dataLength);
}
} catch (java.sql.SQLException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_ERROR_GETTING_BLOB_LENGTH),
e);
}
} else { // use promoted Blob
setFDODTALob(netAgent_.netConnection_.getSecurityMechanism(),
(Blob) o,
protocolTypesAndLengths,
i);
}
break;
case DRDAConstants.DRDA_TYPE_NLOBCMIXED:
// check for a promoted Clob
o = retrievePromotedParameterIfExists(i);
if (o == null) {
final Clob c = (Clob) inputs[i];
if (c.isString()) {
setFDODTALobLength(protocolTypesAndLengths,
i,
c.getUTF8Length() );
} else if ( ! c.willBeLayerBStreamed() ){
// must be a Unicode stream
setFDODTALobLength(protocolTypesAndLengths,
i,
c.length() );
} else {
setFDODTALobLengthUnknown( i );
}
} else { // use promoted Clob
setFDODTALob(netAgent_.netConnection_.getSecurityMechanism(),
(Clob) o,
protocolTypesAndLengths,
i);
}
break;
case DRDAConstants.DRDA_TYPE_NLOBLOC:
//The FD:OCA data or the FDODTA contains the locator
//value corresponding to the LOB. write the integer
//value representing the locator here.
writeIntFdocaData(((Blob)inputs[i]).
getLocator());
break;
case DRDAConstants.DRDA_TYPE_NCLOBLOC:
//The FD:OCA data or the FDODTA contains the locator
//value corresponding to the LOB. write the integer
//value representing the locator here.
writeIntFdocaData(((Clob)inputs[i]).
getLocator());
break;
default:
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_UNRECOGNIZED_JDBC_TYPE),
new Integer(protocolTypesAndLengths[i][0]),
new Integer(numVars), new Integer(i));
}
}
}
updateLengthBytes(); // for fdodta
}
catch ( java.sql.SQLException se )
{
throw new SqlException(se);
}
}
// preconditions:
private void buildEXTDTA(ColumnMetaData parameterMetaData,
Object[] inputRow,
boolean chained) throws SqlException {
try
{
// build the EXTDTA data, if necessary
if (extdtaPositions_ != null) {
boolean chainFlag, chainedWithSameCorrelator;
for (int i = 0; i < extdtaPositions_.size(); i++) {
int index = ((Integer) extdtaPositions_.get(i)).intValue();
// is this the last EXTDTA to be built?
if (i != extdtaPositions_.size() - 1) { // no
chainFlag = true;
chainedWithSameCorrelator = true;
} else { // yes
chainFlag = chained;
chainedWithSameCorrelator = false;
}
// do we have to write a null byte?
boolean writeNullByte = false;
if (parameterMetaData.nullable_[index]) {
writeNullByte = true;
}
// Use the type of the input parameter rather than the input
// column if possible.
int parameterType = parameterMetaData.clientParamtertype_[index];
if (parameterType == 0) {
parameterType = parameterMetaData.types_[index];
}
// the follow types are possible due to promotion to BLOB
if (parameterType == Types.BLOB
|| parameterType == Types.BINARY
|| parameterType == Types.VARBINARY
|| parameterType == Types.LONGVARBINARY) {
Blob o = (Blob) retrievePromotedParameterIfExists(index);
java.sql.Blob b = (o == null) ? (java.sql.Blob) inputRow[index] : o;
boolean isExternalBlob = !(b instanceof org.apache.derby.client.am.Blob);
if (isExternalBlob) {
try {
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) b.length(),
b.getBinaryStream(),
writeNullByte,
index + 1);
} catch (java.sql.SQLException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_ERROR_GETTING_BLOB_LENGTH),
e);
}
} else if ( ( (Blob) b).isBinaryStream()) {
if( ( (Blob) b).willBeLayerBStreamed() ){
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
((Blob) b).getBinaryStream(),
writeNullByte,
index + 1);
}else{
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) ((Blob) b).length(),
((Blob) b).getBinaryStream(),
writeNullByte,
index + 1);
}
} else { // must be a binary string
// note: a possible optimization is to use writeScalarLobBytes
// when the input is small
// use this: if (b.length () < DssConstants.MAX_DSS_LEN - 6 - 4)
// writeScalarLobBytes (...)
// Yes, this would avoid having to new up a java.io.ByteArrayInputStream
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) ((Blob) b).length(),
((Blob) b).getBinaryStream(),
writeNullByte,
index + 1);
}
}
// the follow types are possible due to promotion to CLOB
else if (
parameterType == Types.CLOB
|| parameterType == Types.CHAR
|| parameterType == Types.VARCHAR
|| parameterType == Types.LONGVARCHAR) {
Clob o = (Clob) retrievePromotedParameterIfExists(index);
java.sql.Clob c = (o == null) ? (java.sql.Clob) inputRow[index] : o;
boolean isExternalClob = !(c instanceof org.apache.derby.client.am.Clob);
if (isExternalClob) {
try {
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) c.length(),
c.getCharacterStream(),
writeNullByte,
index + 1);
} catch (java.sql.SQLException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_ERROR_GETTING_BLOB_LENGTH),
e);
}
} else if ( ( (Clob) c).isCharacterStream()) {
if( ( (Clob) c).willBeLayerBStreamed() ) {
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
((Clob) c).getCharacterStream(),
writeNullByte,
index + 1);
}else{
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) ((Clob) c).length(),
((Clob) c).getCharacterStream(),
writeNullByte,
index + 1);
}
} else if (((Clob) c).isAsciiStream()) {
if( ( (Clob) c).willBeLayerBStreamed() ){
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
((Clob) c).getAsciiStream(),
writeNullByte,
index + 1);
}else {
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) ((Clob) c).length(),
((Clob) c).getAsciiStream(),
writeNullByte,
index + 1);
}
} else if (((Clob) c).isUnicodeStream()) {
if( ( (Clob) c).willBeLayerBStreamed() ){
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
((Clob) c).getUnicodeStream(),
writeNullByte,
index + 1);
}else{
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) ((Clob) c).length(),
((Clob) c).getUnicodeStream(),
writeNullByte,
index + 1);
}
} else { // must be a String
// note: a possible optimization is to use writeScalarLobBytes
// when the input is small.
// use this: if (c.length () < DssConstants.MAX_DSS_LEN - 6 - 4)
// writeScalarLobBytes (...)
writeScalarStream(chainFlag,
chainedWithSameCorrelator,
CodePoint.EXTDTA,
(int) ((Clob) c).getUTF8Length(),
new java.io.ByteArrayInputStream(((Clob) c).getUtf8String()),
writeNullByte,
index + 1);
}
}
}
}
}
catch ( java.sql.SQLException se )
{
throw new SqlException(se);
}
}
//-------------------------helper methods-------------------------------------
// returns the a promototedParameter object for index or null if it does not exist
private Object retrievePromotedParameterIfExists(int index) {
// consider using a nonsynchronized container or array
if (promototedParameters_.isEmpty()) {
return null;
}
return promototedParameters_.get(new Integer(index));
}
private int calculateColumnsInSQLDTAGRPtriplet(int numVars) {
if (numVars > FdocaConstants.MAX_VARS_IN_NGDA) //rename to MAX_VARS_IN_SQLDTAGRP_TRIPLET
{
return FdocaConstants.MAX_VARS_IN_NGDA;
}
return numVars;
}
// Consider refacctor so that this does not even have to look
// at the actual object data, and only uses tags from the meta data
// only have to call this once, rather than calling this for every input row
// Comment: I don't think that it is possible to send decimal values without looking at the data for
// precision and scale (Kathey Marsden 10/11)
// backburner: after refactoring this, later on, think about replacing case statements with table lookups
private java.util.Hashtable computeProtocolTypesAndLengths(Object[] inputRow,
ColumnMetaData parameterMetaData,
int[][] lidAndLengths,
java.util.Hashtable overrideMap) throws SqlException {
try
{
int numVars = parameterMetaData.columns_;
String s = null;
if (!promototedParameters_.isEmpty()) {
promototedParameters_.clear();
}
for (int i = 0; i < numVars; i++) {
int jdbcType;
// Send the input type unless it is not available.
// (e.g an output parameter)
jdbcType = parameterMetaData.clientParamtertype_[i];
if (jdbcType == 0) {
jdbcType = parameterMetaData.types_[i];
}
// jdbc semantics - This should happen outside of the build methods
// if describe input is not supported, we require the user to at least
// call setNull() and provide the type information. Otherwise, we won't
// be able to guess the right PROTOCOL type to send to the server, and an
// exception is thrown.
if (jdbcType == 0) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_INVALID_JDBC_TYPE_FOR_PARAM),
new Integer(i));
}
switch (jdbcType) {
case java.sql.Types.CHAR:
case java.sql.Types.VARCHAR:
// lid: PROTOCOL_TYPE_NVARMIX, length override: 32767 (max)
// dataFormat: String
// this won't work if 1208 is not supported
s = (String) inputRow[i];
// assumes UTF-8 characters at most 3 bytes long
// Flow the String as a VARCHAR
if (s == null || s.length() <= 32767 / 3) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NVARMIX;
lidAndLengths[i][1] = 32767;
} else {
// Flow the data as CLOB data if the data too large to for LONGVARCHAR
java.io.ByteArrayInputStream bais = null;
byte[] ba = null;
try {
ba = s.getBytes("UTF-8");
bais = new java.io.ByteArrayInputStream(ba);
Clob c = new Clob(netAgent_, bais, "UTF-8", ba.length);
// inputRow[i] = c;
// Place the new Lob in the promototedParameter_ collection for
// NetStatementRequest use
promototedParameters_.put(new Integer(i), c);
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCMIXED;
if( c.willBeLayerBStreamed() ){
//Correspond to totalLength 0 as default length for unknown
lidAndLengths[i][1] = 0x8002;
}else {
lidAndLengths[i][1] = buildPlaceholderLength(c.length());
}
} catch (java.io.UnsupportedEncodingException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.UNSUPPORTED_ENCODING),
"byte array", "Clob", e);
}
}
break;
case java.sql.Types.INTEGER:
// lid: PROTOCOL_TYPE_NINTEGER, length override: 4
// dataFormat: Integer
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NINTEGER;
lidAndLengths[i][1] = 4;
break;
case java.sql.Types.BOOLEAN:
case java.sql.Types.SMALLINT:
case java.sql.Types.TINYINT:
case java.sql.Types.BIT:
// lid: PROTOCOL_TYPE_NSMALL, length override: 2
// dataFormat: Short
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NSMALL;
lidAndLengths[i][1] = 2;
break;
case java.sql.Types.REAL:
// lid: PROTOCOL_TYPE_NFLOAT4, length override: 4
// dataFormat: Float
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NFLOAT4;
lidAndLengths[i][1] = 4;
break;
case java.sql.Types.DOUBLE:
case java.sql.Types.FLOAT:
// lid: PROTOCOL_TYPE_NFLOAT8, length override: 8
// dataFormat: Double
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NFLOAT8;
lidAndLengths[i][1] = 8;
break;
case java.sql.Types.NUMERIC:
case java.sql.Types.DECIMAL:
// lid: PROTOCOL_TYPE_NDECIMAL
// dataFormat: java.math.BigDecimal
// if null - guess with precision 1, scale 0
// if not null - get scale from data and calculate maximum precision.
// DERBY-2073. Get scale and precision from data so we don't lose fractional digits.
java.math.BigDecimal bigDecimal = (java.math.BigDecimal) inputRow[i];
int scale;
int precision;
if (bigDecimal == null)
{
scale = 0;
precision = 1;
}
else
{
// adjust scale if it is negative. Packed Decimal cannot handle
// negative scale. We don't want to change the original
// object so make a new one.
if (bigDecimal.scale() < 0)
{
bigDecimal = bigDecimal.setScale(0);
inputRow[i] = bigDecimal;
}
scale = bigDecimal.scale();
precision = Utils.computeBigDecimalPrecision(bigDecimal);
}
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NDECIMAL;
lidAndLengths[i][1] = (precision << 8) + // use precision above
(scale << 0);
break;
case java.sql.Types.DATE:
// for input, output, and inout parameters
// lid: PROTOCOL_TYPE_NDATE, length override: 8
// dataFormat: java.sql.Date
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NDATE;
lidAndLengths[i][1] = 10;
break;
case java.sql.Types.TIME:
// for input, output, and inout parameters
// lid: PROTOCOL_TYPE_NTIME, length override: 8
// dataFormat: java.sql.Time
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NTIME;
lidAndLengths[i][1] = 8;
break;
case java.sql.Types.TIMESTAMP:
// for input, output, and inout parameters
// lid: PROTOCOL_TYPE_NTIME, length overrid: 26
// dataFormat: java.sql.Timestamp
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NTIMESTAMP;
lidAndLengths[i][1] = 26;
break;
case java.sql.Types.BIGINT:
// if SQLAM < 6 this should be mapped to decimal (19,0) in common layer
// if SQLAM >=6, lid: PROTOCOL_TYPE_NINTEGER8, length override: 8
// dataFormat: Long
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NINTEGER8;
lidAndLengths[i][1] = 8;
break;
case java.sql.Types.LONGVARCHAR:
// Is this the right thing to do // should this be 32700
s = (String) inputRow[i];
if (s == null || s.length() <= 32767 / 3) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLONGMIX;
lidAndLengths[i][1] = 32767;
} else {
// Flow the data as CLOB data if the data too large to for LONGVARCHAR
java.io.ByteArrayInputStream bais = null;
byte[] ba = null;
try {
ba = s.getBytes("UTF-8");
bais = new java.io.ByteArrayInputStream(ba);
Clob c = new Clob(netAgent_, bais, "UTF-8", ba.length);
// inputRow[i] = c;
// Place the new Lob in the promototedParameter_ collection for
// NetStatementRequest use
promototedParameters_.put(new Integer(i), c);
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCMIXED;
lidAndLengths[i][1] = buildPlaceholderLength(c.length());
} catch (java.io.UnsupportedEncodingException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.UNSUPPORTED_ENCODING),
"byte array", "Clob");
}
}
break;
case java.sql.Types.BINARY:
case java.sql.Types.VARBINARY:
byte[] ba = (byte[]) inputRow[i];
if (ba == null) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NVARBYTE;
lidAndLengths[i][1] = 32767;
} else if (ba.length <= 32767) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NVARBYTE;
lidAndLengths[i][1] = 32767;
} else {
// Promote to a BLOB. Only reach this path in the absence of describe information.
Blob b = new Blob(ba, netAgent_, 0);
// inputRow[i] = b;
// Place the new Lob in the promototedParameter_ collection for
// NetStatementRequest use
promototedParameters_.put(new Integer(i), b);
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBBYTES;
lidAndLengths[i][1] = buildPlaceholderLength(ba.length);
}
break;
case java.sql.Types.LONGVARBINARY:
ba = (byte[]) inputRow[i];
if (ba == null) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLONGVARBYTE;
lidAndLengths[i][1] = 32767;
} else if (ba.length <= 32767) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLONGVARBYTE;
lidAndLengths[i][1] = 32767;
} else {
// Promote to a BLOB. Only reach this path in the absensce of describe information.
Blob b = new Blob(ba, netAgent_, 0);
// inputRow[i] = b;
// Place the new Lob in the promototedParameter_ collection for
// NetStatementRequest use
promototedParameters_.put(new Integer(i), b);
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBBYTES;
lidAndLengths[i][1] = buildPlaceholderLength(ba.length);
}
break;
case java.sql.Types.BLOB:
java.sql.Blob b = (java.sql.Blob) inputRow[i];
if (b == null) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBBYTES;
lidAndLengths[i][1] =
buildPlaceholderLength(parameterMetaData.sqlLength_[i]);
} else if (b instanceof Blob && ((Blob)b).isLocator()){
//we are sending locators.
//Here the LID local identifier in the FDODSC
//FD:OCA descriptor should be initialized as
//to contain a BLOB locator.
lidAndLengths[i][0] =
DRDAConstants.DRDA_TYPE_NLOBLOC;
lidAndLengths[i][1] = 4;
} else {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBBYTES;
try {
if( b instanceof Blob &&
( (Blob) b).willBeLayerBStreamed() ){
//Correspond to totalLength 0 as default length for unknown
lidAndLengths[i][1] = 0x8002;
}else {
lidAndLengths[i][1] = buildPlaceholderLength(b.length());
}
} catch (java.sql.SQLException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_ERROR_GETTING_BLOB_LENGTH), e);
}
}
break;
case java.sql.Types.CLOB:
{
// use columnMeta.singleMixedByteOrDouble_ to decide protocolType
java.sql.Clob c = (java.sql.Clob) inputRow[i];
boolean isExternalClob = !(c instanceof org.apache.derby.client.am.Clob);
long lobLength = 0;
boolean doesLayerBStreaming = false;
if (c == null) {
lobLength = parameterMetaData.sqlLength_[i];
} else if (c instanceof Clob && ((Clob)c).isLocator()) {
//The inputRow contains an Integer meaning that
//we are sending locators.
//Here the LID local identifier in the FDODSC
//FD:OCA descriptor should be initialized as
//to contain a CLOB locator.
lidAndLengths[i][0] =
DRDAConstants.DRDA_TYPE_NCLOBLOC;
lidAndLengths[i][1] = 4;
} else if (isExternalClob) {
try {
lobLength = c.length();
} catch (java.sql.SQLException e) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_ERROR_GETTING_BLOB_LENGTH),
e);
}
} else {
if( ( (Clob) c ).willBeLayerBStreamed() ){
doesLayerBStreaming = true;
}else{
lobLength = ((Clob) c).length();
}
}
if (c == null) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCMIXED;
lidAndLengths[i][1] = buildPlaceholderLength(lobLength);
} else if (isExternalClob) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCDBCS;
lidAndLengths[i][1] = buildPlaceholderLength(lobLength);
} else if (((Clob) c).isCharacterStream()) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCDBCS;
if( doesLayerBStreaming ) {
//Correspond to totalLength 0 as default length for unknown
lidAndLengths[i][1] = 0x8002;
}else {
lidAndLengths[i][1] = buildPlaceholderLength(lobLength);
}
} else if (((Clob) c).isUnicodeStream()) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCMIXED;
if( doesLayerBStreaming ) {
//Correspond to totalLength 0 as default length for unknown
lidAndLengths[i][1] = 0x8002;
}else {
lidAndLengths[i][1] = buildPlaceholderLength(lobLength);
}
} else if (((Clob) c).isAsciiStream()) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCSBCS;
if( doesLayerBStreaming ) {
//Correspond to totalLength 0 as default length for unknown
lidAndLengths[i][1] = 0x8002;
}else {
lidAndLengths[i][1] = buildPlaceholderLength(lobLength);
}
} else if (((Clob) c).isString()) {
lidAndLengths[i][0] = DRDAConstants.DRDA_TYPE_NLOBCMIXED;
if( doesLayerBStreaming ) {
//Correspond to totalLength 0 as default length for unknown
lidAndLengths[i][1] = 0x8002;
}else {
lidAndLengths[i][1] = buildPlaceholderLength(lobLength);
}
}
}
break;
default :
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.UNRECOGNIZED_JAVA_SQL_TYPE),
new Integer(jdbcType));
}
if (!parameterMetaData.nullable_[i]) {
lidAndLengths[i][0]--;
}
}
return overrideMap;
}
catch ( java.sql.SQLException se )
{
throw new SqlException(se);
}
}
private int buildPlaceholderLength(long totalLength) {
if (totalLength < 0x7fff) {
return 0x8002; // need 2 bytes
} else if (totalLength < 0x7fffffff) {
return 0x8004; // need 4 bytes
} else if (totalLength < 0x7fffffffffffL) {
return 0x8006;
} else {
return 0x8008; // need 8 bytes
}
}
// Output Expected indicates wheterh the requester expects the target
// SQLAM to return output with an SQLDTARD reply data object
// as a result of the execution of the referenced SQL statement.
// this is a single byte.
// there are two possible enumerated values:
// 0x'F1' (CodePoint.TRUE) - for true indicating the requester expects output
// 0x'F0' (CodePoint.FALSE) - for false indicating the requeser does not expect output
// 0x'F0' is the default.
//
// preconditions:
// sqlam must support this parameter on the command, method will not check.
private void buildOUTEXP(boolean outputExpected) throws SqlException {
if (outputExpected) {
writeScalar1Byte(CodePoint.OUTEXP, CodePoint.TRUE);
}
}
// Maximum Number of Extra Blocks specifies a limit on the number of extra
// blocks of answer set data per result set that the requester is capable of
// receiveing.
// this value must be able to be contained in a two byte signed number.
// there is a minimum value of 0.
// a zero indicates that the requester is not capable of receiving extra
// query blocks of answer set data.
// there is a SPCVAL of -1.
// a value of -1 indicates that the requester is capable of receiving
// the entire result set.
//
// preconditions:
// sqlam must support this parameter on the command, method will not check.
void buildMAXBLKEXT(int maxNumOfExtraBlocks) throws SqlException {
if (maxNumOfExtraBlocks != 0) {
writeScalar2Bytes(CodePoint.MAXBLKEXT, maxNumOfExtraBlocks);
}
}
// preconditions:
void buildQRYROWSET(int fetchSize) throws SqlException {
writeScalar4Bytes(CodePoint.QRYROWSET, fetchSize);
}
// The Procedure Name.
// The default value of PRCNAM is the procedure name value contained
// within the section identified by the pkgnamcsn parameter. If that
// value is null, then the prcnam parameter must be specified.
// it has a max length of 255.
// the prcnam is required on commands if the procedure name is
// specified by a host variable.
// the default value is the procedure name contained in the section
// specified by the pkgnamcsn parameter on the EXCSQLSTT command.
//
// preconditions:
// sqlam must support this parameter for the command, method will not check.
// prcnam can not be null, SQLException will be thrown
// prcnam can not be 0 length or > 255 length, SQLException will be thrown.
private void buildPRCNAM(String prcnam) throws SqlException {
if (prcnam == null) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_NULL_PROCEDURE_NAME));
}
int prcnamLength = prcnam.length();
if ((prcnamLength == 0) || (prcnamLength > 255)) {
throw new SqlException(netAgent_.logWriter_,
new ClientMessageId(SQLState.NET_PROCEDURE_NAME_LENGTH_OUT_OF_RANGE),
new Integer(prcnamLength), new Integer(255));
}
writeScalarString(CodePoint.PRCNAM, prcnam);
}
// Query Block Size specifies the query block size for the reply
// data objects and the reply messages being returned from this command.
// this is a 4 byte unsigned binary number.
// the sqlam 6 min value is 512 and max value is 32767.
// this value was increased in later sqlam levels.
// until the code is ready to support larger query block sizes,
// it will always use DssConstants.MAX_DSS_LEN which is 32767.
//
// preconditions:
// sqlam must support this parameter for the command, method will not check.
void buildQRYBLKSZ() throws SqlException {
writeScalar4Bytes(CodePoint.QRYBLKSZ, DssConstants.MAX_DSS_LEN);
}
// Maximum Result Set Count specifies a limit on the number of result sets
// the requester is capable of receiving as reply data in response to an ECSQLSTT
// command that invokes a stored procedure. If the stored procedure generates
// more than MAXRSLCNT result sets, then the target system returns at most, the first
// MAXRSLCNT of these result sets. The stored procedure defines the order
// in which the target system returns result sets.
// this is s two byte signed binary number.
// it has a min value of 0 which indicates the requester is not capable
// of receiving result sets as reply data in response to the command.
// a special value, -1 (CodePoint.MAXRSLCNT_NOLIMIT = 0xffff), indicates the
// requester is capable of receiving all result sets in response the EXCSQLSTT.
//
// preconditions:
// sqlam must support this parameter for the command, method will not check.
// the value must be in correct range (-1 to 32767), method will not check.
private void buildMAXRSLCNT(int maxResultSetCount) throws SqlException {
if (maxResultSetCount == 0) {
return;
}
writeScalar2Bytes(CodePoint.MAXRSLCNT, maxResultSetCount);
}
// RDB Commit Allowed specifies whether an RDB should allow the processing of any
// commit or rollback operations that occure during execution of a statement.
// True allow the processing of commits and rollbacks
private void buildRDBCMTOK() throws SqlException {
writeScalar1Byte(CodePoint.RDBCMTOK, CodePoint.TRUE);
}
// Result Set Flags is a single byte where each bit it a boolean flag.
// It specifies wheter the requester desires the server to return name,
// label and comment information for the columns of result sets generated by the command.
// The default is b'00000000'.
// columnNamesRequired
// false means the requester does not desire column names returned.
// true means the requester desires column names returned.
// columnLabelsRequired
// false means the requester does not desire column labels returned.
// true means the requester desires column labels returned.
// columnCommentsRequired
// false means the requester does not desire column comments returned.
// true means the requester desired column comments returned.
// cantProcessAnswerSetData
// false means that for each result set, the requester expects the command
// to return an FDOCA description of the answer set data and to possibly
// return answer set data. the block containing the end of the description
// may be completed if room exists with answer set data. additional blocks
// of answer set data may also be chained to the block containing the end of the
// FDOCA description. up to the maximum number of extra blocks of answer set data
// per result set specified in the MAXBLKEXT parameter.
// true means that for each result set, the requester expects the command to return
// an FDOCA description of the answer set data but does not expect the command to
// return any answer set data.
// at SQLAM 7, new flags are supported which can be used to return
// standard, extended, and light sqlda
//
// preconditions:
// sqlam must support this parameter, method will not check.
private void buildRSLSETFLG(int resultSetFlag) throws SqlException {
writeScalar1Byte(CodePoint.RSLSETFLG, resultSetFlag);
}
void buildQRYINSID(long qryinsid) throws SqlException {
markLengthBytes(CodePoint.QRYINSID);
writeLong(qryinsid);
updateLengthBytes();
}
// Return SQL Descriptor Area controls whether to return
// an SQL descriptor area that applies to the SQL statement this command
// identifies. The target SQLAM obtains the SQL descriptor area by performing
// an SQL DESCRIBE function on the statement after the statement has been
// prepared.
// The value TRUE, X'F1' (CodePoint.TRUE), indicates an SQLDA is returned
// The value FALSE, X'F0' (CodePoint.FALSE), default, indicates an SQLDA is not returned.
//
// preconditions:
// sqlam must support this parameter for the command, method will not check.
private void buildRTNSQLDA() throws SqlException {
writeScalar1Byte(CodePoint.RTNSQLDA, CodePoint.TRUE);
}
// Type of SQL Descriptor Area.
// This is a single byte signed number that specifies the type of sqlda to
// return for the command.
// below sqlam 7 there were two possible enumerated values for this parameter.
// 0 (CodePoint.TYPSQLDA_STD_OUTPUT)- the default, indicates return the output sqlda.
// 1 (CodePoint.TYPSQLDA_STD_INPUT) - indicates return the input sqlda.
// the typsqlda was enhanced at sqlam 7 to support extened describe.
// at sqlam 7 the following enumerated values are supported.
// 0 (CodePoint.TYPSQLDA_STD_OUTPUT) - the default, standard output sqlda.
// 1 (CodePoint.TYPSQLDA_STD_INPUT) - standard input sqlda.
// 2 (CodePoint.TYPSQLDA_LIGHT_OUTPUT) - light output sqlda.
// 3 (CodePoint.TYPSQLDA_LIGHT_INPUT) - light input sqlda.
// 4 (CodePoint.TYPSQLDA_X_OUTPUT) - extended output sqlda.
// 5 (CodePoint.TYPSQLDA_X_INPUT) - extended input sqlda.
//
// preconditions:
// sqlam or prdid must support this, method will not check.
// valid enumerated type must be passed to method, method will not check.
private void buildTYPSQLDA(int typeSqlda) throws SqlException {
// possibly inspect typeSqlda value and verify against sqlam level
if (typeSqlda != CodePoint.TYPSQLDA_STD_OUTPUT) {
writeScalar1Byte(CodePoint.TYPSQLDA, typeSqlda);
}
}
/**
* Build QRYCLSIMP (Query Close Implicit). Query Close Implicit
* controls whether the target server implicitly closes a
* non-scrollable query upon end of data (SQLSTATE 02000).
*/
private void buildQRYCLSIMP() {
writeScalar1Byte(CodePoint.QRYCLSIMP, CodePoint.QRYCLSIMP_YES);
}
// helper method to buildFDODTA to build the actual data length
private void setFDODTALobLength(int[][] protocolTypesAndLengths, int i, long dataLength) throws SqlException {
if (protocolTypesAndLengths[i][1] == 0x8002) {
writeShort((short) dataLength);
} else if (protocolTypesAndLengths[i][1] == 0x8004) {
writeInt((int) dataLength); // 4 bytes to encode the length
} else if (protocolTypesAndLengths[i][1] == 0x8006)// 6 bytes to encode the length
{
writeLong(dataLength);
}
//throw new SqlException (netAgent_.logWriter_, "0x8006 lob place holders not yet supported");
else if (protocolTypesAndLengths[i][1] == 0x8008)// 8 bytes to encode the length
{
writeLong(dataLength);
}
if (dataLength != 0) {
if (extdtaPositions_ == null) {
extdtaPositions_ = new java.util.ArrayList();
}
extdtaPositions_.add(new Integer(i));
}
}
private void setFDODTALobLengthUnknown(int i) throws SqlException {
short v = 1;
writeShort( v <<= 15 );
if (extdtaPositions_ == null) {
extdtaPositions_ = new java.util.ArrayList();
}
extdtaPositions_.add(new Integer(i));
}
private boolean checkSendQryrowset(int fetchSize,
int resultSetType) {
// if the cursor is forward_only, ignore the fetchSize and let the server return
// as many rows as fit in the query block.
// if the cursor is scrollable, send qryrowset if it is supported by the server
boolean sendQryrowset = false;
if (resultSetType != java.sql.ResultSet.TYPE_FORWARD_ONLY) {
sendQryrowset = true;
}
return sendQryrowset;
}
private int checkFetchsize(int fetchSize, int resultSetType) {
// if fetchSize is not set for scrollable cursors, set it to the default fetchSize
if (resultSetType != java.sql.ResultSet.TYPE_FORWARD_ONLY && fetchSize == 0) {
fetchSize = org.apache.derby.client.am.Configuration.defaultFetchSize;
}
return fetchSize;
}
private int calculateResultSetFlags() {
return CodePoint.RSLSETFLG_EXTENDED_SQLDA;
}
public void writeSetSpecialRegister(Section section, java.util.ArrayList sqlsttList) throws SqlException {
buildEXCSQLSET(section);
// SQLSTT:
for (int i = 0; i < sqlsttList.size(); i++) {
buildSQLSTTcommandData((String) sqlsttList.get(i));
}
}
private int[][] allocateLidAndLengthsArray(ColumnMetaData parameterMetaData) {
int numVars = parameterMetaData.columns_;
int[][] lidAndLengths = parameterMetaData.protocolTypesCache_;
if ((lidAndLengths) == null || (lidAndLengths.length != numVars)) {
lidAndLengths = new int[numVars][2];
parameterMetaData.protocolTypesCache_ = lidAndLengths;
}
return lidAndLengths;
}
private void buildMddOverrides(java.util.ArrayList sdaOverrides) throws SqlException {
byte[] mddBytes;
for (int i = 0; i < sdaOverrides.size(); i++) {
mddBytes = (byte[]) (sdaOverrides.get(i));
writeBytes(mddBytes);
}
}
private int getNextOverrideLid() {
return overrideLid_++;
}
private void setFDODTALob(int securityMechanism,
Lob lob,
int[][] protocolTypesAndLengths,
int i)
throws SqlException, java.sql.SQLException{
if( lob.willBeLayerBStreamed() ) {
setFDODTALobLengthUnknown( i );
} else {
setFDODTALobLength(protocolTypesAndLengths,
i,
lob.length() );
}
}
}
The table below shows all metrics for NetStatementRequest.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 222.00 | Number of blocks | |
| BLOCK_COMMENT | 35.00 | Number of block comment lines | |
| COMMENTS | 430.00 | Comment lines | |
| COMMENT_DENSITY | 0.44 | Comment density | |
| COMPARISONS | 109.00 | Number of comparison operators | |
| CYCLOMATIC | 250.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 42.00 | Comments in declarations | |
| DOC_COMMENT | 5.00 | Number of javadoc comment lines | |
| ELOC | 987.00 | Effective lines of code | |
| EXEC_COMMENTS | 71.00 | Comments in executable code | |
| EXITS | 117.00 | Procedure exits | |
| FUNCTIONS | 52.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 154.07 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 322.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 1.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 0.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 2.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 31.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 1.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 33.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 8.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 0.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 5.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 7.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 4.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 1.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 0.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 13.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 3.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 4.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 6.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 1817.00 | Number of lines in the source file | |
| LINE_COMMENT | 390.00 | Number of line comments | |
| LOC | 1167.00 | Lines of code | |
| LOGICAL_LINES | 438.00 | Number of statements | |
| LOOPS | 7.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 2474.00 | Number of operands | |
| OPERATORS | 4791.00 | Number of operators | |
| PARAMS | 134.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 7265.00 | Halstead program length | |
| PROGRAM_VOCAB | 623.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 188.00 | Number of return points from functions | |
| SIZE | 84449.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 554.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 69.00 | Number of unique operators | |
| WHITESPACE | 220.00 | Number of whitespace lines | |