Skip to content

Commit 144700b

Browse files
committed
rename AccessConfig for clarity
1 parent 895a6e4 commit 144700b

File tree

34 files changed

+191
-189
lines changed

34 files changed

+191
-189
lines changed

polaris-core/src/main/java/org/apache/polaris/core/credentials/connection/ConnectionCredentials.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@
2222
import java.time.Instant;
2323
import java.util.Map;
2424
import java.util.Optional;
25-
import org.apache.polaris.core.storage.AccessConfig;
25+
import org.apache.polaris.core.storage.StorageAccessConfig;
2626
import org.apache.polaris.immutables.PolarisImmutable;
2727

2828
/**
2929
* Encapsulates credentials and configuration needed to connect to external federated catalogs.
3030
*
31-
* <p>Similar to {@link AccessConfig} for storage, this class holds the credentials and properties
32-
* required for Polaris to authenticate with remote catalog services (e.g., AWS Glue, other Iceberg
33-
* REST catalogs).
31+
* <p>Similar to {@link StorageAccessConfig} for storage, this class holds the credentials and
32+
* properties required for Polaris to authenticate with remote catalog services (e.g., AWS Glue,
33+
* other Iceberg REST catalogs).
3434
*
3535
* <p>Credentials may be temporary and include an expiration time.
3636
*
3737
* <p><b>Note:</b> This interface currently includes only {@code credentials} and {@code expiresAt}.
3838
* Additional fields like {@code extraProperties} and {@code internalProperties} (similar to {@link
39-
* AccessConfig}) are not included for now but can be added later if needed for more complex
39+
* StorageAccessConfig}) are not included for now but can be added later if needed for more complex
4040
* credential scenarios.
4141
*/
4242
@PolarisImmutable

polaris-core/src/main/java/org/apache/polaris/core/persistence/AtomicOperationMetaStoreManager.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@
7575
import org.apache.polaris.core.policy.PolicyEntity;
7676
import org.apache.polaris.core.policy.PolicyMappingUtil;
7777
import org.apache.polaris.core.policy.PolicyType;
78-
import org.apache.polaris.core.storage.AccessConfig;
7978
import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
8079
import org.apache.polaris.core.storage.PolarisStorageIntegration;
80+
import org.apache.polaris.core.storage.StorageAccessConfig;
8181
import org.slf4j.Logger;
8282
import org.slf4j.LoggerFactory;
8383

@@ -1633,14 +1633,14 @@ private void revokeGrantRecord(
16331633
entityId);
16341634

