From 3afdb81b759cf821dd2f292d0a8f2dceb2baa2a0 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Fri, 4 Apr 2025 07:20:33 +1000 Subject: [PATCH] Fix grammar, links, spelling in Markdown files Signed-off-by: John Bampton --- ApacheConnector-README.md | 8 ++++---- CHANGELOG.md | 6 +++--- Development-README.md | 4 ++-- README.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/ApacheConnector-README.md b/ApacheConnector-README.md index adceeab22ee..df2a953d748 100644 --- a/ApacheConnector-README.md +++ b/ApacheConnector-README.md @@ -4,7 +4,7 @@ When using the Jersey 2 or Jersey 3 HTTP clients (`oci-java-sdk-common-httpclien ## Memory Consumption due to Buffering by the Apache Connector -The `ApacheConfigurator` buffers requests into memory and can impact memory utilization of your application. This increased use of memory is especially relavent when using`ObjectStorageClient` to upload large objects to the Object Storage service. +The `ApacheConfigurator` buffers requests into memory and can impact memory utilization of your application. This increased use of memory is especially relevant when using`ObjectStorageClient` to upload large objects to the Object Storage service. In order to prevent buffering of requests in memory please use `ApacheConfigurator.NonBuffering` and provide the `contentLength` when calling the API. For example, when calling `ObjectStorageClient.putObject()`, pass the content length when creating `PutObjectRequest`. For `ObjectStorageClient`, `ApacheConfigurator.NonBuffering` is the default option. Overriding the `clientConfigurator` will default back to Jersey Default Connector. @@ -110,7 +110,7 @@ For API calls that return binary/stream response, the SDK will auto-close the st ## Configure the Connection Pool -The ApacheConfigurator configures a connection pool by default. However, the connnection pool can be configured or disabled. Configure the connection pool as follows: +The ApacheConfigurator configures a connection pool by default. However, the connection pool can be configured or disabled. Configure the connection pool as follows: final PoolingHttpClientConnectionManager poolConnectionManager = new PoolingHttpClientConnectionManager(); @@ -236,7 +236,7 @@ Note : Disabling connection monitor thread by changing the system property disab ### Disabling extra logs related to streams The SDK emits warnings related to streams when an API that returns streams in its response is called. To disable the logs around streams, you can set -the system property `oci.javasdk.extra.stream.logs.enabled` to `false`. This can be done programmitically or by passing a system property in the java command line. +the system property `oci.javasdk.extra.stream.logs.enabled` to `false`. This can be done programmatically or by passing a system property in the java command line. More examples related to customizing Apache Connector can be found [here](https://github.com/oracle/oci-java-sdk/tree/master/bmc-examples/src/main/java/ApacheConnectorPropertiesExample.java) @@ -245,4 +245,4 @@ Copyright (c) 2016, 2020, Oracle and/or its affiliates. All rights reserved. This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. -See [LICENSE](../../LICENSE.txt) for more details. +See [LICENSE](LICENSE.txt) for more details. diff --git a/CHANGELOG.md b/CHANGELOG.md index 270eae053bc..50697edf6e4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1816,7 +1816,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). - In `com.oracle.bmc.responses.BmcResponse`, the collection used for headers was changed from `javax.ws.rs.core.MultivaluedMap` to `Map>`, to decouple the implementation from the choice of the HTTP client. - Circuit breakers - The circuit breaker interface has been renamed from `com.oracle.bmc.circuitbreaker.JaxRsCircuitBreaker` to `com.oracle.bmc.circuitbreaker.OciCircuitBreaker` - - Examples of affectede code: + - Examples of affected code: - `com.oracle.bmc.circuitbreaker.CircuitBreakerFactory`: Return type of method `public com.oracle.bmc.circuitbreaker.JaxRsCircuitBreaker build(com.oracle.bmc.circuitbreaker.CircuitBreakerConfiguration)` has been changed to `com.oracle.bmc.circuitbreaker.OciCircuitBreaker` - Instead of using the constructor of `com.oracle.bmc.circuitbreaker.CircuitBreakerConfiguration`, use the builder. The constructor is not public anymore. - Some constants in `com.oracle.bmc.circuitbreaker.CircuitBreakerConfiguration` have been removed, if you need them, replace them with the actual values: @@ -3118,7 +3118,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). - Support for specifying a key store when creating autonomous container databases in the Database service ### Fixed -- Fixed a potential data curruption problem for binary data upload with `RefreshableOnNotAuthenticatedProvider`. We recommend that you update to this version `1.25.2` or later. For details, see https://github.com/oracle/oci-java-sdk/issues/255 +- Fixed a potential data corruption problem for binary data upload with `RefreshableOnNotAuthenticatedProvider`. We recommend that you update to this version `1.25.2` or later. For details, see https://github.com/oracle/oci-java-sdk/issues/255 ## 1.25.1 - 2020-10-20 ### Added @@ -3317,7 +3317,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). ### Breaking Changes -- Data type for paramater `dataStorageSizeInTBs` changed from `Integer` to `Double` in the Database service +- Data type for parameter `dataStorageSizeInTBs` changed from `Integer` to `Double` in the Database service - Enum `LifecycleState` has removed the state `Offline` and added `Disconnected` in the Database service ## 1.17.5 - 2020-06-02 diff --git a/Development-README.md b/Development-README.md index f5f008e49ea..dac169c08cb 100644 --- a/Development-README.md +++ b/Development-README.md @@ -6,7 +6,7 @@ - `dev` - Compile, reformat code and update licenses. - `dev` with `-Ddev.profile.skip.javadoc=false` - Compile, reformat code and update licenses, generate Javadoc. - `quick` - Only check for compilation errors, no Javadoc or tests. -- `jdk-17-and-above` - This profile is automatically used when JDK 17 or higher is detected. No Jacdoc generated and tests failures should be ignored. See the [Java 17 test failures](#Java17TestFailures) section in [Known Development Issues](#KnownDevelopmentIssues). +- `jdk-17-and-above` - This profile is automatically used when JDK 17 or higher is detected. No Javadoc generated and tests failures should be ignored. See the [Java 17 test failures](#Java17TestFailures) section in [Known Development Issues](#KnownDevelopmentIssues). ### Usage To run a maven build with the `dev` profile and generate Javadoc, use @@ -48,4 +48,4 @@ The following tests should report errors: - RequestSignerImplTest - UploadManagerTest -Test failures beyond these may be test failures that come from implemented changes. To run these tests sucessfully, use JDK 8 for now. \ No newline at end of file +Test failures beyond these may be test failures that come from implemented changes. To run these tests successfully, use JDK 8 for now. \ No newline at end of file diff --git a/README.md b/README.md index 6df07553276..6b42bd82bb2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The project is open source and maintained by Oracle Corp. The home page for the The OCI Java SDK versions `1.x.y` and `2.x.y` are now referred as OCI Legacy Java SDK. Any updates or bug fixes related to OCI Legacy Java SDK can be found in [legacy/v2/master branch](https://github.com/oracle/oci-java-sdk/tree/legacy/v2/master). Please refer [README.md](https://github.com/oracle/oci-java-sdk/blob/legacy/v2/master/README.md) to learn more about these legacy versions. -This Github repository will refer to OCI Java SDK version `3.x.y` by default where support for new features and services will be added. +This GitHub repository will refer to OCI Java SDK version `3.x.y` by default where support for new features and services will be added. ## Documentation