Oracle Cloud Infrastructure SDK 3.63.0 · com.oracle.bmc.auth.internal.AbstractFederationClient

Modifier and Type	Field and Description
protected final List<ClientConfigurator>	additionalClientConfigurator
protected final OciCircuitBreaker	circuitBreaker
protected final ClientConfigurator	clientConfigurator
protected final HttpClient	federationClient
private static final Logger	LOG
protected final HttpClient	resourcePrincipalTokenClient
private volatile SecurityTokenAdapter	securityTokenAdapter
protected final SessionKeySupplier	sessionKeySupplier

Constructor Summary

Access	Constructor and Description
public	AbstractFederationClient(String the endpoint that can provide the resource principal token. resourcePrincipalTokenEndpoint, String the endpoint that can provide the resource principal session token. federationEndpoint, SessionKeySupplier the session key supplier. sessionKeySupplier, BasicAuthenticationDetailsProvider the instance principals authentication details provider. basicAuthenticationDetailsProvider, ClientConfigurator the reset client configurator. clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration) Constructor of AbstractFederationClient.
public	AbstractFederationClient(String the endpoint that can provide the resource principal token. resourcePrincipalTokenEndpoint, String the endpoint that can provide the resource principal session token. federationEndpoint, SessionKeySupplier the session key supplier. sessionKeySupplier, BasicAuthenticationDetailsProvider the instance principals authentication details provider. basicAuthenticationDetailsProvider, ClientConfigurator the reset client configurator. clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration, List<ClientConfigurator> additionalCLientConfigurators) Constructor of AbstractFederationClient.
public	AbstractFederationClient(String the complete url that can provide the resource principal token. resourcePrincipalTokenUrl, String the endpoint that can provide the resource principal token. resourcePrincipalTokenEndpoint, String the endpoint that can provide the resource principal session token. federationEndpoint, SessionKeySupplier the session key supplier. sessionKeySupplier, BasicAuthenticationDetailsProvider the instance principals authentication details provider. basicAuthenticationDetailsProvider, ClientConfigurator the reset client configurator. clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration, List<ClientConfigurator> additionalCLientConfigurators) Constructor of AbstractFederationClient.

Method Summary

Modifier and Type	Method and Description
public String	Returns: A security token that can be used to authenticate requests. getSecurityToken() Implements com.oracle.bmc.auth.internal.FederationClient.getSecurityToken. Gets a security token from the federation endpoint.
protected SecurityTokenAdapter	Returns: securityTokenAdapter getSecurityTokenAdapter() Get securityTokenAdapter
protected abstract SecurityTokenAdapter	Returns: the security token, which is basically a JWT token string getSecurityTokenFromServer() Gets a security token from the federation server
public String	getStringClaim(String key) Implements com.oracle.bmc.auth.internal.FederationClient.getStringClaim. Get a claim embedded in the security token.
protected HttpClient	makeClient(String endpoint, RequestSigner requestSigner)
protected ClientCall<?, GetResourcePrincipalTokenResponse.ResponseWrapper, ?>	prepareRptCall()
public String	Returns: A security token that can be used to authenticate requests. refreshAndGetSecurityToken() Implements com.oracle.bmc.auth.internal.FederationClient.refreshAndGetSecurityToken. Gets a security token from the federation endpoint.
public String	Returns: A security token that can be used to authenticate requests. refreshAndGetSecurityTokenIfExpiringWithin(Duration the duration to check time, boolean boolean value to enable/disable refresh of keys refreshKeys) Implements com.oracle.bmc.auth.ProvidesConfigurableRefresh.refreshAndGetSecurityTokenIfExpiringWithin. Gets a security token from the federation endpoint if the security token expires within the provided duration and allows to enable/disable refresh of keys.
public String	Returns: A security token that can be used to authenticate requests. refreshAndGetSecurityTokenIfExpiringWithin(Duration the duration to check time) Implements com.oracle.bmc.auth.ProvidesConfigurableRefresh.refreshAndGetSecurityTokenIfExpiringWithin. Gets a security token from the federation endpoint.
protected String	refreshAndGetSecurityTokenInner(final boolean doFinalTokenValidityCheck, Optional<Duration> time, boolean refreshKeys)
protected SecurityTokenAdapter	requestSessionToken(GetResourcePrincipalSessionTokenRequest getResourcePrincipalSessionTokenRequest)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

additionalClientConfigurator	back to summary
protected final List<ClientConfigurator> additionalClientConfigurator

circuitBreaker	back to summary
protected final OciCircuitBreaker circuitBreaker

clientConfigurator	back to summary
protected final ClientConfigurator clientConfigurator

federationClient	back to summary
protected final HttpClient federationClient

LOG	back to summary
private static final Logger LOG

resourcePrincipalTokenClient	back to summary
protected final HttpClient resourcePrincipalTokenClient

securityTokenAdapter	back to summary
private volatile SecurityTokenAdapter securityTokenAdapter

sessionKeySupplier	back to summary
protected final SessionKeySupplier sessionKeySupplier

Constructor Detail

