org.apache.gravitino.credential

Class OSSTokenCredential

java.lang.Object

org.apache.gravitino.credential.OSSTokenCredential

All Implemented Interfaces:

Credential

public class OSSTokenCredential
extends java.lang.Object
implements Credential

OSS token credential.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRAVITINO_OSS_SESSION_ACCESS_KEY_ID OSS access key ID used to access OSS data.
static java.lang.String	GRAVITINO_OSS_SESSION_SECRET_ACCESS_KEY OSS secret access key used to access OSS data.
static java.lang.String	GRAVITINO_OSS_TOKEN OSS security token.
static java.lang.String	OSS_TOKEN_CREDENTIAL_TYPE OSS token credential type.

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

CREDENTIAL_TYPE, EXPIRE_TIME_IN_MS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	accessKeyId() Get oss 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 oss secret access key.
java.lang.String	securityToken() Get oss security 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

OSS_TOKEN_CREDENTIAL_TYPE

public static final java.lang.String OSS_TOKEN_CREDENTIAL_TYPE

OSS token credential type.

See Also:

Constant Field Values

GRAVITINO_OSS_SESSION_ACCESS_KEY_ID

public static final java.lang.String GRAVITINO_OSS_SESSION_ACCESS_KEY_ID

OSS access key ID used to access OSS data.

See Also:

Constant Field Values

GRAVITINO_OSS_SESSION_SECRET_ACCESS_KEY

public static final java.lang.String GRAVITINO_OSS_SESSION_SECRET_ACCESS_KEY

OSS secret access key used to access OSS data.

See Also:

Constant Field Values

GRAVITINO_OSS_TOKEN

public static final java.lang.String GRAVITINO_OSS_TOKEN

OSS security token.

See Also:

Constant Field Values

Constructor Detail

OSSTokenCredential

public OSSTokenCredential(java.lang.String accessKeyId,
                          java.lang.String secretAccessKey,
                          java.lang.String securityToken,
                          long expireTimeInMS)

Constructs an instance of OSSTokenCredential with secret key and token.

Parameters:

accessKeyId - The oss access key ID.

secretAccessKey - The oss secret access key.

securityToken - The oss security token.

expireTimeInMS - The oss token expire time in ms.

OSSTokenCredential

public OSSTokenCredential()

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 oss access key ID.

Returns:

The oss access key ID.

secretAccessKey

public java.lang.String secretAccessKey()

Get oss secret access key.

Returns:

The oss secret access key.

securityToken

public java.lang.String securityToken()

Get oss security token.

Returns:

The oss security token.