Merge branch 'main' into main

Author: mikebrey

CHANGELOG.md

@@ -2,6 +2,67 @@
 All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## [5.4.8] 2023-01-05
+
+### Fixed
+- Cloud only: Fixed an issue where a long running application using SignatureProvider
+ with instance principal may encounter NotAuthenticated error after several minutes even
+ if authentication succeeds for the first requests.
+
+### Changed
+- Updated copyrights to 2023
+
+## [5.4.7] 2022-12-06
+
+Note: there are no 5.4 releases before 5.4.7
+
+### Added
+- Support for new, flexible wire protocol (V4) has been added. The previous protocol
+is still supported for communication with servers that do not yet support V4. The
+version negotation is internal and automatic; however, use of V4 features will fail
+at runtime when attempted with an older server. Failure may be an empty or
+undefined result or an exception if the request cannot be serviced at all. The following
+new features or interfaces depend on the new protocol version
+ - added set/getDurability to QueryRequest for queries that modify data
+ - added pagination information to TableUsageResult and TableUsageRequest
+ - added shard percent usage information to TableUsageResult
+ - added IndexInfo.getFieldTypes to return the type information on an index on a JSON
+field
+ - added the ability to ask for and receive the schema of a query using
+     * PrepareRequest.setGetQuerySchema
+     * PreparedStatement.getQuerySchema
+ - Cloud only: added use of ETags, DefinedTags and FreeFormTags in TableRequest and TableResult
+ - Cloud only: Updated OCI regions (SGU, IFP)
+
+### Changed
+- Consistency is now a class and no longer a simple enumeration. Applications must
+be recompiled but source compatibility is maintained for all but the more complex
+use of an enumeration
+- Made one private serializer class public to allow for improved internal testing.
+- MapValue now implements Iterable
+
+## [5.3.7] 2022-10-18
+
+### Changed
+- Allow application to retry a QueryRequest if it gets a timeout exception and the query only does reads
+- Cloud only: Updated OCI regions (ORD, BGY, TIW, MXP, DUS, DTM, ORK, SNN)
+- Update netty dependency to 4.1.82.Final
+
+### Fixed
+- Cloud only: Fixed an issue where a long running application using SignatureProvider
+ with resource principal may encounter NotAuthenticated error after several minutes even
+ if authentication succeeds for the first requests.
+
+## [5.3.6] 2022-08-23
+
+### Added
+- Added support for parent/child tables usage in WriteMultiple requests.
+
+## [5.3.5] 2022-07-20
+
+### Added
+- Made one private serializer class public to allow for improved internal testing.
+
 ## [5.3.4] 2022-06-16
 
 NOTE: there was briefly a 5.3.3 release available on GitHub. This release is functionally
@@ -18,8 +79,6 @@ query that returns row_version() as a BinaryValue. The Version can be used for
 conditional put and delete operations
 - added support for setting an extension to the User Agent http header by
 setting the ExtensionUserAgent property on NoSQLHandlerConfig.
-
-### Changed
 - Cloud only: Added OCI regions: CDG (Paris), MAD (Madrid), QRO (Queretaro)
 
 ## [5.3.2] 2022-03-21
@@ -243,7 +302,7 @@ MapValue  instances created from JSON to maintain the insertion order of fields
 in the map so that iteration is predictable.
 
 ### Fixed
-- Don't validate request sizes. On-premise only
+- Don't validate request sizes. On-premises only
 - JsonOptions.setPrettyPrint(true) now works
 - Request timeouts now operate correctly on milliseconds instead of rounding up to seconds
 - Changed min/max implementation to make them deterministic
@@ -258,7 +317,7 @@ removed in a future version.
 - Fix another memory leak that could occur on the receive side when the response
 was discarded due to unmatched request Id.
 - Fixed a problem where the HTTP Host header was not being adding in all request
-cases. This prevented use of an intermediate proxy such as Nginx, which validates headers. On-premise only.
+cases. This prevented use of an intermediate proxy such as Nginx, which validates headers. On-premises only.
 - TableUsageRequest: added validation check that startTime, endTime and limit
 must not be negative value.
 
