Package org.apache.gravitino.credential

Class GCSTokenCredential

java.lang.Object

org.apache.gravitino.credential.GCSTokenCredential

All Implemented Interfaces:

Credential

public class GCSTokenCredential
extends Object
implements Credential

The GCS token credential to access GCS.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GCS_TOKEN_CREDENTIAL_TYPE	GCS credential type.
static final String	GCS_TOKEN_NAME	GCS credential property, token name.

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

CREDENTIAL_TYPE, EXPIRE_TIME_IN_MS

Constructor Summary

Constructors

Constructor	Description
GCSTokenCredential()	This is the constructor that is used by credential factory to create an instance of credential according to the credential information.
GCSTokenCredential(String token, long expireTimeInMs)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	credentialInfo()	Returns credential information.
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(Map<String,String> credentialInfo, long expireTimeInMs)	Initialize the credential with the credential information.
String	token()	Get GCS 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 Details

GCS_TOKEN_CREDENTIAL_TYPE

public static final String GCS_TOKEN_CREDENTIAL_TYPE

GCS credential type.

See Also:

• Constant Field Values

GCS_TOKEN_NAME

public static final String GCS_TOKEN_NAME

GCS credential property, token name.

See Also:

• Constant Field Values

Constructor Details

GCSTokenCredential

public GCSTokenCredential(String token,
 long expireTimeInMs)

Parameters:

token - The GCS token.

expireTimeInMs - The GCS token expire time at ms.

GCSTokenCredential

public GCSTokenCredential()

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

Method Details

credentialType

public 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 Map<String,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(Map<String,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().

token

public String token()

Get GCS token.

Returns:

The GCS token.