Skip to content

Commit 3af6695

Browse files
authored
Fix javadoc in NoSQLHandleConfig (#2)
* Fix javadoc in NoSQLHandleConfig, modify format in CHANGELOG.md to conform to keepachangelog. * Fix Eclipse warning
1 parent 5c872d3 commit 3af6695

File tree

3 files changed

+23
-20
lines changed

3 files changed

+23
-20
lines changed

CHANGELOG.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@ All notable changes to this project will be documented in this file.
33

44
The format is based on [Keep a Changelog](http://keepachangelog.com/).
55

6-
## Unpublished
6+
## [Unreleased]
7+
78
### Added
89
- Cloud only:
9-
- Added new new SignatureProvider constructors to allow use of an instance principal with delegation token in a file for authorization and authentication.
10+
- Added new SignatureProvider constructors to allow use of an instance principal with delegation token in a file for authorization and authentication.
1011
- SignatureProvider.createInstancePrincipalForDelegation(File delegationTokenFile)
1112
- SignatureProvider.createInstancePrincipalForDelegation(String iamAuthUri, Region region, File delegationTokenFile, Logger logger)
1213
- Added is* methods on FieldValue for convenience checking of whether an instance is
@@ -30,8 +31,14 @@ password
3031
- Fixed a problem where the cloud service might succeed when dropping a table
3132
that does not exist without using "drop table if exists" when it should throw
3233
TableNotFoundException
34+
- Fixed javadoc for NoSQLHandleConfig.setTableRequestTimeout to remove incorrect statement
35+
- Unhide NoSQLHandleConfig methods to deal with an HTTP proxy
36+
- setProxyHost
37+
- setProxyPort
38+
- setProxyUsername
39+
- setProxyPassword
3340

34-
## 5.2.26 - 2021-02-09
41+
## [5.2.26] - 2021-02-09
3542

3643
### Changed
3744
- Updated copyrights to 2021
@@ -42,7 +49,7 @@ current documentation
4249
### Fixed
4350
- Description for the SDK in the pom file is now correct
4451

45-
## 5.2.25 - 2020-12-11
52+
## [5.2.25] - 2020-12-11
4653

4754
### Added
4855
- Rate Limiting (cloud only):
@@ -74,7 +81,7 @@ thread, interfering with process exit
7481
- DefaultRetryHandler now uses incremental backoff mechanism (instead of fixed 1-second delay) and may be extended.
7582
- Updated examples to use doTableRequest() instead of tableRequest() followed by waitForCompletion().
7683

77-
## 5.2.19 - 2020-09-17
84+
## [5.2.19] - 2020-09-17
7885

7986
### Added
8087
- Added NoSQLHandleConfig.get/setMaxContentLength() to allow on-premise
@@ -83,7 +90,7 @@ configuration of a maximum request/response size. It defaults to 32MB.
8390
### Fixed
8491
- Added missing README.md file to release
8592

86-
## 5.2.17 - 2020-08-14
93+
## [5.2.17] - 2020-08-14
8794

8895
### Added
8996
- 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
122129
- TableUsageRequest: added validation check that startTime, endTime and limit
123130
must not be negative value.
124131

125-
## 5.2.11 - 2020-02-10
132+
## [5.2.11] - 2020-02-10
126133

127134
### Added
128135
- OCI Native support for the cloud service
@@ -135,14 +142,14 @@ must not be negative value.
135142
### Removed
136143
- Removed support for IDCS based security in the cloud service
137144

138-
## 5.1.15 - 2019-11-18
145+
## [5.1.15] - 2019-11-18
139146

140147
### Changed
141148
- Enabled SSL hostname verification
142149
- Reduced logging severityof bad http channels
143150
- Bundle newer versions of netty and Jackson libraries
144151

145-
## 5.1.12 - 2019-08-20
152+
## [5.1.12] - 2019-08-20
146153
### Fixed
147154
- 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.
148155

@@ -177,6 +184,6 @@ exact schema match is required on a put. The default behavior is false.
177184
some operations, classes and exceptions are specific to each environment. These are
178185
noted in updated javadoc.
179186

180-
## 18.277 - 2018-10-04
187+
## [18.277] - 2018-10-04
181188
This was the initial release of the Java driver for the Oracle NoSQL Database
182189
Cloud Service.

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

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -581,8 +581,8 @@ public NoSQLHandleConfig setRequestTimeout(int timeout) {
581581
}
582582

583583
/**
584-
* Sets the default table request timeout. The default timeout is
585-
* 5 seconds. The table request timeout can be specified independently
584+
* Sets the default table request timeout.
585+
* The table request timeout can be specified independently
586586
* of that specified by {@link #setRequestTimeout} because table requests can
587587
* take longer and justify longer timeouts. The default timeout is 10
588588
* seconds (10000 milliseconds).
@@ -1065,7 +1065,6 @@ public NoSQLHandleConfig setSSLSessionTimeout(int timeout) {
10651065
}
10661066

10671067
/**
1068-
* @hidden
10691068
* Sets an HTTP proxy host to be used for the session. If a proxy host
10701069
* is specified a proxy port must also be specified, using
10711070
* {@link #setProxyPort}.
@@ -1080,10 +1079,10 @@ public NoSQLHandleConfig setProxyHost(String proxyHost) {
10801079
}
10811080

10821081
/**
1083-
* @hidden
10841082
* Sets an HTTP proxy user name if the configured proxy host requires
10851083
* authentication. If a proxy host is not configured this configuration
1086-
* is ignored.
1084+
* is ignored. If a proxy user name is configure a proxy password must
1085+
* also be configured, using {@link #setProxyPassword}.
10871086
*
10881087
* @param proxyUsername the user name
10891088
*
@@ -1095,10 +1094,9 @@ public NoSQLHandleConfig setProxyUsername(String proxyUsername) {
10951094
}
10961095

10971096
/**
1098-
* @hidden
10991097
* Sets an HTTP proxy password if the configured proxy host requires
1100-
* authentication. If a proxy user name is not configured this configuration
1101-
* is ignored.
1098+
* authentication. If a proxy password is configured a proxy user name
1099+
* must also be configured using {@link #setProxyUsername}.
11021100
*
11031101
* @param proxyPassword the password
11041102
*
@@ -1110,7 +1108,6 @@ public NoSQLHandleConfig setProxyPassword(String proxyPassword) {
11101108
}
11111109

11121110
/**
1113-
* @hidden
11141111
* Sets an HTTP proxy port to be used for the session. If a proxy port
11151112
* is specified a proxy host must also be specified, using
11161113
* {@link #setProxyHost}.

driver/src/main/java/oracle/nosql/driver/ops/TableResult.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
import oracle.nosql.driver.NoSQLException;
1111
import oracle.nosql.driver.NoSQLHandle;
1212
import oracle.nosql.driver.RequestTimeoutException;
13-
import oracle.nosql.driver.TableNotFoundException;
1413

1514
/**
1615
* TableResult is returned from {@link NoSQLHandle#getTable} and

0 commit comments

Comments
 (0)