Fix readme file and rename some classes

Author: MouhsinElmajdouby

ojdbc-provider-hashicorp/README.md

@@ -89,7 +89,7 @@ The provider searches for the following parameters:
 <td>Yes</td>
 </tr>
 <tr>
-<td><code>VAULT_AUTH_PATH</code></td>
+<td><code>USERPASS_AUTH_PATH</code></td>
 <td>The authentication path in the Vault (default: <code>userpass</code>)</td>
 <td>No</td>
 </tr>

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/DedicatedVaultResourceFactory.java

@@ -40,8 +40,8 @@
 
 import oracle.jdbc.provider.factory.Resource;
 import oracle.jdbc.provider.factory.ResourceFactory;
-import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultCredentials;
-import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultCredentialsFactory;
+import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultToken;
+import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultTokenFactory;
 import oracle.jdbc.provider.parameter.ParameterSet;
 
 /**
@@ -53,7 +53,7 @@ public abstract class DedicatedVaultResourceFactory<T> implements ResourceFactor
   @Override
   public final Resource<T> request(ParameterSet parameterSet) {
     // Retrieve the Vault credentials from the credentials factory
-    DedicatedVaultCredentials credentials = DedicatedVaultCredentialsFactory
+    DedicatedVaultToken credentials = DedicatedVaultTokenFactory
             .getInstance()
             .request(parameterSet)
             .getContent();
@@ -67,5 +67,5 @@ public final Resource<T> request(ParameterSet parameterSet) {
   }
 
   public abstract Resource<T> request(
-          DedicatedVaultCredentials credentials, ParameterSet parameterSet);
+          DedicatedVaultToken credentials, ParameterSet parameterSet);
 }

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/authentication/DedicatedVaultCredentials.java ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/authentication/DedicatedVaultToken.java

@@ -47,7 +47,7 @@
  * requests to the Vault API.
  * </p>
  */