@@ -304,16 +363,16 @@ exact schema match is required on a put. The default behavior is false.
 - Added a new, simpler TableResult.waitForCompletion() interface to wait for the completion of a TableRequest vs waiting for a specific state.
 - Added NoSQLHandle.doTableRequest to encapsulate a TableRequest and waiting for
   its completion in a single, synchronous call.
-- Added OperationNotSupportedException to handle operations that are specific to on-premise and cloud service environments
+- Added OperationNotSupportedException to handle operations that are specific to on-premises and cloud service environments
 
-- Support for both the Oracle NoSQL Database Cloud Service and the on-premise Oracle NoSQL Database product.
-  - Added StoreAccessTokenProvider for authentication of access to an on-premise store
+- Support for both the Oracle NoSQL Database Cloud Service and the on-premises Oracle NoSQL Database product.
+  - Added StoreAccessTokenProvider for authentication of access to an on-premises store
   - Added AuthenticationException to encapsulate authentication problems when
-  accessing an on-premise store.
+  accessing an on-premises store.
   - Added SystemRequest, SystemStatusRequest, and SystemResult for administrative
   operations that are not table-specific.
   - Added NoSQLHandle.doSystemRequest to encapsulate a SystemRequest and waiting for its completion in a single, synchronous call.
-  -   Now that the driver can access both the cloud service and an on-premise store
+  -   Now that the driver can access both the cloud service and an on-premises store
   some operations, classes and exceptions are specific to each environment. These are
   noted in updated javadoc.
 

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016, 2022 Oracle and/or its affiliates. All rights reserved.
+Copyright (c) 2016, 2023 Oracle and/or its affiliates. All rights reserved.
 
 The Universal Permissive License (UPL), Version 1.0
 

README.md

@@ -37,7 +37,7 @@ project. The version changes with each release.
 <dependency>
   <groupId>com.oracle.nosql.sdk</groupId>
   <artifactId>nosqldriver</artifactId>
