Package com.volcengine.auth

Class EcsRoleCredentialProvider

java.lang.Object

com.volcengine.auth.EcsRoleCredentialProvider

All Implemented Interfaces:

Provider

public class EcsRoleCredentialProvider
extends Object
implements Provider

Provider that fetches temporary credentials from the ECS IMDS.

Follows the Provider CQS contract:

• isExpired() / retrieve() are pure reads.
• refresh() is the only method that mutates state.

Intended to be wrapped in a CredentialProvider, which serializes refresh through a ReadWriteLock and guarantees the isExpired → refresh → retrieve sequence. Direct use (without wrapping) is not a supported mode.

Constructor Summary

Constructors

Constructor	Description
EcsRoleCredentialProvider(String roleName)
EcsRoleCredentialProvider(String roleName, int connectTimeoutMs, int readTimeoutMs, int maxRetries, int retryIntervalMs, int expireBufferSeconds)

Method Summary

Modifier and Type	Method	Description
static EcsRoleCredentialProvider	create(String roleName)
static boolean	isDisabledByEnv()	Returns true when VOLCENGINE_ECS_METADATA_DISABLED=true is set.
boolean	isExpired()
void	refresh()
CredentialValue	retrieve()
void	setConnectTimeoutMs(int connectTimeoutMs)
void	setExpireBufferSeconds(int expireBufferSeconds)
void	setMaxRetries(int maxRetries)
void	setReadTimeoutMs(int readTimeoutMs)
void	setRetryIntervalMs(int retryIntervalMs)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EcsRoleCredentialProvider

public EcsRoleCredentialProvider(String roleName)

EcsRoleCredentialProvider

public EcsRoleCredentialProvider(String roleName,
                                 int connectTimeoutMs,
                                 int readTimeoutMs,
                                 int maxRetries,
                                 int retryIntervalMs,
                                 int expireBufferSeconds)

Method Detail

isDisabledByEnv

public static boolean isDisabledByEnv()

Returns true when VOLCENGINE_ECS_METADATA_DISABLED=true is set. Used by DefaultCredentialProvider to skip adding the IMDS step to the chain, and by the constructor to fail fast on direct new.

create

public static EcsRoleCredentialProvider create(String roleName)

setConnectTimeoutMs

public void setConnectTimeoutMs(int connectTimeoutMs)

setReadTimeoutMs

public void setReadTimeoutMs(int readTimeoutMs)

setMaxRetries

public void setMaxRetries(int maxRetries)

setRetryIntervalMs

public void setRetryIntervalMs(int retryIntervalMs)

setExpireBufferSeconds

public void setExpireBufferSeconds(int expireBufferSeconds)

isExpired

public boolean isExpired()

Specified by:

isExpired in interface Provider

refresh

public void refresh()
             throws ApiException

Specified by:

refresh in interface Provider

Throws:

ApiException

retrieve

public CredentialValue retrieve()
                         throws ApiException

Specified by:

retrieve in interface Provider

Throws:

ApiException