jerryshao commented on code in PR #4995: URL: https://github.com/apache/gravitino/pull/4995#discussion_r1792745595
########## common/src/main/java/org/apache/gravitino/credential/Credential.java: ########## @@ -0,0 +1,62 @@ +/* + * 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.gravitino.credential; + +import com.google.common.collect.ImmutableMap; +import java.util.Map; + +/** Interface representing a credential with type, expiration time, and additional information. */ +public interface Credential { Review Comment: What is the purpose of put it to common package? ########## core/src/main/java/org/apache/gravitino/credential/CredentialProvider.java: ########## @@ -0,0 +1,58 @@ +/* + * 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.gravitino.credential; + +import java.util.Map; +import javax.annotation.Nullable; + +/** + * Interface for credential providers. + * + * <p>A credential provider is responsible for managing and retrieving credentials. + */ +public interface CredentialProvider { Review Comment: I think you can change to like `public interface Credential extends Closeable` to avoid defining `void stop()` here. ########## common/src/main/java/org/apache/gravitino/credential/Credential.java: ########## @@ -0,0 +1,62 @@ +/* + * 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.gravitino.credential; + +import com.google.common.collect.ImmutableMap; +import java.util.Map; + +/** Interface representing a credential with type, expiration time, and additional information. */ +public interface Credential { + + /** + * Returns the type of the credential. It should same with the credential type of the credential + * provider. + * + * @return the credential type as a String. + */ + String getCredentialType(); + + /** + * Returns the expiration time of the credential in seconds since the epoch, 0 means not expire. + * + * @return the expiration time as a long. + */ + long getExpireTimeSecs(); + + /** + * Returns credential information. + * + * @return a map of credential information. + */ + Map<String, String> getCredentialInfo(); Review Comment: I would suggest that you can refer to Hadoop's `Credentials`, `Token` and `TokenIdentifer` to see how to define our credential system. ########## common/src/main/java/org/apache/gravitino/credential/Credential.java: ########## @@ -0,0 +1,62 @@ +/* + * 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.gravitino.credential; + +import com.google.common.collect.ImmutableMap; +import java.util.Map; + +/** Interface representing a credential with type, expiration time, and additional information. */ +public interface Credential { + + /** + * Returns the type of the credential. It should same with the credential type of the credential + * provider. + * + * @return the credential type as a String. + */ + String getCredentialType(); + + /** + * Returns the expiration time of the credential in seconds since the epoch, 0 means not expire. + * + * @return the expiration time as a long. + */ + long getExpireTimeSecs(); + + /** + * Returns credential information. + * + * @return a map of credential information. + */ + Map<String, String> getCredentialInfo(); Review Comment: I would suggest change the style of `getXXX` to `xxx`, like `credentialType()`. ########## core/src/main/java/org/apache/gravitino/credential/CredentialProviderFactory.java: ########## @@ -0,0 +1,69 @@ +/* + * 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.gravitino.credential; + +import com.google.common.collect.Iterables; +import com.google.common.collect.Streams; +import java.util.List; +import java.util.Map; +import java.util.ServiceLoader; +import java.util.stream.Collectors; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class CredentialProviderFactory { + private static final Logger LOG = LoggerFactory.getLogger(CredentialProviderFactory.class); + + public static CredentialProvider create( + String credentialType, Map<String, String> catalogProperties) { + Class<? extends CredentialProvider> providerClz = lookupCredentialProvider(credentialType); + try { + CredentialProvider provider = providerClz.getDeclaredConstructor().newInstance(); + provider.initialize(catalogProperties); + return provider; + } catch (Exception e) { + LOG.warn("Create credential provider failed, {}", credentialType, e); + throw new RuntimeException(e); + } + } + + private static Class<? extends CredentialProvider> lookupCredentialProvider( + String credentialType) { + ClassLoader classLoader = Thread.currentThread().getContextClassLoader(); + ServiceLoader<CredentialProvider> serviceLoader = + ServiceLoader.load(CredentialProvider.class, classLoader); + List<Class<? extends CredentialProvider>> providers = + Streams.stream(serviceLoader.iterator()) Review Comment: What is the consideration of using service loader? ########## common/build.gradle.kts: ########## @@ -28,6 +28,7 @@ plugins { dependencies { implementation(project(":api")) + implementation(project(":catalogs:catalog-common")) Review Comment: The dependency here looks strange if you only want to define two properties in catalog-common, it is easy to introduce the cyclic dependency. ########## common/src/main/java/org/apache/gravitino/credential/Credential.java: ########## @@ -0,0 +1,62 @@ +/* + * 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.gravitino.credential; + +import com.google.common.collect.ImmutableMap; +import java.util.Map; + +/** Interface representing a credential with type, expiration time, and additional information. */ +public interface Credential { + + /** + * Returns the type of the credential. It should same with the credential type of the credential + * provider. + * + * @return the credential type as a String. + */ + String getCredentialType(); + + /** + * Returns the expiration time of the credential in seconds since the epoch, 0 means not expire. + * + * @return the expiration time as a long. + */ + long getExpireTimeSecs(); + + /** + * Returns credential information. + * + * @return a map of credential information. + */ + Map<String, String> getCredentialInfo(); Review Comment: Do we need to define an interface for `Token` like Hadoop? -- 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]
