org.apache.gravitino.credential

Class OSSSecretKeyCredential

java.lang.Object

org.apache.gravitino.credential.OSSSecretKeyCredential

All Implemented Interfaces:

Credential

public class OSSSecretKeyCredential
extends java.lang.Object
implements Credential

OSS secret key credential.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRAVITINO_OSS_STATIC_ACCESS_KEY_ID The static access key ID used to access OSS data.
static java.lang.String	GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY The static secret access key used to access OSS data.
static java.lang.String	OSS_SECRET_KEY_CREDENTIAL_TYPE OSS secret key credential type.

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

CREDENTIAL_TYPE, EXPIRE_TIME_IN_MS

Constructor Summary

Constructors

Constructor and Description
OSSSecretKeyCredential() This is the constructor that is used by credential factory to create an instance of credential according to the credential information.
OSSSecretKeyCredential(java.lang.String accessKeyId, java.lang.String secretAccessKey) Constructs an instance of OSSSecretKeyCredential with the static OSS access key ID and secret access key.

Method Summary

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

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_SECRET_KEY_CREDENTIAL_TYPE

public static final java.lang.String OSS_SECRET_KEY_CREDENTIAL_TYPE

OSS secret key credential type.

See Also:

Constant Field Values

GRAVITINO_OSS_STATIC_ACCESS_KEY_ID

public static final java.lang.String GRAVITINO_OSS_STATIC_ACCESS_KEY_ID

The static access key ID used to access OSS data.

See Also:

Constant Field Values

GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY

public static final java.lang.String GRAVITINO_OSS_STATIC_SECRET_ACCESS_KEY

The static secret access key used to access OSS data.

See Also:

Constant Field Values

Constructor Detail

OSSSecretKeyCredential

public OSSSecretKeyCredential(java.lang.String accessKeyId,
                              java.lang.String secretAccessKey)

Constructs an instance of OSSSecretKeyCredential with the static OSS access key ID and secret access key.

Parameters:

accessKeyId - The OSS static access key ID.

secretAccessKey - The OSS static secret access key.

OSSSecretKeyCredential

public OSSSecretKeyCredential()

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)

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 credentialInfo().

expireTimeInMs - The expire-time from expireTimeInMs().

accessKeyId

public java.lang.String accessKeyId()

Get OSS static access key ID.

Returns:

The OSS access key ID.

secretAccessKey

public java.lang.String secretAccessKey()

Get OSS static secret access key.

Returns:

The OSS secret access key.