Package com.oracle.bmc.auth

Class ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder

java.lang.Object

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

com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder<ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder,ResourcePrincipalAuthenticationDetailsProvider>

com.oracle.bmc.auth.ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder

Direct Known Subclasses:

ResourcePrincipalsV3AuthenticationDetailsProvider.ResourcePrincipalsV3AuthenticationDetailsProviderBuilder

Enclosing class:

ResourcePrincipalAuthenticationDetailsProvider

public static class ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder
extends AbstractFederationClientAuthenticationDetailsProviderBuilder<ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder,ResourcePrincipalAuthenticationDetailsProvider>

Builder for ResourcePrincipalAuthenticationDetailsProvider that understands the V2.2 configuration

Field Summary

Fields

Modifier and Type	Field	Description
protected CircuitBreakerConfiguration	circuitBreakerConfig	The configuration for the circuit breaker.
protected String	resourcePrincipalTokenEndpoint	The endpoint that can provide the resource principal token.
protected RptPathProvider	resourcePrincipalTokenPathProvider	The path provider for the resource principal token.
protected String	securityContext	The configuration for the security context.

Fields inherited from class com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder

AUTHORIZATION_HEADER_VALUE, circuitBreakerConfiguration, detectEndpointRetries, ENABLE_DEFAULT_CIRCUIT_BREAKER_CONFIG, federationEndpoint, leafCertificateSupplier, METADATA_BASE_URL_ENV_VAR, METADATA_SERVICE_BASE_URL, METADATA_URL_OVERRIDE, metadataBaseUrl, region, SERVICE, tenancyId, timeoutForEachRetry

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

additionalFederationClientConfigurators, federationClient, federationClientConfigurator, intermediateCertificateSuppliers, sessionKeySupplier

Method Summary

Modifier and Type	Method	Description
ResourcePrincipalAuthenticationDetailsProvider	build()	Examine the environment of the running process; construct a ResourcePrincipalAuthenticationDetailsProvider accordingly.
ResourcePrincipalAuthenticationDetailsProvider	build_1_1(String ociResourcePrincipalRptEndpoint, String ociResourcePrincipalRpstEndpoint)	Helper method that interprets the runtime environment to build a v1.1-configured client
ResourcePrincipalAuthenticationDetailsProvider	build_2_1_2(String ociResourcePrincipalRptEndpoint, String ociResourcePrincipalRpstEndpoint, String ociResourcePrincipalTokenPath, String ociSecurityContext, String ociResourcePrincipalResourceId, String ociResourcePrincipalTenancyId, String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String ociResourcePrincipalVersion)	Helper method that interprets the runtime environment to build a v2.1.2-configured client
ResourcePrincipalAuthenticationDetailsProvider	build_2_1_or_2_1_1(String ociResourcePrincipalRptEndpoint, String ociResourcePrincipalRpstEndpoint, String ociResourcePrincipalResourceId, String ociResourcePrincipalTenancyId, String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String ociResourcePrincipalVersion)	Helper method that interprets the runtime environment to build a v2.1 or 2.1.1-configured client
static ResourcePrincipalAuthenticationDetailsProvider	build_2_2(String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String ociResourcePrincipalRpst, String ociResourcePrincipalRegion, String inputType)	Helper method that interprets the runtime environment to build a v2.2-configured client
ResourcePrincipalAuthenticationDetailsProvider	build_3_0()	Helper method that interprets the runtime environment to build a v3.0-configured client
protected ResourcePrincipalAuthenticationDetailsProvider	buildProvider(SessionKeySupplier sessionKeySupplierToUse)	Build the actual provider.
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	circuitBreakerConfig(CircuitBreakerConfiguration circuitBreakerConfig)	Set value for the CircuitBreaker Configuration.
protected FederationClient	createFederationClient(SessionKeySupplier sessionKeySupplier)	Create the federation client.
protected void	createRptPathProvider()
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	leafCertificateSupplier(X509CertificateSupplier leafCertificateSupplier)	Configures the custom leafCertificateSupplier to use.
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	resourcePrincipalSessionTokenEndpoint(String resourcePrincipalSessionTokenEndpoint)	Deprecated. use AbstractFederationClientAuthenticationDetailsProviderBuilder.federationEndpoint(String)
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	resourcePrincipalTokenEndpoint(Service service, Region region)	Configures the resourcePrincipalTokenEndpoint to use.
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	resourcePrincipalTokenEndpoint(String resourcePrincipalTokenEndpoint)	Configures the resourcePrincipalTokenEndpoint to use.
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	resourcePrincipalTokenPathProvider(RptPathProvider resourcePrincipalTokenPathProvider)	Configures the resourcePrincipalTokenPathProvider to use.
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	securityContext(String securityContext)	Set value for the security context to use.

Methods inherited from class com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder

autoDetectCertificatesUsingMetadataUrl, autoDetectEndpointUsingMetadataUrl, autoDetectUsingMetadataUrl, circuitBreakerConfigurator, detectEndpointRetries, federationEndpoint, getDefaultCircuitBreakerOverride, getFederationEndpoint, getLeafCertificateSupplier, getMetadataBaseUrl, getRegion, getTenancyId, metadataBaseUrl, purpose, tenancyId, timeoutForEachRetry

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

resourcePrincipalTokenEndpoint

protected String resourcePrincipalTokenEndpoint

The endpoint that can provide the resource principal token.

Required.

resourcePrincipalTokenPathProvider

protected RptPathProvider resourcePrincipalTokenPathProvider

The path provider for the resource principal token.

Defaults to DefaultRptPathProvider if null

circuitBreakerConfig

