Package org.apache.gravitino.credential

Class CredentialProviderDelegator<T extends Credential>

java.lang.Object

org.apache.gravitino.credential.CredentialProviderDelegator<T>

Type Parameters:

T - The type of credential generated by this provider.

All Implemented Interfaces:

Closeable, AutoCloseable, CredentialProvider

public abstract class CredentialProviderDelegator<T extends Credential>
extends Object
implements CredentialProvider

An abstract base class for CredentialProvider implementations that delegate the actual credential generation to a CredentialGenerator. It handles the lazy and reflective loading of the generator to isolate heavy dependencies.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	properties	The properties used by the generator to generate the credential.

Constructor Summary

Constructors

Constructor	Description
CredentialProviderDelegator()

Method Summary

Modifier and Type	Method	Description
void	close()
Credential	getCredential(CredentialContext context)	Delegates the credential generation to the loaded CredentialGenerator.
protected abstract String	getGeneratorClassName()	Returns the fully qualified class name of the CredentialGenerator implementation.
void	initialize(Map<String,String> properties)	Initializes the provider by storing properties and loading the associated CredentialGenerator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.gravitino.credential.CredentialProvider

credentialType, getCredentialOptional, supportsScheme

Field Details

properties

protected Map<String,String> properties

The properties used by the generator to generate the credential.

Constructor Details

CredentialProviderDelegator

public CredentialProviderDelegator()

Method Details

initialize

public void initialize(Map<String,String> properties)

Initializes the provider by storing properties and loading the associated CredentialGenerator.

Specified by:

initialize in interface CredentialProvider

Parameters:

properties - A map of configuration properties for the provider.

getCredential

@Nullable
public Credential getCredential(CredentialContext context)

Delegates the credential generation to the loaded CredentialGenerator.

Specified by:

getCredential in interface CredentialProvider

Parameters:

context - The context containing information required for credential retrieval.

Returns:

The generated Credential, or null if no credential is available.

Throws:

RuntimeException - if credential generation fails.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getGeneratorClassName

protected abstract String getGeneratorClassName()

Returns the fully qualified class name of the CredentialGenerator implementation. This generator will be loaded via reflection to perform the actual credential creation.

Returns:

The class name of the credential generator.