Skip to content

Commit 97372d0

Browse files
committed
Renamed classes and updated documentation
1 parent 299ce9c commit 97372d0

19 files changed

+61
-60
lines changed

ojdbc-provider-gcp/README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ Google Cloud Platform (GCP).
66
## Centralized Config Providers
77

88
<dl>
9-
<dt><a href="#gcp-object-storage-config-provider">GCP Object Storage Config
9+
<dt><a href="#gcp-cloud-storage-config-provider">GCP Cloud Storage Config
10+
Provider</a></dt>
11+
<dd>Provides connection properties managed by the Cloud Storage service</dd>
12+
<dt><a href="#gcp-secret_manager-config-provider">GCP Secret Manager Config
1013
Provider</a></dt>
11-
<dd>Provides connection properties managed by the Object Storage service</dd>
12-
<dt><a href="#gcp-vault-secret-config-provider">GCP Vault Secret Config Provider</a></dt>
1314
<dd>Provides connection properties managed by the Secret Manager service</dd>
1415
<dt><a href="#caching-configuration">Caching configuration</a></dt>
1516
<dd>Caching mechanism adopted by Centralized Config Providers</dd>
@@ -18,10 +19,10 @@ Provider</a></dt>
1819
## Resource Providers
1920

2021
<dl>
21-
<dt><a href="#vault-password-provider">Vault Password Provider</a></dt>
22-
<dd>Provides passwords managed by the Vault service</dd>
23-
<dt><a href="#vault-username-provider">Vault Username Provider</a></dt>
24-
<dd>Provides usernames managed by the Vault service</dd>
22+
<dt><a href="#vault-password-provider">Secret Manager Password Provider</a></dt>
23+
<dd>Provides passwords managed by the Secret Manager service</dd>
24+
<dt><a href="#vault-username-provider">Secret Manager Username Provider</a></dt>
25+
<dd>Provides usernames managed by the Secret Manager service</dd>
2526
</dl>
2627

2728
Visit any of the links above to find information and usage examples for a
@@ -68,11 +69,11 @@ gcloud auth application-default login
6869
```
6970
A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.
7071

71-
## GCP Object Storage Config Provider
72-
The Oracle DataSource uses a new prefix `jdbc:oracle:thin:@config-gcp-object:` to be able to identify that the configuration parameters should be loaded using GCP Object Storage. Users only need to indicate the project, bucket and object containing the JSON payload, with the following syntax:
72+
## GCP Cloud Storage Config Provider
73+
The Oracle DataSource uses a new prefix `jdbc:oracle:thin:@config-gcpstorage:` to be able to identify that the configuration parameters should be loaded using GCP Object Storage. Users only need to indicate the project, bucket and object containing the JSON payload, with the following syntax:
7374

7475
<pre>
75-
jdbc:oracle:thin:@config-gcp-object://project={project};bucket={bucket};object={object}]
76+
jdbc:oracle:thin:@config-gcpstorage://project={project};bucket={bucket};object={object}]
7677
</pre>
7778

7879
### JSON Payload format
@@ -146,8 +147,8 @@ For the JSON type of provider (GCP Object Storage, HTTP/HTTPS, File) the passwor
146147
- method
147148
- optional parameters (depends on the cloud provider).
148149

149-
## GCP Vault Secret Config Provider
150-
Apart from GCP Object Storage, users can also store JSON Payload in the content of GCP Secret Manager secret. Users need to indicate the resource name:
150+
## GCP Secret Manager Config Provider
151+
Apart from GCP Cloud Storage, users can also store JSON Payload in the content of GCP Secret Manager secret. Users need to indicate the resource name:
151152

152153
<pre>
153154
jdbc:oracle:thin:@config-gcpvault:{resource-name}

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpObjectStorageConfigurationProvider.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpCloudStorageConfigurationProvider.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@
4343
import java.util.Map;
4444

4545
import oracle.jdbc.driver.OracleConfigurationJsonProvider;
46-
import oracle.jdbc.provider.gcp.objectstorage.GcpObjectStorageFactory;
46+
import oracle.jdbc.provider.gcp.objectstorage.GcpCloudStorageFactory;
4747
import oracle.jdbc.provider.parameter.ParameterSet;
4848

4949
/**
50-
* A provider for JSON payload which contains configuration from GCP Object
50+
* A provider for JSON payload which contains configuration from GCP Cloud
5151
* Storage. See {@link #getJson(String)} for the spec of the JSON payload.
5252
*/
53-
public class GcpObjectStorageConfigurationProvider extends OracleConfigurationJsonProvider {
53+
public class GcpCloudStorageConfigurationProvider extends OracleConfigurationJsonProvider {
5454

5555
public static final String PROJECT_PARAMETER = "project";
5656
public static final String BUCKET_PARAMETER = "bucket";
@@ -64,7 +64,7 @@ public String getType() {
6464
/**
6565
* {@inheritDoc}
6666
* <p>
67-
* Returns the JSON payload stored in GCP Object Storage.
67+
* Returns the JSON payload stored in GCP Cloud Storage.
6868
* </p>
6969
*
7070
* @param location semi-colon separated list of key value pairs
@@ -89,7 +89,7 @@ public InputStream getJson(String location) throws SQLException {
8989
}
9090
ParameterSet parameterSet = GcpConfigurationParameters.getParser().parseNamedValues(namedValues);
9191

92-
return GcpObjectStorageFactory.getInstance().request(parameterSet).getContent();
92+
return GcpCloudStorageFactory.getInstance().request(parameterSet).getContent();
9393
}
9494

9595
}

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpConfigurationParameters.java

+10-10
Original file line numberDiff line numberDiff line change
@@ -37,35 +37,35 @@
3737
*/
3838
package oracle.jdbc.provider.gcp.configuration;
3939

40-
import static oracle.jdbc.provider.gcp.secrets.GcpVaultSecretFactory.SECRET_VERSION_NAME;
40+
import static oracle.jdbc.provider.gcp.secrets.GcpSecretManagerFactory.SECRET_VERSION_NAME;
4141

42-
import oracle.jdbc.provider.gcp.objectstorage.GcpObjectStorageFactory;
42+
import oracle.jdbc.provider.gcp.objectstorage.GcpCloudStorageFactory;
4343
import oracle.jdbc.provider.parameter.ParameterSetParser;;
4444

4545
public class GcpConfigurationParameters {
4646
/**
4747
* <p>
48-
* A parser that recognizes parameters of URIs received by
49-
* {@link GcpObjectStorageProvider}, and JSON objects received by
50-
* {@link GcpVaultSecretProvider}.
48+
* A parser that recognizes parameters of key/value pairs received by
49+
* {@link GcpCloudStorageConfigurationProvider}, and resource names received
50+
* by {@link GcpSecretManagerConfigurationProvider}.
5151
* </p>
5252
*/
5353
private static final ParameterSetParser PARAMETER_SET_PARSER = ParameterSetParser.builder()
5454
.addParameter("value", SECRET_VERSION_NAME)
5555
.addParameter("secretVersionName", SECRET_VERSION_NAME)
5656
.addParameter(
57-
GcpObjectStorageConfigurationProvider.PROJECT_PARAMETER, GcpObjectStorageFactory.PROJECT)
57+
GcpCloudStorageConfigurationProvider.PROJECT_PARAMETER, GcpCloudStorageFactory.PROJECT)
5858
.addParameter(
59-
GcpObjectStorageConfigurationProvider.BUCKET_PARAMETER, GcpObjectStorageFactory.BUCKET)
59+
GcpCloudStorageConfigurationProvider.BUCKET_PARAMETER, GcpCloudStorageFactory.BUCKET)
6060
.addParameter(
61-
GcpObjectStorageConfigurationProvider.OBJECT_PARAMETER, GcpObjectStorageFactory.OBJECT)
61+
GcpCloudStorageConfigurationProvider.OBJECT_PARAMETER, GcpCloudStorageFactory.OBJECT)
6262
.build();
6363

6464
/**
6565
* @return A parser that recognizes parameters of URIs received by
66-
* {@link GcpObjectStorageConfigurationProvider}, and JSON objects
66+
* {@link GcpCloudStorageConfigurationProvider}, and JSON objects
6767
* received by
68-
* {@link GcpVaultSecretConfigurationProvider}.
68+
* {@link GcpSecretManagerConfigurationProvider}.
6969
*/
7070
public static ParameterSetParser getParser() {
7171
return PARAMETER_SET_PARSER;

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpJsonVaultSecretProvider.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpJsonSecretManagerProvider.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@
4242
import java.util.Base64;
4343

4444
import oracle.jdbc.provider.configuration.JsonSecretUtil;
45-
import oracle.jdbc.provider.gcp.secrets.GcpVaultSecretFactory;
45+
import oracle.jdbc.provider.gcp.secrets.GcpSecretManagerFactory;
4646
import oracle.jdbc.provider.parameter.ParameterSet;
4747
import oracle.jdbc.spi.OracleConfigurationJsonSecretProvider;
4848
import oracle.sql.json.OracleJsonObject;
4949

50-
public class GcpJsonVaultSecretProvider implements OracleConfigurationJsonSecretProvider {
50+
public class GcpJsonSecretManagerProvider implements OracleConfigurationJsonSecretProvider {
5151

5252
/**
5353
* {@inheritDoc}
@@ -74,7 +74,7 @@ public char[] getSecret(OracleJsonObject jsonObject) {
7474
ParameterSet parameterSet = GcpConfigurationParameters.getParser().parseNamedValues(
7575
JsonSecretUtil.toNamedValues(jsonObject));
7676

77-
ByteString stringData = GcpVaultSecretFactory.getInstance().request(parameterSet).getContent().getData();
77+
ByteString stringData = GcpSecretManagerFactory.getInstance().request(parameterSet).getContent().getData();
7878
return Base64.getEncoder().encodeToString(stringData.toByteArray()).toCharArray();
7979
}
8080

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpVaultSecretConfigurationProvider.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/configuration/GcpSecretManagerConfigurationProvider.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@
4444
import java.util.Map;
4545

4646
import oracle.jdbc.driver.OracleConfigurationJsonProvider;
47-
import oracle.jdbc.provider.gcp.secrets.GcpVaultSecretFactory;
47+
import oracle.jdbc.provider.gcp.secrets.GcpSecretManagerFactory;
4848
import oracle.jdbc.provider.parameter.ParameterSet;
4949

5050
/**
5151
* A provider for JSON payload which contains configuration from GCP Secret
5252
* Manager.
5353
* See {@link #getJson(String)} for the spec of the JSON payload.
5454
**/
55-
public class GcpVaultSecretConfigurationProvider extends OracleConfigurationJsonProvider {
55+
public class GcpSecretManagerConfigurationProvider extends OracleConfigurationJsonProvider {
5656

5757
@Override
5858
public String getType() {
@@ -75,7 +75,7 @@ public InputStream getJson(String location) throws SQLException {
7575
namedValues.put("secretVersionName", location);
7676
ParameterSet parameterSet = GcpConfigurationParameters.getParser().parseNamedValues(namedValues);
7777
return new ByteArrayInputStream(
78-
GcpVaultSecretFactory.getInstance().request(parameterSet).getContent().getData().toByteArray());
78+
GcpSecretManagerFactory.getInstance().request(parameterSet).getContent().getData().toByteArray());
7979
}
8080

8181
}

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/objectstorage/GcpObjectStorageFactory.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/objectstorage/GcpCloudStorageFactory.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,16 @@
5151
import oracle.jdbc.provider.parameter.Parameter;
5252
import oracle.jdbc.provider.parameter.ParameterSet;
5353

54-
public class GcpObjectStorageFactory implements ResourceFactory<InputStream> {
54+
public class GcpCloudStorageFactory implements ResourceFactory<InputStream> {
5555
/** The secret version name for the secret */
5656
public static final Parameter<String> PROJECT = Parameter.create(REQUIRED);
5757
public static final Parameter<String> BUCKET = Parameter.create(REQUIRED);
5858
public static final Parameter<String> OBJECT = Parameter.create(REQUIRED);
5959

6060
private static final ResourceFactory<InputStream> INSTANCE = CachedResourceFactory
61-
.create(new GcpObjectStorageFactory());
61+
.create(new GcpCloudStorageFactory());
6262

63-
private GcpObjectStorageFactory() {
63+
private GcpCloudStorageFactory() {
6464
}
6565

6666
/**

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/resource/GcpVaultSecretPasswordProvider.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/resource/GcpSecretManagerPasswordProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
* {@link java.util.ServiceLoader}.
5555
* </p>
5656
*/
57-
public class GcpVaultSecretPasswordProvider extends GcpVaultSecretProvider implements PasswordProvider {
57+
public class GcpSecretManagerPasswordProvider extends GcpSecretManagerProvider implements PasswordProvider {
5858

59-
public GcpVaultSecretPasswordProvider() {
59+
public GcpSecretManagerPasswordProvider() {
6060
super("secret-password");
6161
}
6262

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/resource/GcpVaultSecretProvider.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/resource/GcpSecretManagerProvider.java

+6-6
Original file line numberDiff line numberDiff line change
@@ -41,28 +41,28 @@
4141

4242
import com.google.protobuf.ByteString;
4343

44-
import oracle.jdbc.provider.gcp.secrets.GcpVaultSecretFactory;
44+
import oracle.jdbc.provider.gcp.secrets.GcpSecretManagerFactory;
4545
import oracle.jdbc.provider.parameter.ParameterSet;
4646
import oracle.jdbc.provider.resource.AbstractResourceProvider;
4747
import oracle.jdbc.provider.resource.ResourceParameter;
4848

4949
/**
5050
* Internal class to be inherited by other resource providers using secrets.
5151
*/
52-
class GcpVaultSecretProvider extends AbstractResourceProvider {
52+
class GcpSecretManagerProvider extends AbstractResourceProvider {
5353

5454
private static final ResourceParameter[] PARAMETERS = {
55-
new ResourceParameter("secretVersionName", GcpVaultSecretFactory.SECRET_VERSION_NAME)
55+
new ResourceParameter("secretVersionName", GcpSecretManagerFactory.SECRET_VERSION_NAME)
5656
};
5757

58-
protected GcpVaultSecretProvider(String valueType) {
58+
protected GcpSecretManagerProvider(String valueType) {
5959
super("gcp", valueType, PARAMETERS);
6060
}
6161

6262
/**
6363
* <p>
6464
* Returns a secret identified by a parameter named "secretVersionName" which
65-
* configures {@link GcpVaultSecretFactory#SECRET_VERSION_NAME}. This method
65+
* configures {@link GcpSecretManagerFactory#SECRET_VERSION_NAME}. This method
6666
* parses these parameters from text values.
6767
* </p>
6868
* <p>
@@ -78,7 +78,7 @@ protected final ByteString getSecret(
7878

7979
ParameterSet parameterSet = parseParameterValues(parameterValues);
8080

81-
return GcpVaultSecretFactory.getInstance()
81+
return GcpSecretManagerFactory.getInstance()
8282
.request(parameterSet)
8383
.getContent()
8484
.getData();

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/resource/GcpVaultSecretUsernameProvider.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/resource/GcpSecretManagerUsernameProvider.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@
5252
* {@link java.util.ServiceLoader}.
5353
* </p>
5454
*/
55-
public class GcpVaultSecretUsernameProvider extends GcpVaultSecretProvider implements UsernameProvider {
55+
public class GcpSecretManagerUsernameProvider extends GcpSecretManagerProvider implements UsernameProvider {
5656

57-
public GcpVaultSecretUsernameProvider() {
57+
public GcpSecretManagerUsernameProvider() {
5858
super("secret-username");
5959
}
6060

ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/secrets/GcpVaultSecretFactory.java ojdbc-provider-gcp/src/main/java/oracle/jdbc/provider/gcp/secrets/GcpSecretManagerFactory.java

+3-3
Original file line numberDiff line numberDiff line change
@@ -64,15 +64,15 @@
6464
* of a secret as a database password, or any other security sensitive value.
6565
* </p>
6666
*/
67-
public class GcpVaultSecretFactory implements ResourceFactory<SecretPayload> {
67+
public class GcpSecretManagerFactory implements ResourceFactory<SecretPayload> {
6868

6969
/** The secret version name for the secret */
7070
public static final Parameter<String> SECRET_VERSION_NAME = Parameter.create(REQUIRED);
7171

7272
private static final ResourceFactory<SecretPayload> INSTANCE = CachedResourceFactory
73-
.create(new GcpVaultSecretFactory());
73+
.create(new GcpSecretManagerFactory());
7474

75-
private GcpVaultSecretFactory() {
75+
private GcpSecretManagerFactory() {
7676
}
7777

7878
/**
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
oracle.jdbc.provider.gcp.configuration.GcpJsonVaultSecretProvider
1+
oracle.jdbc.provider.gcp.configuration.GcpJsonSecretManagerProvider
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
oracle.jdbc.provider.gcp.configuration.GcpObjectStorageConfigurationProvider
2-
oracle.jdbc.provider.gcp.configuration.GcpVaultSecretConfigurationProvider
1+
oracle.jdbc.provider.gcp.configuration.GcpCloudStorageConfigurationProvider
2+
oracle.jdbc.provider.gcp.configuration.GcpSecretManagerConfigurationProvider
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
oracle.jdbc.provider.gcp.resource.GcpVaultSecretPasswordProvider
1+
oracle.jdbc.provider.gcp.resource.GcpSecretManagerPasswordProvider
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
oracle.jdbc.provider.gcp.resource.GcpVaultSecretUsernameProvider
1+
oracle.jdbc.provider.gcp.resource.GcpSecretManagerUsernameProvider

ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/configuration/GcpObjectStorageProviderTest.java ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/configuration/GcpCloudStorageProviderTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
import oracle.jdbc.spi.OracleConfigurationProvider;
5050

5151
@Disabled
52-
public class GcpObjectStorageProviderTest {
52+
public class GcpCloudStorageProviderTest {
5353

5454
private enum GcpTestProperties {
5555
GCP_OBJECT_STORAGE_URL

ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/configuration/GcpVaultSecretConfigurationProviderTest.java ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/configuration/GcpSecretManagerConfigurationProviderTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
import oracle.jdbc.spi.OracleConfigurationProvider;
5050

5151
@Disabled
52-
public class GcpVaultSecretConfigurationProviderTest {
52+
public class GcpSecretManagerConfigurationProviderTest {
5353
private enum GcpTestProperties {
5454
SECRET_VERSION_NAME_CONFIG
5555
}

ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/resource/GcpVaultSecretPasswordProviderTest.java ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/resource/GcpSecretManagerPasswordProviderTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
import static oracle.jdbc.provider.resource.ResourceProviderTestUtil.findProvider;
5757

5858
@Disabled
59-
public class GcpVaultSecretPasswordProviderTest {
59+
public class GcpSecretManagerPasswordProviderTest {
6060
private static final PasswordProvider PROVIDER = findProvider(
6161
PasswordProvider.class, "ojdbc-provider-gcp-secret-password");
6262

ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/resource/GcpVaultSecretUsernameProviderTest.java ojdbc-provider-gcp/src/test/java/oracle/provider/gcp/resource/GcpSecretManagerUsernameProviderTest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
import oracle.jdbc.spi.UsernameProvider;
5757

5858
@Disabled
59-
public class GcpVaultSecretUsernameProviderTest {
59+
public class GcpSecretManagerUsernameProviderTest {
6060
private static final UsernameProvider PROVIDER = findProvider(
6161
UsernameProvider.class, "ojdbc-provider-gcp-secret-username");
6262

ojdbc-provider-samples/src/main/java/oracle/jdbc/provider/gcp/configuration/SimpleObjectStorageExample.java ojdbc-provider-samples/src/main/java/oracle/jdbc/provider/gcp/configuration/SimpleCloudStorageExample.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@
4646

4747
/**
4848
* A standalone example that configures Oracle JDBC to be provided with the
49-
* connection properties retrieved from OCI Object Storage.
49+
* connection properties retrieved from OCI Cloud Storage.
5050
*/
51-
public class SimpleObjectStorageExample {
51+
public class SimpleCloudStorageExample {
5252

5353
/**
5454
* <p>

0 commit comments

Comments
 (0)