io.micronaut.oci.core

Class OracleCloudCoreFactory

java.lang.Object

io.micronaut.oci.core.OracleCloudCoreFactory

@Factory
public class OracleCloudCoreFactory
extends java.lang.Object

Sets up core beans for integration with Oracle cloud clients. The following beans are exposed:

• AuthenticationDetailsProvider
• ClientConfiguration.ClientConfigurationBuilder
• ClientConfiguration

See Also:

com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider;, ResourcePrincipalAuthenticationDetailsProvider, SimpleAuthenticationDetailsProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_SERVICE_URL
static java.lang.String	ORACLE_CLOUD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OracleCloudCoreFactory(java.lang.String profile)

Method Summary

Modifier and Type	Method and Description
protected com.oracle.bmc.ClientConfiguration	clientConfiguration(com.oracle.bmc.ClientConfiguration.ClientConfigurationBuilder builder) Configures the default ClientConfiguration if no other configuration is present.
protected com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider	configFileAuthenticationDetailsProvider() Configures a ConfigFileAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present and a file is found at $USER_HOME/.oci/config or specified by the user with oci.config.
protected com.oracle.bmc.ClientConfiguration.ClientConfigurationBuilder	configurationBuilder(OracleCloudClientConfigurationProperties props) Produces a ClientConfiguration.ClientConfigurationBuilder bean for the given properties.
java.util.Optional<java.lang.String>	getProfile()
protected com.oracle.bmc.auth.InstancePrincipalsAuthenticationDetailsProvider	instancePrincipalAuthenticationDetailsProvider(InstancePrincipalConfiguration instancePrincipalConfiguration) Configures a InstancePrincipalsAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present and the specified by the user with oci.config.use-instance-principal.
protected com.oracle.bmc.auth.ResourcePrincipalAuthenticationDetailsProvider	resourcePrincipalAuthenticationDetailsProvider() Configures a ResourcePrincipalAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present and the OCI_RESOURCE_PRINCIPAL_VERSION variable is available in the environment.
protected com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider	simpleAuthenticationDetailsProvider(OracleCloudAuthConfigurationProperties config) Configures a SimpleAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present.
protected TenancyIdProvider	tenantIdProvider(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Methods inherited from class java.lang.Object

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

Field Detail

ORACLE_CLOUD

public static final java.lang.String ORACLE_CLOUD

See Also:

Constant Field Values

METADATA_SERVICE_URL

public static final java.lang.String METADATA_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

OracleCloudCoreFactory

protected OracleCloudCoreFactory(@Nullable @Property(name="oci.config.profile")
                                 java.lang.String profile)

Parameters:

profile - The configured profile

Method Detail

configFileAuthenticationDetailsProvider

@Singleton
 @Requires(condition=io.micronaut.oci.core.OracleCloudConfigCondition.class) @Requires(missingProperty="oci.tenant-id") @Requires(missingProperty="oci.config.instance-principal")
 @Primary
protected com.oracle.bmc.auth.ConfigFileAuthenticationDetailsProvider configFileAuthenticationDetailsProvider()
                                                                                                                                                                                                                                                                                                               throws java.io.IOException

Configures a ConfigFileAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present and a file is found at $USER_HOME/.oci/config or specified by the user with oci.config.

Returns:

The ConfigFileAuthenticationDetailsProvider.

Throws:

java.io.IOException - If an exception occurs reading configuration.

See Also:

ConfigFileAuthenticationDetailsProvider

simpleAuthenticationDetailsProvider

@Singleton
 @Requires(missingProperty="oci.config.instance-principal") @Requires(property="oci.tenant-id")
 @Primary
protected com.oracle.bmc.auth.SimpleAuthenticationDetailsProvider simpleAuthenticationDetailsProvider(OracleCloudAuthConfigurationProperties config)

Configures a SimpleAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present.

Parameters:

config - The config to use

Returns:

The SimpleAuthenticationDetailsProvider.

See Also:

SimpleAuthenticationDetailsProvider

resourcePrincipalAuthenticationDetailsProvider

@Singleton
 @Requires(missingProperty="oci.config.instance-principal") @Requires(property="OCI_RESOURCE_PRINCIPAL_VERSION")
 @Primary
protected com.oracle.bmc.auth.ResourcePrincipalAuthenticationDetailsProvider resourcePrincipalAuthenticationDetailsProvider()

Configures a ResourcePrincipalAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present and the OCI_RESOURCE_PRINCIPAL_VERSION variable is available in the environment.

Returns:

The ResourcePrincipalAuthenticationDetailsProvider.

See Also:

ResourcePrincipalAuthenticationDetailsProvider

instancePrincipalAuthenticationDetailsProvider

@Singleton
 @Requires(beans=InstancePrincipalConfiguration.class)
 @Primary
protected com.oracle.bmc.auth.InstancePrincipalsAuthenticationDetailsProvider instancePrincipalAuthenticationDetailsProvider(InstancePrincipalConfiguration instancePrincipalConfiguration)

Configures a InstancePrincipalsAuthenticationDetailsProvider if no other AuthenticationDetailsProvider is present and the specified by the user with oci.config.use-instance-principal.

Parameters:

instancePrincipalConfiguration - The configuration

Returns:

The InstancePrincipalsAuthenticationDetailsProvider.

See Also:

InstancePrincipalsAuthenticationDetailsProvider

configurationBuilder

@Singleton
 @Primary
protected com.oracle.bmc.ClientConfiguration.ClientConfigurationBuilder configurationBuilder(OracleCloudClientConfigurationProperties props)

Produces a ClientConfiguration.ClientConfigurationBuilder bean for the given properties.

Parameters:

props - The props

Returns:

The builder

tenantIdProvider

@Singleton
 @Primary
 @Context
protected TenancyIdProvider tenantIdProvider(@Nullable
                                                                            com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider)

clientConfiguration

@Singleton
 @Requires(missingBeans=com.oracle.bmc.ClientConfiguration.class)
 @Primary
protected com.oracle.bmc.ClientConfiguration clientConfiguration(com.oracle.bmc.ClientConfiguration.ClientConfigurationBuilder builder)

Configures the default ClientConfiguration if no other configuration is present.

Parameters:

builder - The builder

Returns:

The default client configuration.

getProfile

public java.util.Optional<java.lang.String> getProfile()

Returns:

The configured profile.