-  <version>5.3.2</version>
+  <version>5.4.8</version>
 </dependency>
 ```
 
@@ -117,7 +117,7 @@ See the Quickstart example below for code details for using a Resource Principal
 
 ### Connecting to the Oracle NoSQL Database On-premise
 
-The on-premise configuration requires a running instance of Oracle NoSQL
+The on-premises configuration requires a running instance of Oracle NoSQL
 Database. In addition a running proxy service is required. See
 [Oracle NoSQL Database Downloads](https://www.oracle.com/database/technologies/nosql-database-server-downloads.html) for downloads, and see
 [Information about the proxy](https://docs.oracle.com/en/database/other-databases/nosql-database/22.3/admin/proxy-and-driver.html)
@@ -130,6 +130,7 @@ See the Quickstart example below for code details for connecting on-premise.
 
 When you develop an application, you may wish to start with
 [Oracle NoSQL Database Cloud Simulator](https://www.oracle.com/downloads/cloud/nosql-cloud-sdk-downloads.html).
+
 The Cloud Simulator simulates the cloud service and lets you write and test
 applications locally without accessing the Oracle NoSQL Database Cloud Service.
 You may run the Cloud Simulator on localhost.
@@ -138,11 +139,16 @@ You may run the Cloud Simulator on localhost.
 Authorization for the Cloud Simulator is a simple no-op class implemented directly
 in the Quickstart example.
 
+## Logging
+
+Addional logging can be enabled using a java properties file. For full details, see
+"Logging in the SDK" at https://oracle.github.io/nosql-java-sdk/oracle/nosql/driver/package-summary.html
+
 ## Quickstart
 
 The following is a quick start tutorial to run a simple program in all supported
 environments. It requires access to the Oracle NoSQL Database Cloud Service,
-a running on-premise Oracle NoSQL Database instance, or a running Oracle
+a running on-premises Oracle NoSQL Database instance, or a running Oracle
 NoSQL Cloud Simulator instance. As a standalone program it will run most easily
 using a download version of the Oracle NoSQL SDK for Java.
 
@@ -159,7 +165,7 @@ Using the cloud service on region us-ashburn-1
 ```
 $ java -cp .:<path-to-nosqldriver.jar> Quickstart -service cloud -endpoint us-ashburn-1
 ```
-Using a non-secure on-premise service on endpoint http://localhost:8090
+Using a non-secure on-premises service on endpoint http://localhost:8090
 ```
 $ java -cp .:<path-to-nosqldriver.jar> Quickstart -service onprem -endpoint http://localhost:8090
 ```
@@ -175,7 +181,7 @@ is required if using Instance Principal or Resource Principal authorization.
 
 ```
 /*-
- * Copyright (c) 2019, 2022 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2019, 2023 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
  *  https://oss.oracle.com/licenses/upl/
@@ -218,7 +224,7 @@ import oracle.nosql.driver.values.MapValue;
  *
  * This program can be run against:
  *  1. the cloud service
- *  2. the on-premise proxy and Oracle NoSQL Database instance, secure or
+ *  2. the on-premises proxy and Oracle NoSQL Database instance, secure or
  *  not secure.
  *  3. the cloud simulator (CloudSim)
  *
@@ -505,7 +511,7 @@ $ mvn -pl examples exec:java -Dexec.mainClass=BasicTableExample \
   -Dexec.args="http://localhost:8080"
 ```
 
-Run BasicTableExample using an on-premise  instance on endpoint
+Run BasicTableExample using an on-premises instance on endpoint
 localhost:8090
 
 ```
@@ -552,7 +558,7 @@ The region argument will change depending on which region you use.
 
 #### Run using the Oracle NoSQL Database On-premise
 
-Running against the on-premise Oracle NoSQL Database on-premise requires
+Running against the on-premises Oracle NoSQL Database on-premises requires
 a running instance of the database and running proxy service. See above.
 
 Run against a not-secure proxy and store, with the proxy running on port 80:

build_spec.yaml

@@ -0,0 +1,22 @@
+# Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+
+version: 0.1
+component: build
+timeoutInSeconds: 1000
+shell: bash
+
+steps:
+  - type: Command
+    name: "compress the repo"
+    command: |
+      tar -cvzf ${OCI_WORKSPACE_DIR}/repo.tgz ./
+outputArtifacts:
+  - name: artifact
+    type: BINARY
+    location: ${OCI_WORKSPACE_DIR}/repo.tgz
+Footer
+© 2023 GitHub, Inc.
+Footer navigation
+Terms
+Privacy
+Security

driver/pom.xml

@@ -29,7 +29,7 @@
 
   <groupId>com.oracle.nosql.sdk</groupId>
   <artifactId>nosqldriver</artifactId>
-  <version>5.3.4</version>
+  <version>5.4.8</version>
   <packaging>jar</packaging>
 
   <organization>
@@ -43,11 +43,11 @@
     <maven.compiler.target>1.8</maven.compiler.target>
     <timestamp>${maven.build.timestamp}</timestamp>
     <maven.build.timestamp.format>d-MMMM-yyyy</maven.build.timestamp.format>
-    <copyright>Copyright (c) 2011, 2022 Oracle and/or its affiliates. All rights reserved.</copyright>
+    <copyright>Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.</copyright>
     <java.apidoc>http://docs.oracle.com/javase/8/docs/api</java.apidoc>
     <maven.deploy.skip>false</maven.deploy.skip>
-    <netty.version>4.1.77.Final</netty.version>
-    <jackson.version>2.12.5</jackson.version>
+    <netty.version>4.1.86.Final</netty.version>
+    <jackson.version>2.13.2</jackson.version>
     <bouncy.version>1.70</bouncy.version>
    <!-- by default, skip tests; tests require a profile -->
    <maven.test.skip>true</maven.test.skip>
@@ -57,7 +57,7 @@
   <profiles>
 
     <!-- test profiles used with the test target
-         Running tests requires a running on-premise service and httpproxy
+         Running tests requires a running on-premises service and httpproxy
          or a running cloud simulator. Required information:
             o endpoint
          Examples:
@@ -85,7 +85,7 @@
         <secure>false</secure>
         <onprem>false</onprem>
         <serverType>cloudsim</serverType>
-        <!-- exclude non-server tests and on-premise tests -->
+        <!-- exclude non-server tests and on-premises tests -->
         <excluded.tests>
           StoreAccessTokenProviderTest.java, ResourcePrincipalProviderTest.java,
           ConfigFileTest.java, SignatureProviderTest.java,
@@ -347,7 +347,7 @@
                May need to post-process the doc to remove the package and link.
           -->
           <excludePackageNames>
-            oracle.nosql.driver.http;oracle.nosql.driver.httpclient;oracle.nosql.driver.query;oracle.nosql.driver.util
+            oracle.nosql.driver.http;oracle.nosql.driver.httpclient;oracle.nosql.driver.query;oracle.nosql.driver.util;oracle.nosql.driver.ops.serde.nson
           </excludePackageNames>
           <stylesheetfile>${basedir}/../doc/style.css</stylesheetfile>
           <show>public</show>
@@ -413,6 +413,16 @@
         <artifactId>exec-maven-plugin</artifactId>
         <version>3.0.0</version>
         <executions>
+          <execution>
+            <id>human-readable NSON string generation</id>
+            <phase>generate-sources</phase>
+            <configuration>
+              <executable>${basedir}/scripts/build_nson_strings.sh</executable>
+            </configuration>
+            <goals>
+              <goal>exec</goal>
+            </goals>
+          </execution>
           <execution>
             <id>add license files to runtime jar</id>
             <phase>package</phase>

driver/scripts/build_nson_strings.sh

@@ -0,0 +1,50 @@
+#!/usr/bin/env bash
+
+# Copyright (C) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
+#
+# This file was distributed by Oracle as part of a version of Oracle NoSQL
+# Database made available at:
+#
+# http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
+#
+# Please see the LICENSE file included in the top-level directory of the
+# appropriate version of Oracle NoSQL Database for a copy of the license and
+# additional information.
+
+# this script creates java code to enable using human-readable strings for field
+# names in nson debug/logging/verbose output. It modifies NsonProtocol.java to
+# add a map of field names to human readable field names.
+
+PROTOCOL_FILE=src/main/java/oracle/nosql/driver/ops/serde/nson/NsonProtocol.java
+
+# delete everything after the last static string
+lastline=$(grep -n 'public static String [A-Z]' $PROTOCOL_FILE | tail -1 | sed -e 's/:.*$//')
+head -$lastline $PROTOCOL_FILE > /tmp/proto.$$
+
+# add a static array of string arrays
+grep 'public static String ' /tmp/proto.$$ | awk 'BEGIN{printf("\n    private static String[][] mapVals = new String[][] {\n");}{printf("        {%s,\"%s\"},\n",$4,$4);}END{printf("    };\n");}' >> /tmp/proto.$$
+
+# add remaining logic
+cat << EOT >> /tmp/proto.$$
+
+    private static HashMap<String, String> fieldMap = null;
+
+    public static String readable(String field) {
+        if (fieldMap == null) {
+            fieldMap = new HashMap<String, String>();
+            for (int x=0; x<mapVals.length; x++) {
+                fieldMap.put(mapVals[x][0], mapVals[x][1]);
+            }
+        }
+        String val = fieldMap.get(field);
+        if (val == null) {
+            return field;
+        }
+        return val;
+    }
+}
+EOT
+
+# replace file
+mv /tmp/proto.$$ $PROTOCOL_FILE
+

driver/src/main/java/oracle/nosql/driver/AuthorizationProvider.java

@@ -1,5 +1,5 @@
 /*-
- * Copyright (c) 2011, 2022 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
  *  https://oss.oracle.com/licenses/upl/

driver/src/main/java/oracle/nosql/driver/BatchOperationNumberLimitException.java

@@ -1,5 +1,5 @@
 /*-
- * Copyright (c) 2011, 2022 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2011, 2023 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Universal Permissive License v 1.0 as shown at
  *  https://oss.oracle.com/licenses/upl/