Introduce support for "Data Classification Specifications" on fetched resultsets#709
Conversation
… Classification support in the driver
Codecov Report
@@ Coverage Diff @@
## dev #709 +/- ##
============================================
- Coverage 48.09% 47.94% -0.15%
- Complexity 2623 2628 +5
============================================
Files 112 118 +6
Lines 26643 26753 +110
Branches 4477 4493 +16
============================================
+ Hits 12813 12827 +14
- Misses 11695 11802 +107
+ Partials 2135 2124 -11
Continue to review full report at Codecov.
|
| @@ -0,0 +1,20 @@ | |||
| package com.microsoft.sqlserver.jdbc; | |||
There was a problem hiding this comment.
InformationType and Label classes are exactly the same. Please also make sure the class names are descriptive.
There was a problem hiding this comment.
We cannot rename classes, as they are as per design specs.
On the other hand, I think it would be better to move all these new classes to dataclassification package so that customers would relate Label and InformationType classes to data classification information and not mix with other driver classes.
Other drivers have implemented differently with all classes defined in a common class DataClassification , but in Java we shall do in separate individual classes as they are public APIs.
| public String getId() { | ||
| return id; | ||
| } | ||
| } No newline at end of file |
There was a problem hiding this comment.
Please add a new line to the end of the file.
| } | ||
|
|
||
| public String getName() { | ||
| return name; |
|
|
||
| if (write) { | ||
| // Write Feature ID, length of the version# field and Sensitivity Classification Version# | ||
| tdsWriter.writeByte((byte) TDS.TDS_FEATUREEXT_DATACLASSIFICATION); |
There was a problem hiding this comment.
Let's declare TDS_FEATUREEXT_DATACLASSIFICATION as a byte instead.
There was a problem hiding this comment.
Cannot change it right away, as while reading token, featureId is compared in int type, as you can see here. If it will be changed for one, it will be changed for others too and need to see its impact on the driver behavior.
There was a problem hiding this comment.
featureID is a byte too, it should not be int at the first place.
| // 0x06 is for x_eFeatureExtensionId_LoginToken | ||
| // 0x07 is for x_eFeatureExtensionId_ClientSideTelemetry | ||
| // Data Classification constants | ||
| static final int TDS_FEATUREEXT_DATACLASSIFICATION = 0x09; |
There was a problem hiding this comment.
Can we keep/make the naming consistent? There are 3 more similar constants:
TDS_FEATURE_EXT_AE, TDS_FEATURE_EXT_FEDAUTH, TDS_FEATURE_EXTSION_ACK. I would suggest using TDS_FEATURE_EXT for all of them.
There was a problem hiding this comment.
I would not rename others, but would make the one I added TDS_FEATURE_EXT_DATACLASSIFICATION
| * @throws SQLException | ||
| */ | ||
| private void dropTable(Statement stmt) throws SQLException { | ||
| stmt.execute("DROP TABLE " + tableName); |
There was a problem hiding this comment.
Please use Utils.dropTableIfExists() instead.
| private final byte valueBytes[] = new byte[256]; | ||
| private static final AtomicInteger lastReaderID = new AtomicInteger(0); | ||
|
|
||
| protected SensitivityClassification sensitivityClassification; |
| throw new SQLServerException(this, SQLServerException.getErrString("R_AE_NotSupportedByServer"), null, 0, false); | ||
| } | ||
|
|
||
| boolean TrySetSensitivityClassification(SensitivityClassification sensitivityClassification) { |
There was a problem hiding this comment.
method names should start with a lowercase
There was a problem hiding this comment.
Kept it consistent with other feature methods, will better rename all such methods.
| return totalLen; | ||
| } | ||
|
|
||
| int writeDataClassificationFeatureRequest (boolean write /* if false just calculates the length */, |
There was a problem hiding this comment.
I'd put the protected keyword here explicitly to maintain consistency throughout the file.
There was a problem hiding this comment.
Similar feature request methods - writeAEFeatureRequest and writeFedAuthFeatureRequest are not protected too, hence kept like that.
| throw new SQLServerException(SQLServerException.getErrString("R_InvalidDataClsTokenNumber"), null); | ||
| } | ||
|
|
||
| if (data.length != 2) { |
There was a problem hiding this comment.
Do we need to check 1 > data.length and data.length != 2 separately?
There was a problem hiding this comment.
Didn't want to change the way/sequence we check for this token, exact same way is done for AE feature as well as in .NET driver.
| {"R_cancelQueryTimeoutPropertyDescription", "The number of seconds to wait to cancel sending a query timeout."}, | ||
| {"R_invalidCancelQueryTimeout", "The cancel timeout value {0} is not valid."}, | ||
| {"R_UnknownDataClsTokenNumber","Unknown token for Data Classification."}, // From Server | ||
| {"R_InvalidDataClsVersionNumber","Invalid version number {0} for Data Classification."}, // From Server |
There was a problem hiding this comment.
where is R_InvalidDataClsVersionNumber being used? I don't see it in our code.
There was a problem hiding this comment.
oh yeah, also add a space between the comma and the description part
| * @param Statement | ||
| * @return boolean | ||
| */ | ||
| private boolean serverSupportsDataClassification(Statement stmt) { |
There was a problem hiding this comment.
Can we move this to Utils class?
| // get the information type count | ||
| int numInformationTypes = tdsReader.readUnsignedShort(); | ||
|
|
||
| List<InformationType> informationTypes = new ArrayList<InformationType>(numInformationTypes); |
There was a problem hiding this comment.
I think we should generally use LinkedLists over ArrayLists, seeing how little we do random access compared to iteration. Also new ArrayList<InformationType> is repetitive, the compiler will infer the template type if we just use new ArrayList<>.
| byte enabled = data[1]; | ||
| serverSupportsDataClassification = (enabled == 0) ? false : true; | ||
| break; | ||
| } |
There was a problem hiding this comment.
is it just me or the spacing is all off in this method?
| throw new SQLServerException(SQLServerException.getErrString("R_InvalidDataClsVersionNumber"), null); | ||
| } | ||
|
|
||
| if (data.length != 2) { |
There was a problem hiding this comment.
can we keep this consistent? above is (1> data.length) etc..
| throw new SQLServerException(SQLServerException.getErrString("R_UnknownDataClsTokenNumber"), null); | ||
| } | ||
|
|
||
| byte enabled = data[1]; |
There was a problem hiding this comment.
this variable seem unnecessary?
There was a problem hiding this comment.
used in the next line. It basically tells us is the Feature_Ack enabled and TDS packets will be available in stream
There was a problem hiding this comment.
I mean, it's only used once in the next line, seems unnecessary to define a variable for it...no biggie tho..
| // Check for Error 208: Invalid Object Name | ||
| if (e.getErrorCode() == 208) { | ||
| return false; | ||
| } |
There was a problem hiding this comment.
what happens if this fails and it's not error 208?
There was a problem hiding this comment.
It would return true
There was a problem hiding this comment.
right, missed that ;)
| static final int TDS_DONEPROC = 0xFE; | ||
| static final int TDS_DONEINPROC = 0xFF; | ||
| static final int TDS_FEDAUTHINFO = 0xEE; | ||
| static final int TDS_SQLRESCOLSRCS = 0xa2; |
There was a problem hiding this comment.
TDS_SQLRESCOLSRCS is not used anywhere
| @@ -0,0 +1,134 @@ | |||
| package com.microsoft.sqlserver.jdbc.resultset; | |||
There was a problem hiding this comment.
Please add the license header.
| // 0x07 is for x_eFeatureExtensionId_ClientSideTelemetry | ||
| // Data Classification constants | ||
| static final byte TDS_FEATURE_EXT_DATACLASSIFICATION = 0x09; | ||
| static final byte DATA_CLASSIFICATION_NOT_ENABLED = 0x00; |
There was a problem hiding this comment.
DATA_CLASSIFICATION_NOT_ENABLED is not used anywhere.
|
|
||
| protected SensitivityClassification sensitivityClassification; | ||
|
|
||
| private static final AtomicInteger lastReaderID = new AtomicInteger(0); |
There was a problem hiding this comment.
Please apply the formatter to your changes.
|
|
||
| boolean trySetSensitivityClassification(SensitivityClassification sensitivityClassification) { | ||
| this.sensitivityClassification = sensitivityClassification; | ||
| return true; |
There was a problem hiding this comment.
Why does this method return boolean? return true makes no sense.
| connectionlogger.fine(toString() + " Received feature extension acknowledgement for Data Classification."); | ||
| } | ||
|
|
||
| if (1 > data.length) { |
There was a problem hiding this comment.
Please remove this block and move if (data.length != 2) before if ((0 == supportedDataClassificationVersion) || (supportedDataClassificationVersion > TDS.MAX_SUPPORTED_DATA_CLASSIFICATION_VERSION)).
| static final int DRIVER_ERROR_INTERMITTENT_TLS_FAILED = 7; | ||
| static final int ERROR_SOCKET_TIMEOUT = 8; | ||
| static final int ERROR_QUERY_TIMEOUT = 9; | ||
| static final int DataClassificationInvalidVersion = 24; |
There was a problem hiding this comment.
Is there a reason why you specified the error codes but didn't use any of them? You could use DataClassificationInvalidVersion with throw new SQLServerException(SQLServerException.getErrString("R_InvalidDataClsVersionNumber"), null); for example.
I think there is actually no need for these error codes in JDBC driver.
There was a problem hiding this comment.
The code is ported from .NET driver as such, tokens and error codes not used here are not used in ADO driver too, but may be used in future expansion of this feature. I let them stay as such as they will be useful to track changes in future in comparison to ADO changes.
There was a problem hiding this comment.
Does 24 have a special meaning or this was just 24th error code in .Net driver? If that's the case, we shouldn't jump from 9 to 24.
Please also keep the naming consistent with other error codes.
| @@ -0,0 +1,16 @@ | |||
| package com.microsoft.sqlserver.jdbc.dataclassification; | |||
There was a problem hiding this comment.
Please add license headers too all new files.
| } | ||
|
|
||
| TDSTokenHandler(String logContext) { | ||
| TDSTokenHandler(String logContext) { |
| * | ||
| * @param connection | ||
| * @param stmt | ||
| * @param tableName |
| @@ -0,0 +1,134 @@ | |||
| package com.microsoft.sqlserver.jdbc.resultset; | |||
|
|
|||
| import java.sql.Connection; | |||
There was a problem hiding this comment.
Already applied - I don't see any change on doing again
| * Selects data from the table and triggers verifySensitivityClassification method | ||
| * | ||
| * @param stmt | ||
| * @param queries |
29e33c5
* 623 fix * 623 change stash * Prepared Statement Caching fix for 'handle not found' errors * Fix for PS Caching issue - Calling reset instead of on type def changes * Updated comparison * Change back assert check. * Adding call to removeReference back + Fix for Batch processes intermittent failures. * Removed DBName and made changes to resetPrepStmtHandle method * Check for null handle before proceed * Adding Old Constrcutor back to AKV Implementation * Making baseURL final * Remove unnecessary code. * Use Bulk Copy API for batch insert operation * Parse bug fixing and test added * bug fix + additional tests * change reflection for testing * more test changes * Add parsing logic for -- comment * refactoring * Update snapshot * Bug fix / testing change * Reflect comment change * Feature | AKV Old Constructor changes - Reformatted code + Deprecated old Constructor and added a new constructor with 1 param * Mark computed columns as IS_GENERATEDCOLUMN in the result set returned by getColumns() (#695) * Fix | getColumns() API, changed column name from SS_IS_COMPUTED to IS_AUTOINCREMENT per JDBC specs | issue #600 * Fix | getColumns() API, changed column name from SS_IS_COMPUTED to IS_GENERATEDCOLUMN per JDBC specs | issue #600 * fix issue with redirection * Fix | PS Caching - Remove commented lines * Trigger Appveyor test * Fix | AKV Old Constructor - Calling the other constructor instead. * Fix | Reversed null checks * Resolving alignment problems and comments * Refactor two Bulk files into a common parent * javadoc changes * Applied formatter * fix problem with precision / scale * Fix | Fix some of the Javadoc warnings (#702) * fix issue with setting all to true * Resolved maven build warnings and java warnings regarding deprecated API (#701) * Resolving maven warnings * Removing jreVersion property Does not make sense now that we use final name in the build itself. Only used in 1 place, hard-coding java version for different builds as that's what it represents anyways. * java warnings * make bamoo fixes * resource bundle for junit test error strings (#698) resource bundle for error message strings in junit tests * undo some changes made to SQLServerConnection * apply resource bundling changes * Add support for JDK 10 in both Maven and Gradle (#691) * Feature | Added support for JDK 10 in both Maven and Gradle - builds jre10 jars for the driver, replacing jre9 * JDK 10 | Merge 42 classes to base classes to reduce class redundancy. * JDK 10 | Attempt to run JDK 10 with Appveyor * Remove unwanted space * Updating Travis script to use JDK 10 * Testing without addons * Update script for Jacoco report to build 43 profile * Revert driver changes for 42 compliance - to be added in a separate PR * Revert Test class changes for 42 compliance - to be done in a separate PR * Reformatted code * Add ID to jacoco plugin execution task * Kerberos Constrained Delegation Impersonated Credential Expiry fix (#636) fix for automatic credential discarding * update felix to 3.5.0 * Revised implementation Decided to not dispose user created credentials at all. * Updated flag set location * changes for 6.5.3 preview release * Revert "changes for 6.5.3 preview release" This reverts commit 5c6ccd3. * Changes in preparation for 6.5.3 preview release (#710) * changes for preview release * requested changes * jre version update changes * snapshot updates post release * remove on_dw, and remove redundant fmtonly * formatting * fix for getSchema when using "-" in name * Reformatting + adding more tests * inherit the connection property in statement + fix issue with null / empty string being passed in as values * Request Boundary methods - beginRequest()/endRequest() implementation (#708) * Add | Request Boundary Methods - beginRequest()/endRequest() implementation * Fix | Remove unused import from AbstractTest * Fix | Applying review comments * Fix | Moving RequestBoundaryMethodsTest.java to connection package * added error message in resource file and changed files accordingly * comment revisions * use TestResource * test changes removed finals removed database creation tracking * drop database before creating * replaced dropDBIfExists with Utils function * added try-with-resources nest avoid manually closing statements, and safetly handles resources. * Fixing logic / adding more tests * dont use test database in tests * Change exception handling as per JDBC specs * Add | Add missing license headers (#725) * remove some comments * Enable verify data (#724) Fix to enable data verification in Junit tests. Also addresses intermittent failures with Time/Timestamp where the precision was being inaccurately judged. * Fix | Refactored socket creation to simplify handling of socket creation Refactors socket creation in SocketFinder.findSocket(...) to simplify handling of socket creation. When the host resolves to a single address the driver now defers to getConnectedSocket(...) to create the socket without spawning any threads. This happens regardless of whether we're running on an IBM JDK. Previously the single address case would still use NIO on an IBM JDK. On non-IBM JDKs the driver now handles both IPv4 and IPv6 addresses concurrently with a single shared timeout. Previously hosts that resolved to both types of addresses were allowed half the timeout for socket creation per address type with the resolution performed sequentially. * reflect comments * Add support for UTF-8 feature extension. (#722) * Add | Support for UTF8 changes * changed how logger works, refactored code in SQLServerBulkCommon due to that, changed exception being thrown to BatchUpdateException, added same logic for parsing in executeLargeBatch, and added tests accordingly. * add more tests, make the prepared statement property go away * Feature | Introduce support for "Data Classification Specifications" on fetched resultsets (#709) * Feature | Data Classification Project | Phase 1 (contains temporary skipping 2 bytes) * Feature | Data Classification - Removing extra bytes added before * Feature | Data Classification - Added new test class for testing Data Classification support in the driver * Remove one println * Feature | Repackaged newly added files for Data Classification + improvements in source code * Feature | Changing tokens to bytes instead of int * Feature | Making variables private * Formatted code + dropTable method called from Utils * Feature | Data Classification - Changes as per review comments * Fix | Review comment changes * Change exception codes to follow series * Fix Conflict issue * Added missing Javadocs and headers for all new files * Added getter/setter public for the useBulkCopyForBatchInsert connection property. * Change implementation of child classes a bit * Remove dependencies from tests that are from outside required libraries * also remove hex from DBTable * Fix bamboo problem + refactor test code * Replace all connection and statements with try blocks * change spacing * refactor code * refactoring * Fix | Making driver default compliant to JDBC 4.2 Specs and update ADAL4J dependency to 1.6.0 (#711) * Feature | Added support for JDK 10 in both Maven and Gradle - builds jre10 jars for the driver, replacing jre9 * JDK 10 | Merge 42 classes to base classes to reduce class redundancy. * JDK 10 | Attempt to run JDK 10 with Appveyor * Remove unwanted space * Updating Travis script to use JDK 10 * Testing without addons * Update script for Jacoco report to build 43 profile * Minor fix in formatting to avoid conflicts * moving driver specific functions for SQLServerPreparedStatement * Remove unwanted code + Update Adal4J library dependency * changes for CallableStatement repeptitive delcarations * Remove an extra bracket due to conflict * changes for ISQLServerConnection there are problems with moving all Driver sepcific public methods. SQLServerConnectionPoolProxy also implements this interface and there are many public APIs (such as preparedstmt cacheing stuff) which it doesn't implement, and cannot be moved into the interface at this time. * lambda touch-up should generally stick to 1 line if possible. * changes for ISQLServerDataSource * updates for ISQLServerResultSet * Improvements | Missing interface APIs added + Code improvements * More changes for Interface missing methods * Implemented missing methods in SQLServerConnectionPoolProxy * Removed ISQLServerConnection43 for duplicated method definitions * Added APIs in interface for SQLServerResultSet * More cleanup done * Fix minor issues * Fix test failures and implement Serialization for HashKey * Fix JavaDoc errors and warnigs * More changes for CallableStatement APIs * More changes for Statement and Prepared Statament public APIs * Javadoc fix * More changes for SQL Server Bulk Record interface * Callable Statement missing APIs for Interface * Add missing desciptions * Reverting pom.xml change for this PR * Attempt to resolve conflicts * Remove Interface as not needed. * Added missing docs * Changes for Clob/Blob classes for compliance * Update ADAL4J with latest version * Changes for Data Source classes * Minor fixes to the new changes * Fix for failing tests * More changes for compliance * Add Javadocs and class headers * Fixed Malformed HTML Error in Javadocs * javadoc changes * more javadoc changes to make the abbreviations more clear * fix unchecked warning issue * Change HashKey in the driver to 256 Hash * Add Interface back to SQLServerConnection43 class * Revert "Change HashKey in the driver to 256 Hash" This reverts commit e6bef4e. * Changes for exceptions to throw SQLServerException type * 6.5.4 preview release changelog (#731) Release | Changelog for 6.5.4 preview release (#731) * Fix Conflict issues with master branch
This PR introduces new APIs that provide support and read Data Sensitivity Classification information from SQL Server.
This feature will be available/functional from new versions of SQL Servers (from 2018). For older versions of SQL Server, request for Data Classification Feature-Ack will be a No-Op.