-public final class DedicatedVaultCredentials {
+public final class DedicatedVaultToken {
 
   private final String vaultToken;
 
@@ -58,7 +58,7 @@ public final class DedicatedVaultCredentials {
    * @param vaultToken the token used to authenticate API requests to
    * the Vault. Must not be null or empty.
    */
-  public DedicatedVaultCredentials(String vaultToken) {
+  public DedicatedVaultToken(String vaultToken) {
     this.vaultToken = vaultToken;
   }
   /**

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/authentication/DedicatedVaultCredentialsFactory.java ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/authentication/DedicatedVaultTokenFactory.java

@@ -65,15 +65,15 @@
 
 /**
  * <p>
- * Factory for creating {@link DedicatedVaultCredentials} objects for authenticating
+ * Factory for creating {@link DedicatedVaultToken} objects for authenticating
  * with Dedicated HashiCorp Vault.
  * </p><p>
  * This factory determines the appropriate authentication method based on the provided
  * {@link ParameterSet} and creates credentials accordingly.
  * </p>
  */
-public final class DedicatedVaultCredentialsFactory
-        implements ResourceFactory<DedicatedVaultCredentials> {
+public final class DedicatedVaultTokenFactory
+        implements ResourceFactory<DedicatedVaultToken> {
 
   /**
    * <p>
@@ -90,24 +90,24 @@ public final class DedicatedVaultCredentialsFactory
   // 1 minutes buffer for token expiration (in ms)
   private static final long TOKEN_TTL_BUFFER = 60_000;
 
-  private static final DedicatedVaultCredentialsFactory INSTANCE =
-          new DedicatedVaultCredentialsFactory();
+  private static final DedicatedVaultTokenFactory INSTANCE =
+          new DedicatedVaultTokenFactory();
 
-  private DedicatedVaultCredentialsFactory() {
+  private DedicatedVaultTokenFactory() {
   }
 
   /**
    * Returns a singleton instance of {@code DedicatedVaultCredentialsFactory}.
    *
    * @return a singleton instance. Not null.
    */
-  public static DedicatedVaultCredentialsFactory getInstance() {
+  public static DedicatedVaultTokenFactory getInstance() {
     return INSTANCE;
   }
 
   @Override
-  public Resource<DedicatedVaultCredentials> request(ParameterSet parameterSet) {
-    DedicatedVaultCredentials credentials = getCredential(parameterSet);
+  public Resource<DedicatedVaultToken> request(ParameterSet parameterSet) {
+    DedicatedVaultToken credentials = getCredential(parameterSet);
     return Resource.createPermanentResource(credentials, true);
   }
 
@@ -118,7 +118,7 @@ public Resource<DedicatedVaultCredentials> request(ParameterSet parameterSet) {
    *                     not be null.
    * @return the created {@code DedicatedVaultCredentials} instance.
    */
-  private static DedicatedVaultCredentials getCredential(ParameterSet parameterSet) {
+  private static DedicatedVaultToken getCredential(ParameterSet parameterSet) {
     // Check which authentication method is requested
     DedicatedVaultAuthenticationMethod method =
             parameterSet.getRequired(AUTHENTICATION_METHOD);
@@ -127,22 +127,22 @@ private static DedicatedVaultCredentials getCredential(ParameterSet parameterSet
       case VAULT_TOKEN:
         return createTokenCredentials(parameterSet);
       case USERPASS:
-        return createScopedToken(parameterSet, method, DedicatedVaultCredentialsFactory::createUserpassToken);
+        return createScopedToken(parameterSet, method, DedicatedVaultTokenFactory::createUserpassToken);
       case APPROLE:
-        return createScopedToken(parameterSet, method, DedicatedVaultCredentialsFactory::createAppRoleToken);
+        return createScopedToken(parameterSet, method, DedicatedVaultTokenFactory::createAppRoleToken);
       default:
         throw new IllegalArgumentException(
                 "Unrecognized authentication method: " + method);
     }
   }
 
   /**
-   * Creates {@link DedicatedVaultCredentials} using the Vault token.
+   * Creates {@link DedicatedVaultToken} using the Vault token.
    *
    * @param parameterSet the set of parameters containing the Vault token. Must not be null.
    * @return the created {@code DedicatedVaultCredentials} instance.
    */
-  private static DedicatedVaultCredentials createTokenCredentials(ParameterSet parameterSet) {
+  private static DedicatedVaultToken createTokenCredentials(ParameterSet parameterSet) {
     String vaultToken = getRequiredOrFallback(
             parameterSet,
             DedicatedVaultSecretsManagerFactory.VAULT_TOKEN,
@@ -153,25 +153,25 @@ private static DedicatedVaultCredentials createTokenCredentials(ParameterSet par
       throw new IllegalStateException("Vault Token not found in parameters, " +
               "system properties, or environment variables");
     }
-    return new DedicatedVaultCredentials(vaultToken);
+    return new DedicatedVaultToken(vaultToken);
   }
 
   /**
-   * Creates or retrieves a cached {@link DedicatedVaultCredentials} using
+   * Creates or retrieves a cached {@link DedicatedVaultToken} using
    * a scoped token.
    *
    * @param parameterSet the set of parameters for the request.
    * @param method the authentication method being used.
    * @param generator the token generator function.
    * @return a {@code DedicatedVaultCredentials} instance.
    */
-  private static DedicatedVaultCredentials createScopedToken(
+  private static DedicatedVaultToken createScopedToken(
           ParameterSet parameterSet,
           DedicatedVaultAuthenticationMethod method,
           TokenGenerator generator
   ) {
     ParameterSet cacheKey = generateCacheKey(parameterSet, method);
-    synchronized (DedicatedVaultCredentialsFactory.class) {
+    synchronized (DedicatedVaultTokenFactory.class) {
       CachedToken cachedToken = tokenCache.get(cacheKey);
       long currentTime = System.currentTimeMillis();
 
@@ -183,7 +183,7 @@ private static DedicatedVaultCredentials createScopedToken(
       CachedToken validCachedToken = tokenCache.get(cacheKey);
       if (validCachedToken.getToken() instanceof OpaqueAccessToken) {
         OpaqueAccessToken opaqueToken = (OpaqueAccessToken) validCachedToken.getToken();
-        return new DedicatedVaultCredentials(opaqueToken.token().get());
+        return new DedicatedVaultToken(opaqueToken.token().get());
       } else {
         throw new IllegalStateException("Cached token is not an instance of OpaqueAccessToken");
       }

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/configuration/DedicatedVaultConfigurationParameters.java

@@ -39,7 +39,7 @@
 package oracle.jdbc.provider.hashicorp.hcpvaultdedicated.configuration;
 
 import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultAuthenticationMethod;
-import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultCredentialsFactory;
+import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultTokenFactory;
 import oracle.jdbc.provider.parameter.ParameterSetParser;
 
 /**
@@ -71,7 +71,7 @@ public static ParameterSetParser.Builder configureBuilder(ParameterSetParser.Bui
             // The parameter name is "AUTHENTICATION"
             "AUTHENTICATION",
             // Tied to HashicorpCredentialsFactory.AUTHENTICATION_METHOD
-            DedicatedVaultCredentialsFactory.AUTHENTICATION_METHOD,
+            DedicatedVaultTokenFactory.AUTHENTICATION_METHOD,
             // Default value if none is specified:
             DedicatedVaultAuthenticationMethod.VAULT_TOKEN,
             DedicatedVaultConfigurationParameters::parseAuthentication)

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultdedicated/secrets/DedicatedVaultSecretsManagerFactory.java

@@ -42,7 +42,7 @@
 import oracle.jdbc.provider.factory.Resource;
 import oracle.jdbc.provider.factory.ResourceFactory;
 import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.DedicatedVaultResourceFactory;
-import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultCredentials;
+import oracle.jdbc.provider.hashicorp.hcpvaultdedicated.authentication.DedicatedVaultToken;
 import oracle.jdbc.provider.parameter.Parameter;
 import oracle.jdbc.provider.parameter.ParameterSet;
 import oracle.sql.json.OracleJsonFactory;
@@ -148,7 +148,7 @@ public static ResourceFactory<String> getInstance() {
   }
 
   @Override
-  public Resource<String> request(DedicatedVaultCredentials credentials, ParameterSet parameterSet) {
+  public Resource<String> request(DedicatedVaultToken credentials, ParameterSet parameterSet) {
     String secretPath = parameterSet.getRequired(SECRET_PATH);
     String vaultAddr = getRequiredOrFallback(parameterSet, VAULT_ADDR, "VAULT_ADDR");
 

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultsecret/HcpVaultResourceFactory.java

@@ -40,15 +40,15 @@
 
 import oracle.jdbc.provider.factory.Resource;
 import oracle.jdbc.provider.factory.ResourceFactory;
-import oracle.jdbc.provider.hashicorp.hcpvaultsecret.authentication.HcpVaultCredentials;
-import oracle.jdbc.provider.hashicorp.hcpvaultsecret.authentication.HcpVaultCredentialsFactory;
+import oracle.jdbc.provider.hashicorp.hcpvaultsecret.authentication.HcpVaultSecretToken;
+import oracle.jdbc.provider.hashicorp.hcpvaultsecret.authentication.HcpVaultTokenFactory;
 import oracle.jdbc.provider.parameter.ParameterSet;
 
 public abstract class HcpVaultResourceFactory<T> implements ResourceFactory<T> {
 
   @Override
   public final Resource<T> request(ParameterSet parameterSet) {
-    HcpVaultCredentials credentials = HcpVaultCredentialsFactory
+    HcpVaultSecretToken credentials = HcpVaultTokenFactory
       .getInstance()
       .request(parameterSet)
       .getContent();
@@ -62,5 +62,5 @@ public final Resource<T> request(ParameterSet parameterSet) {
   }
 
   public abstract Resource<T> request(
-          HcpVaultCredentials credentials, ParameterSet parameterSet);
+          HcpVaultSecretToken credentials, ParameterSet parameterSet);
 }

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultsecret/authentication/HcpVaultOAuthClient.java

@@ -38,7 +38,6 @@
 
 package oracle.jdbc.provider.hashicorp.hcpvaultsecret.authentication;
 
-import oracle.jdbc.driver.oauth.JsonWebToken;
 import oracle.sql.json.OracleJsonFactory;
 import oracle.sql.json.OracleJsonObject;
 
@@ -57,9 +56,6 @@
  */
 public final class HcpVaultOAuthClient {
 
-  // Default TTL fallback in seconds
-  private static long lastTokenTTL = 3_600;
-
   private HcpVaultOAuthClient() {}
 
   /**
@@ -98,7 +94,6 @@ public static String fetchHcpAccessToken(String clientId, String clientSecret) {
                   .createJsonTextValue(new ByteArrayInputStream(jsonResponse.getBytes(StandardCharsets.UTF_8)))
                   .asJsonObject();
 
-          System.out.println("fetching a new token "+ response.getString("access_token"));
           return response.getString("access_token");
         }
       } else {
@@ -113,7 +108,4 @@ public static String fetchHcpAccessToken(String clientId, String clientSecret) {
     }
   }
 
-  public static long getLastTokenTTL() {
-    return lastTokenTTL;
-  }
 }

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultsecret/authentication/HcpVaultCredentials.java ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultsecret/authentication/HcpVaultSecretToken.java

@@ -44,10 +44,10 @@
  * This class holds the API token obtained from the client_credentials OAuth2 flow.
  * </p>
  */
-public final class HcpVaultCredentials {
+public final class HcpVaultSecretToken {
   private final String hcpApiToken;
 
-  public HcpVaultCredentials(String hcpApiToken) {
+  public HcpVaultSecretToken(String hcpApiToken) {
     this.hcpApiToken = hcpApiToken;
   }
 

ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultsecret/authentication/HcpVaultCredentialsFactory.java ojdbc-provider-hashicorp/src/main/java/oracle/jdbc/provider/hashicorp/hcpvaultsecret/authentication/HcpVaultTokenFactory.java

@@ -40,26 +40,24 @@
 
 import oracle.jdbc.AccessToken;
 import oracle.jdbc.driver.oauth.JsonWebToken;
-import oracle.jdbc.provider.cache.CachedResourceFactory;
 import oracle.jdbc.provider.factory.Resource;
 import oracle.jdbc.provider.factory.ResourceFactory;
 import oracle.jdbc.provider.parameter.Parameter;
 import oracle.jdbc.provider.parameter.ParameterSet;
 
-import java.time.OffsetDateTime;
 import java.util.function.Supplier;
 
 import static oracle.jdbc.provider.parameter.Parameter.CommonAttribute.REQUIRED;
 import static oracle.jdbc.provider.util.ParameterUtil.getRequiredOrFallback;
 
 /**
- * A factory for creating {@link HcpVaultCredentials} objects for HCP Vault Secrets.
+ * A factory for creating {@link HcpVaultSecretToken} objects for HCP Vault Secrets.
  * <p>
  * This class implements the client_credentials flow for OAuth2 authentication, retrieving
  * an API token to interact with the HCP Vault Secrets API.
  * </p>
  */
-public final class HcpVaultCredentialsFactory implements ResourceFactory<HcpVaultCredentials> {
+public final class HcpVaultTokenFactory implements ResourceFactory<HcpVaultSecretToken> {
 
   /**
    * Parameter indicating the authentication method to use for HCP Vault Secrets.
@@ -76,26 +74,26 @@ public final class HcpVaultCredentialsFactory implements ResourceFactory<HcpVaul
    */
   public static final Parameter<String> CLIENT_SECRET = Parameter.create(REQUIRED);
 
-  private static final HcpVaultCredentialsFactory INSTANCE = new HcpVaultCredentialsFactory();
+  private static final HcpVaultTokenFactory INSTANCE = new HcpVaultTokenFactory();
 
   /**
    * Cached supplier for tokens.
    */
   private static Supplier<? extends AccessToken> cachedTokenSupplier;
 
-  private HcpVaultCredentialsFactory() {}
+  private HcpVaultTokenFactory() {}
 
-  public static HcpVaultCredentialsFactory getInstance() {
+  public static HcpVaultTokenFactory getInstance() {
     return INSTANCE;
   }
 
   @Override
-  public Resource<HcpVaultCredentials> request(ParameterSet parameterSet) {
-    HcpVaultCredentials credentials = getCredential(parameterSet);
+  public Resource<HcpVaultSecretToken> request(ParameterSet parameterSet) {
+    HcpVaultSecretToken credentials = getCredential(parameterSet);
     return Resource.createPermanentResource(credentials, true);
   }
 
-  private HcpVaultCredentials getCredential(ParameterSet parameterSet) {
+  private HcpVaultSecretToken getCredential(ParameterSet parameterSet) {
     HcpVaultAuthenticationMethod method = parameterSet.getRequired(AUTHENTICATION_METHOD);
 
     switch (method) {
@@ -106,9 +104,9 @@ private HcpVaultCredentials getCredential(ParameterSet parameterSet) {
     }
   }
 
-  private HcpVaultCredentials createClientCredentials(ParameterSet parameterSet) {
+  private HcpVaultSecretToken createClientCredentials(ParameterSet parameterSet) {
     if (cachedTokenSupplier == null) {
-      synchronized (HcpVaultCredentialsFactory.class) {
+      synchronized (HcpVaultTokenFactory.class) {
           cachedTokenSupplier = AccessToken.createJsonWebTokenCache(() -> {
             String clientId = getRequiredOrFallback(parameterSet, CLIENT_ID, "CLIENT_ID");
             String clientSecret = getRequiredOrFallback(parameterSet, CLIENT_SECRET, "CLIENT_SECRET");
@@ -119,14 +117,9 @@ private HcpVaultCredentials createClientCredentials(ParameterSet parameterSet) {
         }
     }
 
-    // Get the cached token
     AccessToken cachedToken = cachedTokenSupplier.get();
-
-    // Cast to JsonWebToken to access token and expiration methods
     JsonWebToken jwt = (JsonWebToken) cachedToken;
-
-    // Return credentials using the token
-    return new HcpVaultCredentials(jwt.token().get());
+    return new HcpVaultSecretToken(jwt.token().get());
   }
 
 }