org.apache.gravitino.credential

Class S3TokenCredential

java.lang.Object

org.apache.gravitino.credential.S3TokenCredential

All Implemented Interfaces:

Credential

public class S3TokenCredential
extends java.lang.Object
implements Credential

S3 token credential.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRAVITINO_S3_SESSION_ACCESS_KEY_ID S3 session access key ID used to access S3 data.
static java.lang.String	GRAVITINO_S3_SESSION_SECRET_ACCESS_KEY S3 session secret access key used to access S3 data.
static java.lang.String	GRAVITINO_S3_TOKEN S3 session token.
static java.lang.String	S3_TOKEN_CREDENTIAL_TYPE S3 token credential type.

Fields inherited from interface org.apache.gravitino.credential.Credential

CREDENTIAL_TYPE, EXPIRE_TIME_IN_MS

Constructor Summary

Constructors

Constructor and Description
S3TokenCredential() This is the constructor that is used by credential factory to create an instance of credential according to the credential information.
S3TokenCredential(java.lang.String accessKeyId, java.lang.String secretAccessKey, java.lang.String sessionToken, long expireTimeInMS) Constructs an instance of S3SecretKeyCredential with session secret key and token.

Method Summary

Modifier and Type	Method and Description
java.lang.String	accessKeyId() Get S3 session access key ID.
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.
java.lang.String	secretAccessKey() Get S3 session secret access key.
java.lang.String	sessionToken() Get S3 session token.

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.Credential

toProperties

Field Detail

S3_TOKEN_CREDENTIAL_TYPE

public static final java.lang.String S3_TOKEN_CREDENTIAL_TYPE

S3 token credential type.

See Also:

Constant Field Values

GRAVITINO_S3_SESSION_ACCESS_KEY_ID

public static final java.lang.String GRAVITINO_S3_SESSION_ACCESS_KEY_ID

S3 session access key ID used to access S3 data.

See Also:

Constant Field Values

GRAVITINO_S3_SESSION_SECRET_ACCESS_KEY

public static final java.lang.String GRAVITINO_S3_SESSION_SECRET_ACCESS_KEY

S3 session secret access key used to access S3 data.

See Also:

Constant Field Values

GRAVITINO_S3_TOKEN

public static final java.lang.String GRAVITINO_S3_TOKEN

S3 session token.

See Also:

Constant Field Values

Constructor Detail

S3TokenCredential

public S3TokenCredential(java.lang.String accessKeyId,
                         java.lang.String secretAccessKey,
                         java.lang.String sessionToken,
                         long expireTimeInMS)

Constructs an instance of S3SecretKeyCredential with session secret key and token.

Parameters:

accessKeyId - The S3 session access key ID.

secretAccessKey - The S3 session secret access key.

sessionToken - The S3 session token.

expireTimeInMS - The S3 session token expire time in ms.

S3TokenCredential

public S3TokenCredential()

This is the constructor that is used by credential factory to create an instance of credential according to the credential information.

Method Detail

credentialType

public java.lang.String credentialType()

Description copied from interface: Credential

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

Specified by:

credentialType in interface Credential

Returns:

the credential type as a String.

expireTimeInMs

public long expireTimeInMs()

Description copied from interface: Credential

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

Specified by:

expireTimeInMs in interface Credential

Returns:

the expiration time as a long.

credentialInfo

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

Description copied from interface: Credential

Returns credential information.

Specified by:

credentialInfo in interface Credential

Returns:

a map of credential information.

initialize

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

Description copied from interface: Credential

Initialize the credential with the credential information.

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

Specified by:

initialize in interface Credential

Parameters:

credentialInfo - The credential information from Credential.credentialInfo().

expireTimeInMs - The expire-time from Credential.expireTimeInMs().

accessKeyId

public java.lang.String accessKeyId()

Get S3 session access key ID.

Returns:

The S3 access key ID.

secretAccessKey

public java.lang.String secretAccessKey()

Get S3 session secret access key.

Returns:

The S3 secret access key.

sessionToken

public java.lang.String sessionToken()

Get S3 session token.

Returns:

The S3 session token.