com.byteplus.auth

Class SamlCredentialProvider

java.lang.Object

com.byteplus.auth.SamlCredentialProvider

All Implemented Interfaces:

Provider

public class SamlCredentialProvider
extends Object
implements Provider

Provider that obtains temporary credentials via STS AssumeRoleWithSAML.

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 and Description
SamlCredentialProvider(String roleTrn, String samlProviderTrn, String samlAssertion, String rolePolicy, String stsEndpoint) Creates a new SamlCredentialProvider.

Method Summary

Modifier and Type	Method and Description
boolean	isExpired()
void	refresh()
CredentialValue	retrieve()
void	setDurationSeconds(int durationSeconds)
void	setExpireBufferSeconds(int expireBufferSeconds)
void	setMaxRetries(int maxRetries)
void	setRetryIntervalMs(int retryIntervalMs)
void	setSchema(String schema)

Methods inherited from class java.lang.Object

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

Constructor Detail

SamlCredentialProvider

public SamlCredentialProvider(String roleTrn,
                              String samlProviderTrn,
                              String samlAssertion,
                              String rolePolicy,
                              String stsEndpoint)

Creates a new SamlCredentialProvider.

Parameters:

roleTrn - the TRN of the role to assume, e.g. trn:iam::1234567890:role/YourRoleName

samlProviderTrn - the TRN of the SAML provider, e.g. trn:iam::1234567890:saml-provider/MyIdp

samlAssertion - the base64-encoded SAML Response from your IdP

rolePolicy - optional inline policy to restrict permissions (may be null)

stsEndpoint - optional STS endpoint override (may be null for default)

Method Detail

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

setDurationSeconds

public void setDurationSeconds(int durationSeconds)

setExpireBufferSeconds

public void setExpireBufferSeconds(int expireBufferSeconds)

setSchema

public void setSchema(String schema)

setMaxRetries

public void setMaxRetries(int maxRetries)

setRetryIntervalMs

public void setRetryIntervalMs(int retryIntervalMs)