diff --git a/CHANGELOG.md b/CHANGELOG.md index 78b1b184..794606e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -302,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 @@ -317,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. @@ -363,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. diff --git a/README.md b/README.md index e0e4ed31..4447ed5f 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,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.1/admin/proxy-and-driver.html) @@ -149,7 +149,7 @@ Addional logging can be enabled using a java properties file. For full details, 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. @@ -166,7 +166,7 @@ Using the cloud service on region us-ashburn-1 ``` $ java -cp .: 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 .: Quickstart -service onprem -endpoint http://localhost:8090 ``` @@ -225,7 +225,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) * @@ -512,7 +512,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 ``` @@ -559,7 +559,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: diff --git a/driver/pom.xml b/driver/pom.xml index eb6544f0..641ee00c 100644 --- a/driver/pom.xml +++ b/driver/pom.xml @@ -57,7 +57,7 @@ + StoreAccessTokenProviderTest.java, ResourcePrincipalProviderTest.java, ConfigFileTest.java, SignatureProviderTest.java, diff --git a/driver/src/main/java/oracle/nosql/driver/NoSQLHandle.java b/driver/src/main/java/oracle/nosql/driver/NoSQLHandle.java index 4805217f..12724238 100644 --- a/driver/src/main/java/oracle/nosql/driver/NoSQLHandle.java +++ b/driver/src/main/java/oracle/nosql/driver/NoSQLHandle.java @@ -46,7 +46,7 @@ * information to be used by the handle. *

* The same interface is available to both users of the Oracle NoSQL Database - * Cloud Service and the on-premise Oracle NoSQL Database; however, some methods + * Cloud Service and the on-premises Oracle NoSQL Database; however, some methods * and/or parameters are specific to each environment. The documentation has notes * about whether a class, method, or parameter is environment-specific. Unless * otherwise noted they are applicable to both environments. @@ -280,12 +280,12 @@ public interface NoSQLHandle extends AutoCloseable { /** * Queries a table based on the query statement specified in the * {@link QueryRequest}. - * + *

* Queries that include a full shard key will execute much more efficiently * than more distributed queries that must go to multiple shards. *

* Table- and system-style queries such as "CREATE TABLE ..." or "DROP TABLE .." - * are not supported by this interfaces. Those operations must be performed using + * are not supported by this interface. Those operations must be performed using * {@link #tableRequest} or {@link #systemRequest} as appropriate. *

* The amount of data read by a single query request is limited by a system @@ -315,7 +315,7 @@ public interface NoSQLHandle extends AutoCloseable { /** * Queries a table based on the query statement specified in the * {@link QueryRequest} while returning an iterable result. - * + *

* Queries that include a full shard key will execute much more efficiently * than more distributed queries that must go to multiple shards. *

@@ -325,7 +325,7 @@ public interface NoSQLHandle extends AutoCloseable { * and not this method. *

* Table- and system-style queries such as "CREATE TABLE ..." or "DROP TABLE .." - * are not supported by this interfaces. Those operations must be performed using + * are not supported by this interface. Those operations must be performed using * {@link #tableRequest} or {@link #systemRequest} as appropriate. *

* The results are returned through an iterator, if connected to the @@ -428,7 +428,7 @@ TableResult doTableRequest(TableRequest request, int pollIntervalMs); /** - * On-premise only. + * On-premises only. *

* Performs a system operation on the system, such as * administrative operations that don't affect a specific table. For @@ -460,7 +460,7 @@ TableResult doTableRequest(TableRequest request, SystemResult systemRequest(SystemRequest request); /** - * On-premise only. + * On-premises only. *

* Checks the status of an operation previously performed using * {@link #systemRequest}. @@ -482,7 +482,7 @@ TableResult doTableRequest(TableRequest request, * state, provisioned throughput and capacity and schema. Dynamic * information such as usage is obtained using {@link #getTableUsage}. * Throughput, capacity and usage information is only available when using - * the Cloud Service and will be null or not defined on-premise. + * the Cloud Service and will be null or not defined on-premises. * * @param request the input parameters for the operation * @@ -556,7 +556,7 @@ TableResult doTableRequest(TableRequest request, GetIndexesResult getIndexes(GetIndexesRequest request); /** - * On-premise only. + * On-premises only. *

* Returns the namespaces in a store as an array of String. * @@ -565,8 +565,8 @@ TableResult doTableRequest(TableRequest request, String[] listNamespaces(); /** - * On-premise only. - * + * On-premises only. + *

* Returns the roles in a store as an array of String. * * @return the list of roles or null if none are found @@ -574,7 +574,7 @@ TableResult doTableRequest(TableRequest request, String[] listRoles(); /** - * On-premise only. + * On-premises only. *

* Returns the users in a store as an array of {@link UserInfo}. * @@ -583,7 +583,7 @@ TableResult doTableRequest(TableRequest request, UserInfo[] listUsers(); /** - * On-premise only. + * On-premises only. *

* A convenience method that performs a SystemRequest and waits for * completion of the operation. This is the same as calling {@link diff --git a/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java b/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java index 45a0df40..5a1b1531 100644 --- a/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java +++ b/driver/src/main/java/oracle/nosql/driver/NoSQLHandleConfig.java @@ -770,7 +770,7 @@ public NoSQLHandleConfig setPoolMaxPending(int poolMaxPending) { /** * Sets the maximum size in bytes of request/response payloads. - * On-premise only. This setting is ignored for cloud operations. + * On-premises only. This setting is ignored for cloud operations. * If not set, or set to zero, the default value of 32MB is used. * * @param maxContentLength the maximum bytes allowed in @@ -790,7 +790,7 @@ public NoSQLHandleConfig setMaxContentLength(int maxContentLength) { /** * Returns the maximum size, in bytes, of a request operation payload. - * On-premise only. This value is ignored for cloud operations. + * On-premises only. This value is ignored for cloud operations. * * @return the size */ diff --git a/driver/src/main/java/oracle/nosql/driver/Nson.java b/driver/src/main/java/oracle/nosql/driver/Nson.java index 78459874..fad8d50c 100644 --- a/driver/src/main/java/oracle/nosql/driver/Nson.java +++ b/driver/src/main/java/oracle/nosql/driver/Nson.java @@ -428,7 +428,7 @@ public static String toJsonString(ByteInputStream in) { * * @param in the input stream of NSON bytes * @param options {@link JsonOptions} to use for the serialization, or - * null for default behavior.Th + * null for default behavior * @return the JSON string * @throws IllegalArgumentException if there's a problem with serializing * NSON to JSON string diff --git a/driver/src/main/java/oracle/nosql/driver/OperationNotSupportedException.java b/driver/src/main/java/oracle/nosql/driver/OperationNotSupportedException.java index 3b5eaea5..51f67326 100644 --- a/driver/src/main/java/oracle/nosql/driver/OperationNotSupportedException.java +++ b/driver/src/main/java/oracle/nosql/driver/OperationNotSupportedException.java @@ -9,7 +9,7 @@ /** * The operation attempted is not supported. This may be related to - * on-premise vs cloud service configurations. + * on-premises vs cloud service configurations. */ public class OperationNotSupportedException extends NoSQLException { diff --git a/driver/src/main/java/oracle/nosql/driver/UserInfo.java b/driver/src/main/java/oracle/nosql/driver/UserInfo.java index 2f5f9ee0..233919a7 100644 --- a/driver/src/main/java/oracle/nosql/driver/UserInfo.java +++ b/driver/src/main/java/oracle/nosql/driver/UserInfo.java @@ -8,7 +8,7 @@ package oracle.nosql.driver; /** - * On-premise only. + * On-premises only. *

* A class that encapsulates the information associated with a user including * the id and user name in the system. diff --git a/driver/src/main/java/oracle/nosql/driver/http/Client.java b/driver/src/main/java/oracle/nosql/driver/http/Client.java index 700d1c91..7f9590fc 100644 --- a/driver/src/main/java/oracle/nosql/driver/http/Client.java +++ b/driver/src/main/java/oracle/nosql/driver/http/Client.java @@ -333,13 +333,15 @@ private int nextRequestId() { /** * Execute the KV request and return the response. This is the top-level * method for request execution. - * + *

* This method handles exceptions to distinguish between what can be retried - * what what cannot, making sure that root cause exceptions are + * and what cannot, making sure that root cause exceptions are * kept. Examples: - * o can't connect (host, port, etc) - * o throttling exceptions - * o general networking issues, IOException + *

    + *
  • can't connect (host, port, etc)
  • + *
  • throttling exceptions
  • + *
  • general networking issues, IOException
  • + *
* * RequestTimeoutException needs a cause, or at least needs to include the * message from the causing exception. @@ -576,7 +578,7 @@ public Result execute(Request kvRequest) { serialVersionUsed = writeContent(buffer, kvRequest); /* - * If on-premise the authProvider will always be a + * If on-premises the authProvider will always be a * StoreAccessTokenProvider. If so, check against * configurable limit. Otherwise check against internal * hardcoded cloud limit. @@ -948,7 +950,7 @@ private RateLimiter getQueryRateLimiter(Request request, boolean read) { } /** - * Comsume rate limiter units after successful operation. + * Consume rate limiter units after successful operation. * @return the number of milliseconds delayed due to rate limiting */ private int consumeLimiterUnits(RateLimiter rl, @@ -961,7 +963,7 @@ private int consumeLimiterUnits(RateLimiter rl, /* * The logic consumes units (and potentially delays) _after_ a * successful operation for a couple reasons: - * 1) We don't know the actual number of units an op uses unitl + * 1) We don't know the actual number of units an op uses until * after the operation successfully finishes * 2) Delaying after the op keeps the application from immediately * trying the next op and ending up waiting along with other @@ -1105,7 +1107,7 @@ final Result processResponse(HttpResponseStatus status, * * @return the result of processing the successful request * - * @throws IOException if the stream could not be read for some reason + * @throws NoSQLException if the stream could not be read for some reason */ Result processOKResponse(ByteInputStream in, Request kvRequest) { try { @@ -1547,9 +1549,9 @@ void doRefresh(long refreshMs) { /** * Look for the compartment,table combination in the list. If * present, do nothing. If not, add that combination to the list. - * This is not particular efficient but it is not expected that a given + * This is not particularly efficient but it is not expected that a given * handle will be accessing a large number of tables. - * + *

* The operation type is not checked -- all 3 types of requests are created * no matter the access. This simplifies the logic and if a given type is * not given to this Principal it doesn't hurt. diff --git a/driver/src/main/java/oracle/nosql/driver/httpclient/HttpClient.java b/driver/src/main/java/oracle/nosql/driver/httpclient/HttpClient.java index 06d90c91..7752a8ac 100644 --- a/driver/src/main/java/oracle/nosql/driver/httpclient/HttpClient.java +++ b/driver/src/main/java/oracle/nosql/driver/httpclient/HttpClient.java @@ -36,28 +36,30 @@ import io.netty.util.concurrent.Future; /* * If this code is ever made generic, the proxy information obtained - * from this config needs to be be abstracted to a generic class. + * from this config needs to be abstracted to a generic class. */ import oracle.nosql.driver.NoSQLHandleConfig; /** * Netty HTTP client. Initialization process: - * - * 1. create event loop for handling connections and requests. Assign it - * a number of threads. - * 2. bootstrap a client, setting the event loop group, socket options, and - * remote address. - * 3. create a ChannelPoolHandler instance to handle callback events from + *

+ *

    + *
  1. create event loop for handling connections and requests. Assign it + * a number of threads.
  2. + *
  3. bootstrap a client, setting the event loop group, socket options, and + * remote address.
  4. + *
  5. create a ChannelPoolHandler instance to handle callback events from * a ChannelPool. The pool is used to allow the client to create new * connections on demand if one is busy. HTTP/1.1 doesn't allow concurrent * use of a single connection. This handler must be prepared to initialize - * each new connection on creation. - * 4. create a ChannelPool instance used to acquire and release channels for - * use by requests. - * + * each new connection on creation.
  6. + *
  7. create a ChannelPool instance used to acquire and release channels for + * use by requests.
  8. + *
+ *

* Using the client to send request and get a synchronous response. The * request must be an instance of HttpRequest: - * + *

* 1. Get a Channel. * Channel channel = client.getChannel(timeoutMs); * 2. Create a ResponseHandler to handle a response. diff --git a/driver/src/main/java/oracle/nosql/driver/httpclient/ResponseHandler.java b/driver/src/main/java/oracle/nosql/driver/httpclient/ResponseHandler.java index 2b33c851..3802799c 100644 --- a/driver/src/main/java/oracle/nosql/driver/httpclient/ResponseHandler.java +++ b/driver/src/main/java/oracle/nosql/driver/httpclient/ResponseHandler.java @@ -28,7 +28,7 @@ * response asynchronously by overriding the responseReceived() method, or * synchronously by using the default implementation and waiting for the * response. - * + *

* Instances of this class must be closed using close(). * * TODO: examples of both sync and async usage diff --git a/driver/src/main/java/oracle/nosql/driver/kv/AuthenticationException.java b/driver/src/main/java/oracle/nosql/driver/kv/AuthenticationException.java index 1cc19410..b307be30 100644 --- a/driver/src/main/java/oracle/nosql/driver/kv/AuthenticationException.java +++ b/driver/src/main/java/oracle/nosql/driver/kv/AuthenticationException.java @@ -10,7 +10,7 @@ import oracle.nosql.driver.NoSQLException; /** - * On-premise only. + * On-premises only. *

* This exception is thrown when use StoreAccessTokenProvider in following * cases: diff --git a/driver/src/main/java/oracle/nosql/driver/kv/StoreAccessTokenProvider.java b/driver/src/main/java/oracle/nosql/driver/kv/StoreAccessTokenProvider.java index f4830a58..1f2cc553 100644 --- a/driver/src/main/java/oracle/nosql/driver/kv/StoreAccessTokenProvider.java +++ b/driver/src/main/java/oracle/nosql/driver/kv/StoreAccessTokenProvider.java @@ -35,7 +35,7 @@ import io.netty.handler.ssl.SslContext; /** - * On-premise only. + * On-premises only. *

* StoreAccessTokenProvider is an {@link AuthorizationProvider} that performs * the following functions: diff --git a/driver/src/main/java/oracle/nosql/driver/kv/package-info.java b/driver/src/main/java/oracle/nosql/driver/kv/package-info.java index 7ecdbb18..d752fe50 100644 --- a/driver/src/main/java/oracle/nosql/driver/kv/package-info.java +++ b/driver/src/main/java/oracle/nosql/driver/kv/package-info.java @@ -6,6 +6,6 @@ */ /** * This package contains classes that are specific to using the driver - * on-premise and not applicable to the Cloud Service. + * on-premises and not applicable to the Cloud Service. */ package oracle.nosql.driver.kv; diff --git a/driver/src/main/java/oracle/nosql/driver/ops/DeleteRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/DeleteRequest.java index 5344034f..35dab158 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/DeleteRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/DeleteRequest.java @@ -155,7 +155,7 @@ public DeleteRequest setTableName(String tableName) { /** * Sets the durability to use for the operation. - * On-premise only. + * On-premises only. * * @param durability the durability value * diff --git a/driver/src/main/java/oracle/nosql/driver/ops/ListTablesRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/ListTablesRequest.java index de8a02c7..17a45e3e 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/ListTablesRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/ListTablesRequest.java @@ -120,7 +120,7 @@ public ListTablesRequest setTimeout(int timeoutMs) { } /** - * On-premise only. + * On-premises only. *

* Sets the namespace to use for the list. If not set all tables accessible * to the user will be returned. If set, only tables in the namespace @@ -136,7 +136,7 @@ public ListTablesRequest setNamespace(String namespace) { } /** - * On-premise only. + * On-premises only. *

* Returns the namespace to use for the list or null if not set. * diff --git a/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java index 1ba17428..bcc81db7 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/MultiDeleteRequest.java @@ -197,7 +197,7 @@ public MultiDeleteRequest setTimeout(int timeoutMs) { /** * Sets the durability to use for the operation. - * On-premise only. + * On-premises only. * * @param durability the durability value. Set to null for * the default durability setting on the kvstore server. diff --git a/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java index e82dea92..51cd026d 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/PutRequest.java @@ -310,7 +310,7 @@ public PutRequest setReturnRow(boolean value) { /** * Sets the durability to use for the operation. - * On-premise only. + * On-premises only. * * @param durability the durability value. Set to null for * the default durability setting on the server. diff --git a/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java index 5a454e26..e9f2c74a 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java @@ -642,7 +642,7 @@ public QueryRequest setConsistency(Consistency consistency) { /** * Sets the durability to use for the operation. - * On-premise only. This setting only applies if the query modifies + * On-premises only. This setting only applies if the query modifies * a row using an INSERT, UPSERT, or DELETE statement. If the query is * read-only it is ignored. * diff --git a/driver/src/main/java/oracle/nosql/driver/ops/SystemRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/SystemRequest.java index c5397ef3..ba729c34 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/SystemRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/SystemRequest.java @@ -13,7 +13,7 @@ import oracle.nosql.driver.ops.serde.SerializerFactory; /** - * On-premise only. + * On-premises only. *

* SystemRequest is an on-premise-only request used to perform any * table-independent administrative operation such as diff --git a/driver/src/main/java/oracle/nosql/driver/ops/SystemResult.java b/driver/src/main/java/oracle/nosql/driver/ops/SystemResult.java index 5b568530..a2f17ed0 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/SystemResult.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/SystemResult.java @@ -12,7 +12,7 @@ import oracle.nosql.driver.RequestTimeoutException; /** - * On-premise only. + * On-premises only. *

* SystemResult is returned from {@link NoSQLHandle#systemStatus} and * {@link NoSQLHandle#systemRequest} operations. It encapsulates the @@ -48,7 +48,7 @@ public class SystemResult extends Result { private String resultString; /** - * On-premise only. + * On-premises only. *

* The current state of the operation */ diff --git a/driver/src/main/java/oracle/nosql/driver/ops/SystemStatusRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/SystemStatusRequest.java index 4cb31d4e..1c80dfde 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/SystemStatusRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/SystemStatusRequest.java @@ -13,7 +13,7 @@ import oracle.nosql.driver.ops.serde.SerializerFactory; /** - * On-premise only. + * On-premises only. *

* SystemStatusRequest is an on-premise-only request used to check the status * of an operation started using a {@link SystemRequest}. diff --git a/driver/src/main/java/oracle/nosql/driver/ops/TableRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/TableRequest.java index 55e4d609..f6072886 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/TableRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/TableRequest.java @@ -163,7 +163,7 @@ public TableRequest setTableName(String tableName) { * 2 cases -- table creation statements and limits modification operations. * It is not used for other DDL operations. *

- * If limits are set for an on-premise service they are silently ignored. + * If limits are set for an on-premises service they are silently ignored. * * @param tableLimits the limits * @@ -182,7 +182,7 @@ public TableRequest setTableLimits(TableLimits tableLimits) { * modification operations. * It is not used for other DDL operations. *

- * If tags are set for an on-premise service they are silently ignored. + * If tags are set for an on-premises service they are silently ignored. * * @param definedTags the tags * @@ -202,7 +202,7 @@ public TableRequest setDefinedTags(DefinedTags definedTags) { * modification operations. * It is not used for other DDL operations. *

- * If tags are set for an on-premise service they are silently ignored. + * If tags are set for an on-premises service they are silently ignored. * * @param freeFormTags the tags * @@ -223,7 +223,7 @@ public TableRequest setFreeFormTags(FreeFormTags freeFormTags) { * control allowing an application to ensure no unexpected modifications * have been made to the table. *

- * If set for an on-premise service the ETag is silently ignored. + * If set for an on-premises service the ETag is silently ignored. * * @param etag the ETag * 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 b3ba4ef7..8fcd3e46 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/TableResult.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/TableResult.java @@ -108,7 +108,7 @@ public String getDdl() { * Cloud service only. *

* Returns the OCID of the table. This value will be null if used with - * the on-premise service. + * the on-premises service. * * @return the table OCID * @@ -147,7 +147,7 @@ public String getNamespace() { } /** - * Returns the table name of the target table. If on-premise and the table + * Returns the table name of the target table. If on-premises and the table * is in a namespace the namespace is included as a prefix using the format * namespace:tableName * @@ -170,7 +170,7 @@ public String getSchema() { /** * Returns the throughput and capacity limits for the table. - * Limits from an on-premise service will always be null. + * Limits from an on-premises service will always be null. * * @return the limits */ diff --git a/driver/src/main/java/oracle/nosql/driver/ops/WriteMultipleRequest.java b/driver/src/main/java/oracle/nosql/driver/ops/WriteMultipleRequest.java index a76b672e..5cece640 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/WriteMultipleRequest.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/WriteMultipleRequest.java @@ -160,7 +160,7 @@ public void clear() { /** * Sets the durability to use for the operation. - * On-premise only. + * On-premises only. * * @param durability the durability value. Set to null for * the default durability setting on the kvstore server. @@ -251,7 +251,7 @@ private String getTopTableName(String tname) { /** * @hidden * Internal use only - * @return true if the opearations all work on + * @return true if the operations all work on * a single table */ public boolean isSingleTable() { diff --git a/driver/src/main/java/oracle/nosql/driver/ops/package-info.java b/driver/src/main/java/oracle/nosql/driver/ops/package-info.java index 590dc7ed..d3f6d6cc 100644 --- a/driver/src/main/java/oracle/nosql/driver/ops/package-info.java +++ b/driver/src/main/java/oracle/nosql/driver/ops/package-info.java @@ -26,7 +26,7 @@ * operations that succeed. All result instances contain information about * throughput used by that operation if available, in the form of * getReadUnits and getWriteUnits interfaces on the objects. - * When used against an on-premise service resource consumption information is + * When used against an on-premises service resource consumption information is * not available and will be 0. *

* {@link oracle.nosql.driver.ops.Request} and diff --git a/driver/src/main/java/oracle/nosql/driver/package-info.java b/driver/src/main/java/oracle/nosql/driver/package-info.java index c30641d6..52316529 100644 --- a/driver/src/main/java/oracle/nosql/driver/package-info.java +++ b/driver/src/main/java/oracle/nosql/driver/package-info.java @@ -19,7 +19,7 @@ * *

* This and other packages in the system support both users of the Oracle NoSQL - * Database Cloud Service and the on-premise Oracle NoSQL Database. Some + * Database Cloud Service and the on-premises Oracle NoSQL Database. Some * classes, methods, and parameters are specific to each environment. The * documentation for affected classes and methods notes whether there are * environment-specific considerations. Unless otherwise noted they are diff --git a/driver/src/main/java/oracle/nosql/driver/util/HttpConstants.java b/driver/src/main/java/oracle/nosql/driver/util/HttpConstants.java index 8556bd43..5a9bed43 100644 --- a/driver/src/main/java/oracle/nosql/driver/util/HttpConstants.java +++ b/driver/src/main/java/oracle/nosql/driver/util/HttpConstants.java @@ -150,7 +150,7 @@ public class HttpConstants { "nosql/data"); /** - * The base path to the on-premise security services. All users need + * The base path to the on-premises security services. All users need * a leading "/" so add it here. */ public static final String KV_SECURITY_PATH = makePath("/" + NOSQL_VERSION, diff --git a/driver/src/test/java/oracle/nosql/driver/OnPremiseTest.java b/driver/src/test/java/oracle/nosql/driver/OnPremiseTest.java index bd7c0057..34abef1d 100644 --- a/driver/src/test/java/oracle/nosql/driver/OnPremiseTest.java +++ b/driver/src/test/java/oracle/nosql/driver/OnPremiseTest.java @@ -44,10 +44,10 @@ import org.junit.Test; /** - * Test features that are supported on-premise only at this time: + * Test features that are supported on-premises only at this time: * o child tables * o namespaces - * o (TBD) security-relevant on-premise operations + * o (TBD) security-relevant on-premises operations */ public class OnPremiseTest extends ProxyTestBase { diff --git a/driver/src/test/java/oracle/nosql/driver/ProxyTestBase.java b/driver/src/test/java/oracle/nosql/driver/ProxyTestBase.java index 0f69b449..45b00887 100644 --- a/driver/src/test/java/oracle/nosql/driver/ProxyTestBase.java +++ b/driver/src/test/java/oracle/nosql/driver/ProxyTestBase.java @@ -1,14 +1,14 @@ /** * Test base for tests that talk to a server. The server (proxy) may be * one of: - * o on-premise configuration, not secure - * o on-premise configuration, secure + * o on-premises configuration, not secure + * o on-premises configuration, secure * o cloud simulator configuration * * Information required to connect and run tests * 1. endpoint * 2. type of server for conditional tests - * 3. secure on-premise adds authentication information: + * 3. secure on-premises adds authentication information: * o user name and password of an authorized user * o path to a trust store for SSL configuration * diff --git a/examples/src/main/java/BasicTableExample.java b/examples/src/main/java/BasicTableExample.java index b350a496..cca4f0ac 100644 --- a/examples/src/main/java/BasicTableExample.java +++ b/examples/src/main/java/BasicTableExample.java @@ -33,7 +33,7 @@ * Examples can be run against: * 1. the cloud service * 2. the cloud simulator (CloudSim) - * 3. the on-premise proxy and Oracle NoSQL Database instance, secure or + * 3. the on-premises proxy and Oracle NoSQL Database instance, secure or * not secure. * * To run: diff --git a/examples/src/main/java/Common.java b/examples/src/main/java/Common.java index d667e4e6..2052d0a3 100644 --- a/examples/src/main/java/Common.java +++ b/examples/src/main/java/Common.java @@ -32,7 +32,7 @@ * Examples can be run against: * 1. the cloud service * 2. the cloud simulator (CloudSim) - * 3. the on-premise proxy and Oracle NoSQL Database instance, secure or + * 3. the on-premises proxy and Oracle NoSQL Database instance, secure or * not secure. * * If running against the cloud service, the arguments are: @@ -57,7 +57,7 @@ * java -cp .:../lib/nosqldriver.jar BasicTableExample \ * http://localhost:8080 * - * If running against the on-premise Oracle NoSQL Database: + * If running against the on-premises Oracle NoSQL Database: * java Example -useKVProxy [-user ] [-password password] * * User and password are required when accessing a secure store. @@ -81,7 +81,7 @@ * ---------------- * If you are running against the cloud service, you will need to * provide configFile. This step is not needed if you are running against - * the Cloud Simulator or the on-premise proxy. + * the Cloud Simulator or the on-premises proxy. * * By default, with no -configFile argument, the example code will use * the default SignatureProvider constructor which uses the default user diff --git a/examples/src/main/java/DeleteExample.java b/examples/src/main/java/DeleteExample.java index c2532f40..f5ba75de 100644 --- a/examples/src/main/java/DeleteExample.java +++ b/examples/src/main/java/DeleteExample.java @@ -31,7 +31,7 @@ * Examples can be run against: * 1. the cloud service * 2. the cloud simulator (CloudSim) - * 3. the on-premise proxy and Oracle NoSQL Database instance, secure or + * 3. the on-premises proxy and Oracle NoSQL Database instance, secure or * not secure. * * To run: diff --git a/examples/src/main/java/IndexExample.java b/examples/src/main/java/IndexExample.java index 5095810f..4d1c06a7 100644 --- a/examples/src/main/java/IndexExample.java +++ b/examples/src/main/java/IndexExample.java @@ -27,7 +27,7 @@ * Examples can be run against: * 1. the cloud service * 2. the cloud simulator (CloudSim) - * 3. the on-premise proxy and Oracle NoSQL Database instance, secure or + * 3. the on-premises proxy and Oracle NoSQL Database instance, secure or * not secure. * * To run: