org.apache.gravitino.credential

Interface Credential

All Known Implementing Classes:

ADLSTokenCredential, AzureAccountKeyCredential, CredentialDTO, GCSTokenCredential, OSSSecretKeyCredential, OSSTokenCredential, S3SecretKeyCredential, S3TokenCredential

public interface Credential

Interface representing a credential with type, expiration time, and additional information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CREDENTIAL_TYPE Credential type in the credential.
static java.lang.String	EXPIRE_TIME_IN_MS Credential expire time in ms since the epoch.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	credentialInfo() Returns credential information.
java.lang.String	credentialType() Returns the type of the credential.
long	expireTimeInMs() Returns the expiration time of the credential in milliseconds since the epoch, 0 means not expire.
void	initialize(java.util.Map<java.lang.String,java.lang.String> credentialInfo, long expireTimeInMs) Initialize the credential with the credential information.
default java.util.Map<java.lang.String,java.lang.String>	toProperties() Converts the credential to properties to transfer the credential though API.

Field Detail

CREDENTIAL_TYPE

static final java.lang.String CREDENTIAL_TYPE

Credential type in the credential.

See Also:

Constant Field Values

EXPIRE_TIME_IN_MS

static final java.lang.String EXPIRE_TIME_IN_MS

Credential expire time in ms since the epoch.

See Also:

Constant Field Values

Method Detail

credentialType

java.lang.String credentialType()

Returns the type of the credential. It should be the same as the credential type of the credential provider.

Returns:

the credential type as a String.

expireTimeInMs

long expireTimeInMs()

Returns the expiration time of the credential in milliseconds since the epoch, 0 means not expire.

Returns:

the expiration time as a long.

credentialInfo

java.util.Map<java.lang.String,java.lang.String> credentialInfo()

Returns credential information.

Returns:

a map of credential information.

initialize

void initialize(java.util.Map<java.lang.String,java.lang.String> credentialInfo,
                long expireTimeInMs)

Initialize the credential with the credential information.

This method is invoked to deserialize the credential in client side.

Parameters:

credentialInfo - The credential information from credentialInfo().

expireTimeInMs - The expire-time from expireTimeInMs().

toProperties

default java.util.Map<java.lang.String,java.lang.String> toProperties()

Converts the credential to properties to transfer the credential though API.

Returns:

a map containing credential properties.