dennishuo commented on code in PR #1070: URL: https://github.com/apache/polaris/pull/1070#discussion_r1976364289
########## polaris-core/src/main/java/org/apache/polaris/core/persistence/IntegrationPersistence.java: ########## @@ -0,0 +1,129 @@ +/* + * 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.core.persistence; + +import jakarta.annotation.Nonnull; +import jakarta.annotation.Nullable; +import org.apache.polaris.core.PolarisCallContext; +import org.apache.polaris.core.entity.PolarisBaseEntity; +import org.apache.polaris.core.entity.PolarisPrincipalSecrets; +import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo; +import org.apache.polaris.core.storage.PolarisStorageIntegration; + +/** + * Interface for the necessary "peripheral integration" objects that are logically attached to core + * persistence entities but which typically involve additional separate external integrations + * related to identity/auth, kms/secrets storage, etc. + * + * <p>Implementations should orchestrate any necessary multi-phase protocols such as leasing an + * external resource before committing a reference to the external resource in the Polaris + * persistence layer, etc. + */ +public interface IntegrationPersistence { + /** + * Allows to retrieve to the secrets of a principal given its unique client id + * + * @param callCtx call context + * @param clientId principal client id + * @return the secrets + */ + @Nullable + PolarisPrincipalSecrets loadPrincipalSecrets( + @Nonnull PolarisCallContext callCtx, @Nonnull String clientId); + + /** + * generate and store a client id and associated secrets for a newly created principal entity + * + * @param callCtx call context + * @param principalName name of the principal + * @param principalId principal id + */ + @Nonnull + PolarisPrincipalSecrets generateNewPrincipalSecrets( Review Comment: This can be better standardized in the next few followups especially as we also add a `ConnectionConfigurationInfo` for Catalog Federation, but in general the idea is to leave room (maybe optionally) for the lower-level customizable logic to add persistence-related *book-keeping*, if secrets or integrations create heavyweight resources. In OpenCatalog, for example, the machinery might create an "OauthIntegration" in a separate subsystem to serve each new Polaris PrincipalEntity, and there would be a unique `integrationId` kept track of within the internalProperties of the PrincipalEntity, and likewise the `principalId` would be stored in the external OAuthIntegration. This does start getting into the realm of "type-specific extensions" to the underlying persistence model like was suggested in Yufei's proposal, but just in a more limited/low-level scope. Generally I'd agree though that these interfaces could use some refinement. I'm thinking one of our followup refactors can focus on this "integration provider" concept to make it more natural across implementations. Maybe it's not strictly a "persistence concern" ultimately, but just a "pluggable *integration object* framework that *may* interact with the core persistence model". -- 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]
