io.micronaut.discovery.oraclecloud.vault.config

Class OracleCloudVaultClientConfiguration

java.lang.Object

io.micronaut.discovery.oraclecloud.vault.config.OracleCloudVaultClientConfiguration

@ConfigurationProperties(value="oraclecloud.vault")
public class OracleCloudVaultClientConfiguration
extends Object

OracleCloudVault Client.

Since:

2.0.0

Author:

toddsharp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OracleCloudVaultClientConfiguration.OracleCloudVault An Oracle Cloud Vault
static class	OracleCloudVaultClientConfiguration.OracleCloudVaultClientDiscoveryConfiguration The Discovery Configuration class for Oracle Cloud Vault.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX

Constructor Summary

Constructors

Constructor and Description
OracleCloudVaultClientConfiguration()

Method Summary

Modifier and Type	Method and Description
OracleCloudVaultClientConfiguration.OracleCloudVaultClientDiscoveryConfiguration	getDiscoveryConfiguration()
String	getPathToConfig() If you are not using Instance Principal auth then you must pass the path to a valid OCI config file.
String	getProfile() Which profile in the config file should be used? Default value .
String	getRegion() The OCI region Ex: 'US-PHOENIX-1'.
List<OracleCloudVaultClientConfiguration.OracleCloudVault>	getVaults() A list of OracleCloudVaultClientConfiguration.OracleCloudVault objects that contain secrets that will be retrieved, decoded and set into your application as config variables.
boolean	isUseInstancePrincipal() Whether or not the configuration client should use https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[Instance Principal Authentication] to interact with the SDK.
void	setPathToConfig(String pathToConfig) If you are not using Instance Principal auth then you must pass the path to a valid OCI config file.
void	setProfile(String profile) Which profile in the config file should be used? Default value .
void	setRegion(String region) The OCI region Ex: 'US-PHOENIX-1'.
void	setUseInstancePrincipal(boolean useInstancePrincipal) Whether or not the configuration client should use https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[Instance Principal Authentication] to interact with the SDK.
void	setVaults(List<OracleCloudVaultClientConfiguration.OracleCloudVault> vaults) A list of OracleCloudVaultClientConfiguration.OracleCloudVault objects that contain secrets that will be retrieved, decoded and set into your application as config variables.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Constructor Detail

OracleCloudVaultClientConfiguration

public OracleCloudVaultClientConfiguration()

Method Detail

getDiscoveryConfiguration

public OracleCloudVaultClientConfiguration.OracleCloudVaultClientDiscoveryConfiguration getDiscoveryConfiguration()

Returns:

The discovery service configuration

getVaults

public List<OracleCloudVaultClientConfiguration.OracleCloudVault> getVaults()

A list of OracleCloudVaultClientConfiguration.OracleCloudVault objects that contain secrets that will be retrieved, decoded and set into your application as config variables.

Returns:

A list of Vaults to retrieve

setVaults

public void setVaults(List<OracleCloudVaultClientConfiguration.OracleCloudVault> vaults)

A list of OracleCloudVaultClientConfiguration.OracleCloudVault objects that contain secrets that will be retrieved, decoded and set into your application as config variables.

Parameters:

vaults - A list of Vaults

isUseInstancePrincipal

public boolean isUseInstancePrincipal()

Whether or not the configuration client should use https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[Instance Principal Authentication] to interact with the SDK. If this value is false, you must include a path to an OCI Config file to use Config File based auth.

Returns:

Whether or not we should use instance principal authentication

See Also:

Instance Principal Authentication

setUseInstancePrincipal

public void setUseInstancePrincipal(boolean useInstancePrincipal)

Whether or not the configuration client should use https://docs.cloud.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm[Instance Principal Authentication] to interact with the SDK. If this value is false, you must include a path to an OCI Config file to use Config File based auth.

Parameters:

useInstancePrincipal - Should we use instance principal authentication

See Also:

Instance Principal Authentication

getPathToConfig

public String getPathToConfig()

If you are not using Instance Principal auth then you must pass the path to a valid OCI config file. Default value .

Returns:

The path to the OCI config file (if not using instance principal auth)

setPathToConfig

public void setPathToConfig(String pathToConfig)

If you are not using Instance Principal auth then you must pass the path to a valid OCI config file. Default value .

Parameters:

pathToConfig - The path to the OCI config file

getProfile

public String getProfile()

Which profile in the config file should be used? Default value .

Returns:

Which profile in the OCI config file to use (default: DEFAULT)

setProfile

public void setProfile(String profile)

Which profile in the config file should be used? Default value .

Parameters:

profile - Which profile in the OCI config file to use (default: DEFAULT)

getRegion

public String getRegion()

The OCI region Ex: 'US-PHOENIX-1'.

Returns:

Which region in the Oracle Cloud should the client work in?

setRegion

public void setRegion(String region)

The OCI region Ex: 'US-PHOENIX-1'.

Parameters:

region - Which region in the Oracle Cloud should the client work in?