com.oracle.bmc.auth

Class AbstractFederationClientAuthenticationDetailsProviderBuilder<B extends AbstractFederationClientAuthenticationDetailsProviderBuilder<B,P>,P extends AbstractAuthenticationDetailsProvider>

java.lang.Object

com.oracle.bmc.auth.AbstractRequestingAuthenticationDetailsProvider.Builder<B>

com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder<B,P>

Type Parameters:

B - builder class

P - provider class

Direct Known Subclasses:

InstancePrincipalsAuthenticationDetailsProvider.InstancePrincipalsAuthenticationDetailsProviderBuilder

public abstract class AbstractFederationClientAuthenticationDetailsProviderBuilder<B extends AbstractFederationClientAuthenticationDetailsProviderBuilder<B,P>,P extends AbstractAuthenticationDetailsProvider>
extends AbstractRequestingAuthenticationDetailsProvider.Builder<B>

Abstract builder base class for authentication details provider extending AbstractRequestingAuthenticationDetailsProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FALLBACK_METADATA_SERVICE_URL Fallback url of metadata service.
protected String	federationEndpoint The federation endpoint url.
protected X509CertificateSupplier	leafCertificateSupplier The leaf certificate, or null if detecting from instance metadata.
protected static String	METADATA_SERVICE_BASE_URL Default base url of metadata service.
protected String	metadataBaseUrl Base url of metadata service.
protected Region	region Detected region.
protected static Service	SERVICE Service instance for auth.
protected String	tenancyId Tenancy OCI, or null if detecting from instance metadata.

Fields inherited from class com.oracle.bmc.auth.AbstractRequestingAuthenticationDetailsProvider.Builder

additionalFederationClientConfigurators, federationClient, federationClientConfigurator, intermediateCertificateSuppliers, sessionKeySupplier

Constructor Summary

Constructors

Constructor and Description
AbstractFederationClientAuthenticationDetailsProviderBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	autoDetectCertificatesUsingMetadataUrl() Auto detects and configures the certificates needed using Instance metadata.
protected String	autoDetectEndpointUsingMetadataUrl() Auto detects the endpoint that should be used when talking to OCI Auth, if no endpoint has been configured already.
protected void	autoDetectUsingMetadataUrl() Auto-detect endpoint and certificate information using Instance metadata.
P	build() Build a new AuthenticationDetailsProvider that uses the FederationClient.
protected abstract P	buildProvider(SessionKeySupplier sessionKeySupplierToUse) Build the actual provider.
B	circuitBreakerConfigurator(CircuitBreakerConfiguration circuitBreakerConfiguration) Configures the Circuit Breaker to use, if any.
protected com.oracle.bmc.auth.internal.FederationClient	createFederationClient(SessionKeySupplier sessionKeySupplier)
B	federationEndpoint(String federationEndpoint) Configures the custom federationEndpoint to use.
String	getFederationEndpoint() The federation endpoint url.
X509CertificateSupplier	getLeafCertificateSupplier() The leaf certificate, or null if detecting from instance metadata.
String	getMetadataBaseUrl() Base url of metadata service.
Region	getRegion() Detected region.
String	getTenancyId() Tenancy OCI, or null if detecting from instance metadata.
B	leafCertificateSupplier(X509CertificateSupplier leafCertificateSupplier) Configures the custom leafCertificateSupplier to use.
B	metadataBaseUrl(String metadataBaseUrl) Configure the metadata endpoint to use when retrieving the instance data and principal for federation.
protected B	purpose(String purpose)
B	tenancyId(String tenancyId)

Methods inherited from class com.oracle.bmc.auth.AbstractRequestingAuthenticationDetailsProvider.Builder

additionalFederationClientConfigurator, federationClientConfigurator, intermediateCertificateSuppliers, sessionKeySupplier

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

protected static final Service SERVICE

Service instance for auth.

METADATA_SERVICE_BASE_URL

protected static final String METADATA_SERVICE_BASE_URL

Default base url of metadata service.

See Also:

Constant Field Values

FALLBACK_METADATA_SERVICE_URL

protected static final String FALLBACK_METADATA_SERVICE_URL

Fallback url of metadata service.

See Also:

Constant Field Values

metadataBaseUrl

protected volatile String metadataBaseUrl

Base url of metadata service.

federationEndpoint

protected String federationEndpoint

The federation endpoint url.

leafCertificateSupplier

protected X509CertificateSupplier leafCertificateSupplier

The leaf certificate, or null if detecting from instance metadata.

tenancyId

protected String tenancyId

Tenancy OCI, or null if detecting from instance metadata.

region

protected Region region

Detected region.

Constructor Detail

AbstractFederationClientAuthenticationDetailsProviderBuilder

public AbstractFederationClientAuthenticationDetailsProviderBuilder()

Method Detail

metadataBaseUrl

public B metadataBaseUrl(String metadataBaseUrl)

Configure the metadata endpoint to use when retrieving the instance data and principal for federation.

federationEndpoint

public B federationEndpoint(String federationEndpoint)

Configures the custom federationEndpoint to use.

leafCertificateSupplier

public B leafCertificateSupplier(X509CertificateSupplier leafCertificateSupplier)

Configures the custom leafCertificateSupplier to use.

tenancyId

public B tenancyId(String tenancyId)

purpose

protected B purpose(String purpose)

circuitBreakerConfigurator

public B circuitBreakerConfigurator(CircuitBreakerConfiguration circuitBreakerConfiguration)

Configures the Circuit Breaker to use, if any.

build

public P build()

Build a new AuthenticationDetailsProvider that uses the FederationClient.

Returns:

A new provider instance.

createFederationClient

protected com.oracle.bmc.auth.internal.FederationClient createFederationClient(SessionKeySupplier sessionKeySupplier)

autoDetectUsingMetadataUrl

protected void autoDetectUsingMetadataUrl()

Auto-detect endpoint and certificate information using Instance metadata.

autoDetectEndpointUsingMetadataUrl

protected String autoDetectEndpointUsingMetadataUrl()

Auto detects the endpoint that should be used when talking to OCI Auth, if no endpoint has been configured already.

Returns:

The auto-detected, or currently set, auth endpoint.

autoDetectCertificatesUsingMetadataUrl

protected void autoDetectCertificatesUsingMetadataUrl()

Auto detects and configures the certificates needed using Instance metadata.

buildProvider

protected abstract P buildProvider(SessionKeySupplier sessionKeySupplierToUse)

Build the actual provider.

Parameters:

sessionKeySupplierToUse -

Returns:

authentication details provider

getMetadataBaseUrl

public String getMetadataBaseUrl()

Base url of metadata service.

getFederationEndpoint

public String getFederationEndpoint()

The federation endpoint url.

getLeafCertificateSupplier

public X509CertificateSupplier getLeafCertificateSupplier()

The leaf certificate, or null if detecting from instance metadata.

getTenancyId

public String getTenancyId()

Tenancy OCI, or null if detecting from instance metadata.

getRegion

public Region getRegion()

Detected region.