XJDKC commented on code in PR #2759: URL: https://github.com/apache/polaris/pull/2759#discussion_r2412178175
########## runtime/service/src/main/java/org/apache/polaris/service/credentials/DefaultPolarisCredentialManager.java: ########## @@ -0,0 +1,109 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +package org.apache.polaris.service.credentials; + +import io.smallrye.common.annotation.Identifier; +import jakarta.annotation.Nonnull; +import jakarta.enterprise.context.RequestScoped; +import jakarta.enterprise.inject.Any; +import jakarta.enterprise.inject.Instance; +import jakarta.inject.Inject; +import org.apache.polaris.core.connection.AuthenticationType; +import org.apache.polaris.core.connection.ConnectionConfigInfoDpo; +import org.apache.polaris.core.context.RealmContext; +import org.apache.polaris.core.credentials.PolarisCredentialManager; +import org.apache.polaris.core.credentials.connection.ConnectionCredentialVendor; +import org.apache.polaris.core.credentials.connection.ConnectionCredentials; +import org.apache.polaris.service.credentials.connection.AuthType; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Default implementation of {@link PolarisCredentialManager} responsible for retrieving credentials + * used by Polaris to access external systems such as remote catalogs or cloud storage. + * + * <p>This implementation delegates to {@link ConnectionCredentialVendor} implementations selected + * via CDI based on the authentication type. Each vendor handles the credential transformation logic + * for a specific authentication mechanism (e.g., SigV4, OAuth). + * + * <p>This bean is request-scoped and realm-aware, delegating all credential generation to + * CDI-managed vendors. + * + * <p>Flow: + * + * <ol> + * <li>Selects the appropriate {@link ConnectionCredentialVendor} based on the authentication type + * <li>Delegates to the vendor to generate the final connection credentials (the vendor will + * resolve the service identity internally) + * </ol> + */ +@RequestScoped +@Identifier("default") +public class DefaultPolarisCredentialManager implements PolarisCredentialManager { + private static final Logger LOGGER = + LoggerFactory.getLogger(DefaultPolarisCredentialManager.class); + + private final RealmContext realmContext; + private final Instance<ConnectionCredentialVendor> credentialVendors; + + @Inject + public DefaultPolarisCredentialManager( + RealmContext realmContext, @Any Instance<ConnectionCredentialVendor> credentialVendors) { + this.realmContext = realmContext; + this.credentialVendors = credentialVendors; + } + + public RealmContext getRealmContext() { + return realmContext; + } + + @Override + public @Nonnull ConnectionCredentials getConnectionCredentials( + @Nonnull ConnectionConfigInfoDpo connectionConfig) { + + // Select the appropriate vendor based on authentication type + AuthenticationType authType = + connectionConfig.getAuthenticationParameters().getAuthenticationType(); + Instance<ConnectionCredentialVendor> selectedVendor = + credentialVendors.select(AuthType.Literal.of(authType)); + + if (selectedVendor.isUnsatisfied()) { + // TODO: Add credential vendors for other authentication types + LOGGER.warn("No connection credential vendor found for authentication type: {}", authType); + return ConnectionCredentials.builder().build(); + } + + if (selectedVendor.isAmbiguous()) { + LOGGER.error( + "Multiple connection credential vendors found for authentication type: {}. " + + "Use @Priority to specify which vendor should be used. " + + "Higher priority values take precedence.", + authType); + throw new IllegalStateException( + String.format( + "Ambiguous connection credential vendor for authentication type: %s. " + + "Multiple implementations found without @Priority annotation.", + authType)); + } + + // Delegate to the vendor to generate credentials + return selectedVendor.get().getConnectionCredentials(connectionConfig); Review Comment: IIUC, you're suggesting something like: ```java // Make DefaultPolarisCredentialManager implement both vendor interfaces directly class DefaultPolarisCredentialManager implements ConnectionCredentialVendor, StorageCredentialVendor {} @Inject ConnectionCredentialVendor credentialVendor; // CDI will create a DefaultPolarisCredentialManager for us ``` That makes sense at first glance, but there are two key issues with this approach: 1. Ambiguity in CDI injection We'll have multiple `ConnectionCredentialVendor` implementations (e.g., SigV4ConnectionCredentialVendor, OAuthConnectionCredentialVendor, etc.), each responsible for a specific auth type. If we rely on injecting `ConnectionCredentialVendor`, CDI won't know which implementation to provide, `DefaultPolarisCredentialManager` or one of the specific vendors. Having an explicit `PolarisCredentialManager` abstraction ensures CDI can inject the central manager that multiplexes across vendors and delegates to the right one internally. 2. Centralized abstraction for all credential logic `PolarisCredentialManager` is designed to be the central interface (and later, the main entry point) for all credential management, including caching, vendor selection, and storage-related logic. It might look unnecessary right now since most logic still lives in `SigV4ConnectionCredentialVendor`, but defining the interface early helps keep a clean architecture and avoids major refactors once more vendor types and caching logic are introduced. 3. Enable vendor extension By defining a `PolarisCredentialManager` interface, individual vendors (e.g., custom or third-party ones) can extend this interface if they want. This allows them to hook into their own credential management pipeline more easily. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