protected CircuitBreakerConfiguration circuitBreakerConfig

The configuration for the circuit breaker.

securityContext

protected String securityContext

The configuration for the security context.

Method Detail

resourcePrincipalTokenPathProvider

public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder resourcePrincipalTokenPathProvider(RptPathProvider resourcePrincipalTokenPathProvider)

Configures the resourcePrincipalTokenPathProvider to use.

resourcePrincipalTokenEndpoint

public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder resourcePrincipalTokenEndpoint(String resourcePrincipalTokenEndpoint)

Configures the resourcePrincipalTokenEndpoint to use.

circuitBreakerConfig

public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder circuitBreakerConfig(CircuitBreakerConfiguration circuitBreakerConfig)

Set value for the CircuitBreaker Configuration.

securityContext

public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder securityContext(String securityContext)

Set value for the security context to use.

resourcePrincipalTokenEndpoint

public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder resourcePrincipalTokenEndpoint(Service service,
                                                                                                                                           Region region)

Configures the resourcePrincipalTokenEndpoint to use.

resourcePrincipalSessionTokenEndpoint

@Deprecated
public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder resourcePrincipalSessionTokenEndpoint(String resourcePrincipalSessionTokenEndpoint)

Deprecated.

use AbstractFederationClientAuthenticationDetailsProviderBuilder.federationEndpoint(String)

Configures the resourcePrincipalSessionTokenEndpoint to use.

leafCertificateSupplier

public ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder leafCertificateSupplier(X509CertificateSupplier leafCertificateSupplier)

Configures the custom leafCertificateSupplier to use.

Overrides:

leafCertificateSupplier in class AbstractFederationClientAuthenticationDetailsProviderBuilder<ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder,ResourcePrincipalAuthenticationDetailsProvider>

Returns:

this builder

build

public ResourcePrincipalAuthenticationDetailsProvider build()

Examine the environment of the running process; construct a ResourcePrincipalAuthenticationDetailsProvider accordingly.

Overrides:

build in class AbstractFederationClientAuthenticationDetailsProviderBuilder<ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder,ResourcePrincipalAuthenticationDetailsProvider>

Returns:

A new provider instance.

build_3_0

public ResourcePrincipalAuthenticationDetailsProvider build_3_0()

Helper method that interprets the runtime environment to build a v3.0-configured client

Returns:

ResourcePrincipalAuthenticationDetailsProvider

build_2_2

public static ResourcePrincipalAuthenticationDetailsProvider build_2_2(String ociResourcePrincipalPrivateKey,
                                                                       String ociResourcePrincipalPassphrase,
                                                                       String ociResourcePrincipalRpst,
                                                                       String ociResourcePrincipalRegion,
                                                                       String inputType)

Helper method that interprets the runtime environment to build a v2.2-configured client

Returns:

ResourcePrincipalAuthenticationDetailsProvider

build_2_1_2

public ResourcePrincipalAuthenticationDetailsProvider build_2_1_2(String ociResourcePrincipalRptEndpoint,
                                                                  String ociResourcePrincipalRpstEndpoint,
                                                                  String ociResourcePrincipalTokenPath,
                                                                  String ociSecurityContext,
                                                                  String ociResourcePrincipalResourceId,
                                                                  String ociResourcePrincipalTenancyId,
                                                                  String ociResourcePrincipalPrivateKey,
                                                                  String ociResourcePrincipalPassphrase,
                                                                  String ociResourcePrincipalVersion)

Helper method that interprets the runtime environment to build a v2.1.2-configured client

Returns:

ResourcePrincipalAuthenticationDetailsProvider

build_2_1_or_2_1_1

public ResourcePrincipalAuthenticationDetailsProvider build_2_1_or_2_1_1(String ociResourcePrincipalRptEndpoint,
                                                                         String ociResourcePrincipalRpstEndpoint,
                                                                         String ociResourcePrincipalResourceId,
                                                                         String ociResourcePrincipalTenancyId,
                                                                         String ociResourcePrincipalPrivateKey,
                                                                         String ociResourcePrincipalPassphrase,
                                                                         String ociResourcePrincipalVersion)

Helper method that interprets the runtime environment to build a v2.1 or 2.1.1-configured client

Returns:

ResourcePrincipalAuthenticationDetailsProvider

build_1_1

public ResourcePrincipalAuthenticationDetailsProvider build_1_1(String ociResourcePrincipalRptEndpoint,
                                                                String ociResourcePrincipalRpstEndpoint)

Helper method that interprets the runtime environment to build a v1.1-configured client

Returns:

ResourcePrincipalAuthenticationDetailsProvider

createFederationClient

protected FederationClient createFederationClient(SessionKeySupplier sessionKeySupplier)

Description copied from class: AbstractFederationClientAuthenticationDetailsProviderBuilder

Create the federation client.

Overrides:

createFederationClient in class AbstractFederationClientAuthenticationDetailsProviderBuilder<ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder,ResourcePrincipalAuthenticationDetailsProvider>

Parameters:

sessionKeySupplier - the session key supplier

Returns:

the federation client

createRptPathProvider

protected void createRptPathProvider()

buildProvider

protected ResourcePrincipalAuthenticationDetailsProvider buildProvider(SessionKeySupplier sessionKeySupplierToUse)

Description copied from class: AbstractFederationClientAuthenticationDetailsProviderBuilder

Build the actual provider.

Specified by:

buildProvider in class AbstractFederationClientAuthenticationDetailsProviderBuilder<ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder,ResourcePrincipalAuthenticationDetailsProvider>

Parameters:

sessionKeySupplierToUse - the session key supplier to use

Returns:

authentication details provider