From ed9a9b27290246628549019bf48cf40a1b9baf94 Mon Sep 17 00:00:00 2001 From: George Feinberg <39782661+gmfeinberg@users.noreply.github.com> Date: Tue, 4 May 2021 10:22:00 -0400 Subject: [PATCH 1/3] Fix javadoc in NoSQLHandleConfig, modify format in CHANGELOG.md to conform to keepachangelog. --- CHANGELOG.md | 25 ++++++++++++------- .../nosql/driver/NoSQLHandleConfig.java | 15 +++++------ 2 files changed, 22 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7eefd187..114a0685 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,8 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/). -## Unpublished +## [Unreleased] + ### Added - Cloud only: - Added new new SignatureProvider constructors to allow use of an instance principal with delegation token in a file for authorization and authentication. @@ -30,8 +31,14 @@ password - Fixed a problem where the cloud service might succeed when dropping a table that does not exist without using "drop table if exists" when it should throw TableNotFoundException +- Fixed javadoc for NoSQLHandleConfig.setTableRequestTimeout to remove incorrect statement +- Unhide NoSQLHandleConfig methods to deal with an HTTP proxy + - setProxyHost + - setProxyPort + - setProxyUsername + - setProxyPassword -## 5.2.26 - 2021-02-09 +## [5.2.26] - 2021-02-09 ### Changed - Updated copyrights to 2021 @@ -42,7 +49,7 @@ current documentation ### Fixed - Description for the SDK in the pom file is now correct -## 5.2.25 - 2020-12-11 +## [5.2.25] - 2020-12-11 ### Added - Rate Limiting (cloud only): @@ -74,7 +81,7 @@ thread, interfering with process exit - DefaultRetryHandler now uses incremental backoff mechanism (instead of fixed 1-second delay) and may be extended. - Updated examples to use doTableRequest() instead of tableRequest() followed by waitForCompletion(). -## 5.2.19 - 2020-09-17 +## [5.2.19] - 2020-09-17 ### Added - Added NoSQLHandleConfig.get/setMaxContentLength() to allow on-premise @@ -83,7 +90,7 @@ configuration of a maximum request/response size. It defaults to 32MB. ### Fixed - Added missing README.md file to release -## 5.2.17 - 2020-08-14 +## [5.2.17] - 2020-08-14 ### Added - Added NoSQLHandleConfig.setSSLProtocols() to allow the user to configure preferred SSL protocol @@ -122,7 +129,7 @@ cases. This prevented use of an intermediate proxy such as Nginx, which validate - TableUsageRequest: added validation check that startTime, endTime and limit must not be negative value. -## 5.2.11 - 2020-02-10 +## [5.2.11] - 2020-02-10 ### Added - OCI Native support for the cloud service @@ -135,14 +142,14 @@ must not be negative value. ### Removed - Removed support for IDCS based security in the cloud service -## 5.1.15 - 2019-11-18 +## [5.1.15] - 2019-11-18 ### Changed - Enabled SSL hostname verification - Reduced logging severityof bad http channels - Bundle newer versions of netty and Jackson libraries -## 5.1.12 - 2019-08-20 +## [5.1.12] - 2019-08-20 ### Fixed - Modified MapValue and handling of GetResult and QueryResult to maintain declaration order for fields. For queries, this is the order in which they are selected. For rows it is the declaration order from the initial table creation. @@ -177,6 +184,6 @@ exact schema match is required on a put. The default behavior is false. some operations, classes and exceptions are specific to each environment. These are noted in updated javadoc. -## 18.277 - 2018-10-04 +## [18.277] - 2018-10-04 This was the initial release of the Java driver for the Oracle NoSQL Database Cloud Service. diff --git a/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java b/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java index 08b3c52f..1897e9c6 100644 --- a/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java +++ b/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java @@ -581,8 +581,8 @@ public NoSQLHandleConfig setRequestTimeout(int timeout) { } /** - * Sets the default table request timeout. The default timeout is - * 5 seconds. The table request timeout can be specified independently + * Sets the default table request timeout. + * The table request timeout can be specified independently * of that specified by {@link #setRequestTimeout} because table requests can * take longer and justify longer timeouts. The default timeout is 10 * seconds (10000 milliseconds). @@ -1065,7 +1065,6 @@ public NoSQLHandleConfig setSSLSessionTimeout(int timeout) { } /** - * @hidden * Sets an HTTP proxy host to be used for the session. If a proxy host * is specified a proxy port must also be specified, using * {@link #setProxyPort}. @@ -1080,10 +1079,10 @@ public NoSQLHandleConfig setProxyHost(String proxyHost) { } /** - * @hidden * Sets an HTTP proxy user name if the configured proxy host requires * authentication. If a proxy host is not configured this configuration - * is ignored. + * is ignored. If a proxy user name is configure a proxy password must + * also be configured, using {@link #setProxyPassword}. * * @param proxyUsername the user name * @@ -1095,10 +1094,9 @@ public NoSQLHandleConfig setProxyUsername(String proxyUsername) { } /** - * @hidden * Sets an HTTP proxy password if the configured proxy host requires - * authentication. If a proxy user name is not configured this configuration - * is ignored. + * authentication. If a proxy password is configured a proxy user name + * must also be configured using {@link #setProxyUsername}. * * @param proxyPassword the password * @@ -1110,7 +1108,6 @@ public NoSQLHandleConfig setProxyPassword(String proxyPassword) { } /** - * @hidden * Sets an HTTP proxy port to be used for the session. If a proxy port * is specified a proxy host must also be specified, using * {@link #setProxyHost}. From 68c0b0360e2be8c50e1760251b278d5ae3ac5b61 Mon Sep 17 00:00:00 2001 From: George Feinberg <39782661+gmfeinberg@users.noreply.github.com> Date: Tue, 4 May 2021 11:59:17 -0400 Subject: [PATCH 2/3] Update CHANGELOG.md Fix typo --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 114a0685..902dd9cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). ### Added - Cloud only: - - Added new new SignatureProvider constructors to allow use of an instance principal with delegation token in a file for authorization and authentication. + - Added new SignatureProvider constructors to allow use of an instance principal with delegation token in a file for authorization and authentication. - SignatureProvider.createInstancePrincipalForDelegation(File delegationTokenFile) - SignatureProvider.createInstancePrincipalForDelegation(String iamAuthUri, Region region, File delegationTokenFile, Logger logger) - Added is* methods on FieldValue for convenience checking of whether an instance is From 2337a637e4bc46ef3f9eb9c1affe4d64c53b634a Mon Sep 17 00:00:00 2001 From: George Feinberg <39782661+gmfeinberg@users.noreply.github.com> Date: Tue, 4 May 2021 13:41:58 -0400 Subject: [PATCH 3/3] Fix Eclipse warning --- driver/src/main/java/oracle/nosql/driver/ops/TableResult.java | 1 - 1 file changed, 1 deletion(-) diff --git a/driver/src/main/java/oracle/nosql/driver/ops/TableResult.java b/driver/src/main/java/oracle/nosql/driver/ops/TableResult.java index 75cc0b38..732259d4 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/TableResult.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/TableResult.java @@ -10,7 +10,6 @@ import oracle.nosql.driver.NoSQLException; import oracle.nosql.driver.NoSQLHandle; import oracle.nosql.driver.RequestTimeoutException; -import oracle.nosql.driver.TableNotFoundException; /** * TableResult is returned from {@link NoSQLHandle#getTable} and