AbstractFederationClient	back to summary
public AbstractFederationClient(String resourcePrincipalTokenEndpoint, String federationEndpoint, SessionKeySupplier sessionKeySupplier, BasicAuthenticationDetailsProvider basicAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration) Constructor of AbstractFederationClient. Parameters resourcePrincipalTokenEndpoint:String the endpoint that can provide the resource principal token. federationEndpoint:String the endpoint that can provide the resource principal session token. sessionKeySupplier:SessionKeySupplier the session key supplier. basicAuthenticationDetailsProvider:BasicAuthenticationDetailsProvider the instance principals authentication details provider. clientConfigurator:ClientConfigurator the reset client configurator.

AbstractFederationClient

back to summary

public AbstractFederationClient(String resourcePrincipalTokenEndpoint, String federationEndpoint, SessionKeySupplier sessionKeySupplier, BasicAuthenticationDetailsProvider basicAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration)

Constructor of AbstractFederationClient.

Parameters

resourcePrincipalTokenEndpoint:String: the endpoint that can provide the resource principal token.
federationEndpoint:String: the endpoint that can provide the resource principal session token.
sessionKeySupplier:SessionKeySupplier: the session key supplier.
basicAuthenticationDetailsProvider:BasicAuthenticationDetailsProvider: the instance principals authentication details provider.
clientConfigurator:ClientConfigurator: the reset client configurator.

AbstractFederationClient	back to summary
public AbstractFederationClient(String resourcePrincipalTokenEndpoint, String federationEndpoint, SessionKeySupplier sessionKeySupplier, BasicAuthenticationDetailsProvider basicAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration, List<ClientConfigurator> additionalCLientConfigurators) Constructor of AbstractFederationClient. Parameters resourcePrincipalTokenEndpoint:String the endpoint that can provide the resource principal token. federationEndpoint:String the endpoint that can provide the resource principal session token. sessionKeySupplier:SessionKeySupplier the session key supplier. basicAuthenticationDetailsProvider:BasicAuthenticationDetailsProvider the instance principals authentication details provider. clientConfigurator:ClientConfigurator the reset client configurator.

AbstractFederationClient

back to summary

Constructor of AbstractFederationClient.

Parameters

resourcePrincipalTokenEndpoint:String: the endpoint that can provide the resource principal token.
federationEndpoint:String: the endpoint that can provide the resource principal session token.
sessionKeySupplier:SessionKeySupplier: the session key supplier.
basicAuthenticationDetailsProvider:BasicAuthenticationDetailsProvider: the instance principals authentication details provider.
clientConfigurator:ClientConfigurator: the reset client configurator.

AbstractFederationClient	back to summary
public AbstractFederationClient(String resourcePrincipalTokenUrl, String resourcePrincipalTokenEndpoint, String federationEndpoint, SessionKeySupplier sessionKeySupplier, BasicAuthenticationDetailsProvider basicAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration, List<ClientConfigurator> additionalCLientConfigurators) Constructor of AbstractFederationClient. Parameters resourcePrincipalTokenUrl:String the complete url that can provide the resource principal token. resourcePrincipalTokenEndpoint:String the endpoint that can provide the resource principal token. federationEndpoint:String the endpoint that can provide the resource principal session token. sessionKeySupplier:SessionKeySupplier the session key supplier. basicAuthenticationDetailsProvider:BasicAuthenticationDetailsProvider the instance principals authentication details provider. clientConfigurator:ClientConfigurator the reset client configurator.

AbstractFederationClient

back to summary

public AbstractFederationClient(String resourcePrincipalTokenUrl, String resourcePrincipalTokenEndpoint, String federationEndpoint, SessionKeySupplier sessionKeySupplier, BasicAuthenticationDetailsProvider basicAuthenticationDetailsProvider, ClientConfigurator clientConfigurator, CircuitBreakerConfiguration circuitBreakerConfiguration, List<ClientConfigurator> additionalCLientConfigurators)

Constructor of AbstractFederationClient.

Parameters

resourcePrincipalTokenUrl:String: the complete url that can provide the resource principal token.
resourcePrincipalTokenEndpoint:String: the endpoint that can provide the resource principal token.
federationEndpoint:String: the endpoint that can provide the resource principal session token.
sessionKeySupplier:SessionKeySupplier: the session key supplier.
basicAuthenticationDetailsProvider:BasicAuthenticationDetailsProvider: the instance principals authentication details provider.
clientConfigurator:ClientConfigurator: the reset client configurator.

Method Detail

getSecurityToken	back to summary
public String getSecurityToken() Implements com.oracle.bmc.auth.internal.FederationClient.getSecurityToken. Gets a security token from the federation endpoint. May use a cached token if it judged to still be valid. Returns:String A security token that can be used to authenticate requests. Annotations @Override

getSecurityToken

back to summary

public String getSecurityToken()

Implements com.oracle.bmc.auth.internal.FederationClient.getSecurityToken.

Gets a security token from the federation endpoint. May use a cached token if it judged to still be valid.

Returns:String

A security token that can be used to authenticate requests.

Annotations

@Override

