HonahX commented on code in PR #2759: URL: https://github.com/apache/polaris/pull/2759#discussion_r2408932846
########## runtime/service/src/main/java/org/apache/polaris/service/credentials/DefaultPolarisCredentialManager.java: ########## @@ -0,0 +1,92 @@ +/* + * 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 jakarta.annotation.Nonnull; +import jakarta.enterprise.inject.Any; +import jakarta.enterprise.inject.Instance; +import org.apache.polaris.core.connection.AuthenticationType; +import org.apache.polaris.core.connection.ConnectionConfigInfoDpo; +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.SupportsAuthType; +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>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> + */ +public class DefaultPolarisCredentialManager implements PolarisCredentialManager { + private static final Logger LOGGER = + LoggerFactory.getLogger(DefaultPolarisCredentialManager.class); + + private final Instance<ConnectionCredentialVendor> credentialVendors; + + public DefaultPolarisCredentialManager( + @Any Instance<ConnectionCredentialVendor> credentialVendors) { + this.credentialVendors = credentialVendors; + } + + @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(SupportsAuthType.Literal.of(authType)); + + if (selectedVendor.isUnsatisfied()) { + LOGGER.warn("No credential vendor found for authentication type: {}", authType); + return ConnectionCredentials.builder().build(); + } + + if (selectedVendor.isAmbiguous()) { + LOGGER.error( + "Multiple 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 credential vendor for authentication type: %s. " Review Comment: ```suggestion "Ambiguous connection credential vendor for authentication type: %s. " ``` ########## runtime/service/src/main/java/org/apache/polaris/service/credentials/DefaultPolarisCredentialManager.java: ########## @@ -0,0 +1,92 @@ +/* + * 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 jakarta.annotation.Nonnull; +import jakarta.enterprise.inject.Any; +import jakarta.enterprise.inject.Instance; +import org.apache.polaris.core.connection.AuthenticationType; +import org.apache.polaris.core.connection.ConnectionConfigInfoDpo; +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.SupportsAuthType; +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>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> + */ +public class DefaultPolarisCredentialManager implements PolarisCredentialManager { + private static final Logger LOGGER = + LoggerFactory.getLogger(DefaultPolarisCredentialManager.class); + + private final Instance<ConnectionCredentialVendor> credentialVendors; + + public DefaultPolarisCredentialManager( + @Any Instance<ConnectionCredentialVendor> credentialVendors) { + this.credentialVendors = credentialVendors; + } + + @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(SupportsAuthType.Literal.of(authType)); + + if (selectedVendor.isUnsatisfied()) { + LOGGER.warn("No credential vendor found for authentication type: {}", authType); Review Comment: ```suggestion LOGGER.warn("No connection credential vendor found for authentication type: {}", authType); ``` Also as we probably do not need connection credential vendor for OAUTH and BEARER in most cases, do you think it makes sense to provide noop implementation for them to silence this warning? Otherwise it may confuse user when they see this warning but they have configured everything as expected? ########## runtime/service/src/main/java/org/apache/polaris/service/credentials/DefaultPolarisCredentialManager.java: ########## @@ -0,0 +1,92 @@ +/* + * 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 jakarta.annotation.Nonnull; +import jakarta.enterprise.inject.Any; +import jakarta.enterprise.inject.Instance; +import org.apache.polaris.core.connection.AuthenticationType; +import org.apache.polaris.core.connection.ConnectionConfigInfoDpo; +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.SupportsAuthType; +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>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> + */ +public class DefaultPolarisCredentialManager implements PolarisCredentialManager { + private static final Logger LOGGER = + LoggerFactory.getLogger(DefaultPolarisCredentialManager.class); + + private final Instance<ConnectionCredentialVendor> credentialVendors; + + public DefaultPolarisCredentialManager( + @Any Instance<ConnectionCredentialVendor> credentialVendors) { + this.credentialVendors = credentialVendors; + } + + @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(SupportsAuthType.Literal.of(authType)); + + if (selectedVendor.isUnsatisfied()) { + LOGGER.warn("No credential vendor found for authentication type: {}", authType); + return ConnectionCredentials.builder().build(); + } + + if (selectedVendor.isAmbiguous()) { + LOGGER.error( + "Multiple credential vendors found for authentication type: {}. " Review Comment: ```suggestion "Multiple connection credential vendors found for authentication type: {}. " ``` [nit] Shall we state this is connection credential vendor, given that we are planning to bring StorageCredentialVendor in the manager? -- 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]