16351635
try {
1636-
AccessConfig accessConfig =
1636+
StorageAccessConfig storageAccessConfig =
16371637
storageIntegration.getSubscopedCreds(
16381638
callCtx.getRealmConfig(),
16391639
allowListOperation,
16401640
allowedReadLocations,
16411641
allowedWriteLocations,
16421642
refreshCredentialsEndpoint);
1643-
return new ScopedCredentialsResult(accessConfig);
1643+
return new ScopedCredentialsResult(storageAccessConfig);
16441644
} catch (Exception ex) {
16451645
return new ScopedCredentialsResult(
16461646
BaseResult.ReturnStatus.SUBSCOPE_CREDS_ERROR, ex.getMessage());

polaris-core/src/main/java/org/apache/polaris/core/persistence/dao/entity/ScopedCredentialsResult.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@
2020

2121
import jakarta.annotation.Nonnull;
2222
import jakarta.annotation.Nullable;
23-
import org.apache.polaris.core.storage.AccessConfig;
23+
import org.apache.polaris.core.storage.StorageAccessConfig;
2424

2525
/** Result of a getSubscopedCredsForEntity() call */
2626
public class ScopedCredentialsResult extends BaseResult {
2727

2828
// null if not success. Else, set of name/value pairs for the credentials
29-
private final AccessConfig accessConfig;
29+
private final StorageAccessConfig storageAccessConfig;
3030

3131
/**
3232
* Constructor for an error
@@ -37,20 +37,20 @@ public class ScopedCredentialsResult extends BaseResult {
3737
public ScopedCredentialsResult(
3838
@Nonnull ReturnStatus errorCode, @Nullable String extraInformation) {
3939
super(errorCode, extraInformation);
40-
this.accessConfig = null;
40+
this.storageAccessConfig = null;
4141
}
4242

4343
/**
4444
* Constructor for success
4545
*
46-
* @param accessConfig credentials
46+
* @param storageAccessConfig credentials
4747
*/
48-
public ScopedCredentialsResult(AccessConfig accessConfig) {
48+
public ScopedCredentialsResult(StorageAccessConfig storageAccessConfig) {
4949
super(ReturnStatus.SUCCESS);
50-
this.accessConfig = accessConfig;
50+
this.storageAccessConfig = storageAccessConfig;
5151
}
5252

53-
public AccessConfig getAccessConfig() {
54-
return accessConfig;
53+
public StorageAccessConfig getAccessConfig() {
54+
return storageAccessConfig;
5555
}
5656
}

polaris-core/src/main/java/org/apache/polaris/core/persistence/transactional/TransactionalMetaStoreManagerImpl.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,9 @@
7979
import org.apache.polaris.core.policy.PolicyEntity;
8080
import org.apache.polaris.core.policy.PolicyMappingUtil;
8181
import org.apache.polaris.core.policy.PolicyType;
82-
import org.apache.polaris.core.storage.AccessConfig;
8382
import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
8483
import org.apache.polaris.core.storage.PolarisStorageIntegration;
84+
import org.apache.polaris.core.storage.StorageAccessConfig;
8585
import org.slf4j.Logger;
8686
import org.slf4j.LoggerFactory;
8787

@@ -2125,14 +2125,14 @@ private PolarisEntityResolver resolveSecurableToRoleGrant(
21252125
entityId);
21262126

21272127
try {
2128-
AccessConfig accessConfig =
2128+
StorageAccessConfig storageAccessConfig =
21292129
storageIntegration.getSubscopedCreds(
21302130
callCtx.getRealmConfig(),
21312131
allowListOperation,
21322132
allowedReadLocations,
21332133
allowedWriteLocations,
21342134
refreshCredentialsEndpoint);
2135-
return new ScopedCredentialsResult(accessConfig);
2135+
return new ScopedCredentialsResult(storageAccessConfig);
21362136
} catch (Exception ex) {
21372137
return new ScopedCredentialsResult(
21382138
BaseResult.ReturnStatus.SUBSCOPE_CREDS_ERROR, ex.getMessage());

polaris-core/src/main/java/org/apache/polaris/core/storage/PolarisStorageIntegration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public String getStorageIdentifierOrId() {
6262
* handling the relative path
6363
* @return An enum map including the scoped credentials
6464
*/
65-
public abstract AccessConfig getSubscopedCreds(
65+
public abstract StorageAccessConfig getSubscopedCreds(
6666
@Nonnull RealmConfig realmConfig,
6767
boolean allowListOperation,
6868
@Nonnull Set<String> allowedReadLocations,

polaris-core/src/main/java/org/apache/polaris/core/storage/AccessConfig.java renamed to polaris-core/src/main/java/org/apache/polaris/core/storage/StorageAccessConfig.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import org.immutables.value.Value;
2727

2828
@PolarisImmutable
29-
public interface AccessConfig {
29+
public interface StorageAccessConfig {
3030
Map<String, String> credentials();
3131

3232
Map<String, String> extraProperties();
@@ -57,8 +57,8 @@ default String get(StorageAccessProperty key) {
5757
}
5858
}
5959

60-
static AccessConfig.Builder builder() {
61-
return ImmutableAccessConfig.builder();
60+
static StorageAccessConfig.Builder builder() {
61+
return ImmutableStorageAccessConfig.builder();
6262
}
6363

6464
interface Builder {
@@ -89,6 +89,6 @@ default Builder put(StorageAccessProperty key, String value) {
8989
}
9090
}
9191

92-
AccessConfig build();
92+
StorageAccessConfig build();
9393
}
9494
}

polaris-core/src/main/java/org/apache/polaris/core/storage/aws/AwsCredentialsStorageIntegration.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
import java.util.Set;
2929
import java.util.stream.Stream;
3030
import org.apache.polaris.core.config.RealmConfig;
31-
import org.apache.polaris.core.storage.AccessConfig;
3231
import org.apache.polaris.core.storage.InMemoryStorageIntegration;
32+
import org.apache.polaris.core.storage.StorageAccessConfig;
3333
import org.apache.polaris.core.storage.StorageAccessProperty;
3434
import org.apache.polaris.core.storage.StorageUtil;
3535
import org.apache.polaris.core.storage.aws.StsClientProvider.StsDestination;
@@ -70,7 +70,7 @@ public AwsCredentialsStorageIntegration(
7070

7171
/** {@inheritDoc} */
7272
@Override
73-
public AccessConfig getSubscopedCreds(
73+
public StorageAccessConfig getSubscopedCreds(
7474
@Nonnull RealmConfig realmConfig,
7575
boolean allowListOperation,
7676
@Nonnull Set<String> allowedReadLocations,
@@ -80,7 +80,7 @@ public AccessConfig getSubscopedCreds(
8080
realmConfig.getConfig(STORAGE_CREDENTIAL_DURATION_SECONDS);
8181
AwsStorageConfigurationInfo storageConfig = config();
8282
String region = storageConfig.getRegion();
83-
AccessConfig.Builder accessConfig = AccessConfig.builder();
83+
StorageAccessConfig.Builder accessConfig = StorageAccessConfig.builder();
8484

8585
if (shouldUseSts(storageConfig)) {
8686
AssumeRoleRequest.Builder request =

polaris-core/src/main/java/org/apache/polaris/core/storage/azure/AzureCredentialsStorageIntegration.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@
4949
import java.util.Optional;
5050
import java.util.Set;
5151
import org.apache.polaris.core.config.RealmConfig;
52-
import org.apache.polaris.core.storage.AccessConfig;
5352
import org.apache.polaris.core.storage.InMemoryStorageIntegration;
53+
import org.apache.polaris.core.storage.StorageAccessConfig;
5454
import org.apache.polaris.core.storage.StorageAccessProperty;
5555
import org.slf4j.Logger;
5656
import org.slf4j.LoggerFactory;
@@ -73,7 +73,7 @@ public AzureCredentialsStorageIntegration(AzureStorageConfigurationInfo config)
7373
}
7474

7575
@Override
76-
public AccessConfig getSubscopedCreds(
76+
public StorageAccessConfig getSubscopedCreds(
7777
@Nonnull RealmConfig realmConfig,
7878
boolean allowListOperation,
7979
@Nonnull Set<String> allowedReadLocations,
@@ -176,12 +176,12 @@ public AccessConfig getSubscopedCreds(
176176
}
177177

178178
@VisibleForTesting
179-
static AccessConfig toAccessConfig(
179+
static StorageAccessConfig toAccessConfig(
180180
String sasToken,
181181
String storageDnsName,
182182
Instant expiresAt,
183183
Optional<String> refreshCredentialsEndpoint) {
184-
AccessConfig.Builder accessConfig = AccessConfig.builder();
184+
StorageAccessConfig.Builder accessConfig = StorageAccessConfig.builder();
185185
handleAzureCredential(accessConfig, sasToken, storageDnsName, expiresAt);
186186
accessConfig.put(
187187
StorageAccessProperty.EXPIRATION_TIME, String.valueOf(expiresAt.toEpochMilli()));
@@ -193,7 +193,7 @@ static AccessConfig toAccessConfig(
193193
}
194194

195195
private static void handleAzureCredential(
196-
AccessConfig.Builder config, String sasToken, String host, Instant expiresAt) {
196+
StorageAccessConfig.Builder config, String sasToken, String host, Instant expiresAt) {
197197
config.putCredential(StorageAccessProperty.AZURE_SAS_TOKEN.getPropertyName() + host, sasToken);
198198
config.putCredential(
199199
StorageAccessProperty.AZURE_SAS_TOKEN_EXPIRES_AT_MS_PREFIX.getPropertyName() + host,

polaris-core/src/main/java/org/apache/polaris/core/storage/cache/StorageCredentialCache.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@
3737
import org.apache.polaris.core.entity.PolarisEntity;
3838
import org.apache.polaris.core.entity.PolarisEntityType;
3939
import org.apache.polaris.core.persistence.dao.entity.ScopedCredentialsResult;
40-
import org.apache.polaris.core.storage.AccessConfig;
4140
import org.apache.polaris.core.storage.PolarisCredentialVendor;
41+
import org.apache.polaris.core.storage.StorageAccessConfig;
4242
import org.slf4j.Logger;
4343
import org.slf4j.LoggerFactory;
4444

@@ -103,7 +103,7 @@ private long maxCacheDurationMs(RealmConfig realmConfig) {
103103
* @param allowedWriteLocations a set of allowed to write locations.
104104
* @return the a map of string containing the scoped creds information
105105
*/
106-
public AccessConfig getOrGenerateSubScopeCreds(
106+
public StorageAccessConfig getOrGenerateSubScopeCreds(
107107
@Nonnull PolarisCredentialVendor credentialVendor,
108108
@Nonnull PolarisCallContext callCtx,
109109
@Nonnull PolarisEntity polarisEntity,
@@ -156,11 +156,11 @@ public AccessConfig getOrGenerateSubScopeCreds(
156156
@VisibleForTesting
157157
@Nullable
158158
Map<String, String> getIfPresent(StorageCredentialCacheKey key) {
159-
return getAccessConfig(key).map(AccessConfig::credentials).orElse(null);
159+
return getAccessConfig(key).map(StorageAccessConfig::credentials).orElse(null);
160160
}
161161

162162
@VisibleForTesting
163-
Optional<AccessConfig> getAccessConfig(StorageCredentialCacheKey key) {
163+
Optional<StorageAccessConfig> getAccessConfig(StorageCredentialCacheKey key) {
164164
return Optional.ofNullable(cache.getIfPresent(key))
165165
.map(StorageCredentialCacheEntry::toAccessConfig);
166166
}

polaris-core/src/main/java/org/apache/polaris/core/storage/cache/StorageCredentialCacheEntry.java

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,18 @@
1919
package org.apache.polaris.core.storage.cache;
2020

2121
import java.time.Instant;
22-
import org.apache.polaris.core.storage.AccessConfig;
22+
import org.apache.polaris.core.storage.StorageAccessConfig;
2323

2424
/** A storage credential cached entry. */
2525
public class StorageCredentialCacheEntry {
2626
/** The scoped creds map that is fetched from a creds vending service */
27-
public final AccessConfig accessConfig;
27+
public final StorageAccessConfig storageAccessConfig;
2828

2929
private final long maxCacheDurationMs;
3030

31-
public StorageCredentialCacheEntry(AccessConfig accessConfig, long maxCacheDurationMs) {
32-
this.accessConfig = accessConfig;
31+
public StorageCredentialCacheEntry(
32+
StorageAccessConfig storageAccessConfig, long maxCacheDurationMs) {
33+
this.storageAccessConfig = storageAccessConfig;
3334
this.maxCacheDurationMs = maxCacheDurationMs;
3435
}
3536

@@ -39,15 +40,15 @@ public long getMaxCacheDurationMs() {
3940

4041
/** Get the expiration time in millisecond for the cached entry */
4142
public long getExpirationTime() {
42-
return accessConfig.expiresAt().map(Instant::toEpochMilli).orElse(Long.MAX_VALUE);
43+
return storageAccessConfig.expiresAt().map(Instant::toEpochMilli).orElse(Long.MAX_VALUE);
4344
}
4445

4546
/**
4647
* Get the map of string creds that is needed for the query engine.
4748
*
4849
* @return a map of string representing the subscoped creds info.
4950
*/
50-
AccessConfig toAccessConfig() {
51-
return accessConfig;
51+
StorageAccessConfig toAccessConfig() {
52+
return storageAccessConfig;
5253
}
5354
}

0 commit comments

Comments
 (0)