getSecurityTokenAdapter	back to summary
protected SecurityTokenAdapter getSecurityTokenAdapter() Get securityTokenAdapter Returns:SecurityTokenAdapter securityTokenAdapter

getSecurityTokenAdapter

back to summary

protected SecurityTokenAdapter getSecurityTokenAdapter()

Get securityTokenAdapter

Returns:SecurityTokenAdapter: securityTokenAdapter

getSecurityTokenFromServer	back to summary
protected abstract SecurityTokenAdapter getSecurityTokenFromServer() Gets a security token from the federation server Returns:SecurityTokenAdapter the security token, which is basically a JWT token string

getSecurityTokenFromServer

back to summary

protected abstract SecurityTokenAdapter getSecurityTokenFromServer()

Gets a security token from the federation server

Returns:SecurityTokenAdapter: the security token, which is basically a JWT token string

getStringClaim	back to summary
public String getStringClaim(String key) Implements com.oracle.bmc.auth.internal.FederationClient.getStringClaim. Get a claim embedded in the security token. May use the cached token if it is judged to still be valid.

getStringClaim

back to summary

public String getStringClaim(String key)

Implements com.oracle.bmc.auth.internal.FederationClient.getStringClaim.

Get a claim embedded in the security token. May use the cached token if it is judged to still be valid.

makeClient	back to summary
protected HttpClient makeClient(String endpoint, RequestSigner requestSigner)

prepareRptCall	back to summary
protected ClientCall<?, GetResourcePrincipalTokenResponse.ResponseWrapper, ?> prepareRptCall()

refreshAndGetSecurityToken	back to summary
public String refreshAndGetSecurityToken() Implements com.oracle.bmc.auth.internal.FederationClient.refreshAndGetSecurityToken. Gets a security token from the federation endpoint. This will always retrieve a new token from the federation endpoint and does not use a cached token. Returns:String A security token that can be used to authenticate requests. Annotations @Override

refreshAndGetSecurityToken

back to summary

public String refreshAndGetSecurityToken()

Implements com.oracle.bmc.auth.internal.FederationClient.refreshAndGetSecurityToken.

Gets a security token from the federation endpoint. This will always retrieve a new token from the federation endpoint and does not use a cached token.

Returns:String

A security token that can be used to authenticate requests.

Annotations

@Override

refreshAndGetSecurityTokenIfExpiringWithin	back to summary
public String refreshAndGetSecurityTokenIfExpiringWithin(Duration time, boolean refreshKeys) Implements com.oracle.bmc.auth.ProvidesConfigurableRefresh.refreshAndGetSecurityTokenIfExpiringWithin. Gets a security token from the federation endpoint if the security token expires within the provided duration and allows to enable/disable refresh of keys. This will always retrieve a new token from the federation endpoint and does not use a cached token. Parameters time:Duration the duration to check refreshKeys:boolean boolean value to enable/disable refresh of keys Returns:String A security token that can be used to authenticate requests. Annotations @Override

refreshAndGetSecurityTokenIfExpiringWithin

back to summary

public String refreshAndGetSecurityTokenIfExpiringWithin(Duration time, boolean refreshKeys)

Implements com.oracle.bmc.auth.ProvidesConfigurableRefresh.refreshAndGetSecurityTokenIfExpiringWithin.

Gets a security token from the federation endpoint if the security token expires within the provided duration and allows to enable/disable refresh of keys. This will always retrieve a new token from the federation endpoint and does not use a cached token.

Parameters

time:Duration: the duration to check
refreshKeys:boolean: boolean value to enable/disable refresh of keys

Returns:String

A security token that can be used to authenticate requests.

Annotations

@Override

refreshAndGetSecurityTokenIfExpiringWithin	back to summary
public String refreshAndGetSecurityTokenIfExpiringWithin(Duration time) Implements com.oracle.bmc.auth.ProvidesConfigurableRefresh.refreshAndGetSecurityTokenIfExpiringWithin. Gets a security token from the federation endpoint. This will always retrieve a new token from the federation endpoint and does not use a cached token. Parameters time:Duration the duration to check Returns:String A security token that can be used to authenticate requests. Annotations @Override

refreshAndGetSecurityTokenIfExpiringWithin

back to summary

public String refreshAndGetSecurityTokenIfExpiringWithin(Duration time)

Implements com.oracle.bmc.auth.ProvidesConfigurableRefresh.refreshAndGetSecurityTokenIfExpiringWithin.

Gets a security token from the federation endpoint. This will always retrieve a new token from the federation endpoint and does not use a cached token.

Parameters

time:Duration: the duration to check

Returns:String

A security token that can be used to authenticate requests.

Annotations

@Override

refreshAndGetSecurityTokenInner	back to summary
protected String refreshAndGetSecurityTokenInner(final boolean doFinalTokenValidityCheck, Optional<Duration> time, boolean refreshKeys)

requestSessionToken	back to summary
protected SecurityTokenAdapter requestSessionToken(GetResourcePrincipalSessionTokenRequest getResourcePrincipalSessionTokenRequest)

public abstract Class AbstractFederationClient

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail