Module io.helidon.integrations.oci.secrets.configsource

Package io.helidon.integrations.oci.secrets.configsource

Class OciSecretsConfigSourceProvider

java.lang.Object

io.helidon.integrations.oci.secrets.configsource.OciSecretsConfigSourceProvider

All Implemented Interfaces:

ConfigSourceProvider

public final class OciSecretsConfigSourceProvider
extends Object
implements ConfigSourceProvider

A ConfigSourceProvider that creates ConfigSource implementations that interact with the Oracle Cloud Infrastructure (OCI) Secrets Retrieval and Vault APIs.

To use, ensure the packaging artifact (e.g. .jar file or similar) containing this class is present on your class or module path as appropriate, and configure a meta-configuration source with a type of oci-secrets, following the usual Helidon meta-configuration rules.

More specifically:

1. Ensure you have an authentication mechanism set up to connect to OCI (e.g. a valid OCI configuration file). Authentication with OCI is accomplished via the OciExtension class; please see its documentation for how and when to set up an oci.yaml classpath resource to further refine the mechanism of authentication.
2. Ensure there is a classpath resource present named meta-config.yaml.
3. Ensure the meta-config.yaml classpath resource contains a sources element with a type of oci-secrets that looks similar to the following, substituting values as appropriate:

   sources:
     - type: 'oci-secrets'
       properties:
         compartment-ocid: 'your vault compartment OCID goes here'
         vault-ocid: 'your vault OCID goes here'

Refer to Helidon's documentation concerning meta-configuration for more details.

See Also:

• ConfigSourceProvider

Constructor Summary

Constructors

Constructor	Description
OciSecretsConfigSourceProvider()	Deprecated. For use by ServiceLoader only.

Method Summary

Modifier and Type	Method	Description
AbstractConfigSource	create(String type, Config metaConfig)	Deprecated. For use by the Helidon Config subsystem only.
Set<String>	supported()	Deprecated. For use by the Helidon Config subsystem only.
boolean	supports(String type)	Deprecated. For use by the Helidon Config subsystem only.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.config.spi.ConfigSourceProvider

createMulti

Constructor Details

OciSecretsConfigSourceProvider

@Deprecated
public OciSecretsConfigSourceProvider()

Deprecated.

For use by ServiceLoader only.

Creates a new OciSecretsConfigSourceProvider.

Method Details

create

@Deprecated
public AbstractConfigSource create(String type,
 Config metaConfig)

Deprecated.

For use by the Helidon Config subsystem only.

Creates and returns a non-null AbstractConfigSource implementation that sources its values from an Oracle Cloud Infrastructure (OCI) Vault.

Parameters:

type - one of the supported types; not actually used

metaConfig - a Config serving as meta-configuration for this provider; must not be null when type is supported

Returns:

a non-null AbstractConfigSource implementation

Throws:

NullPointerException - if type is supported and metaConfig is null

See Also:

• supported()
• AbstractConfigSource

supported

@Deprecated
public Set<String> supported()

Deprecated.

For use by the Helidon Config subsystem only.

Returns a non-null, immutable Set of supported types suitable for the Helidon Config subsystem to pass to the create(String, Config) method.

This method returns a Set whose sole element is the string "oci-secrets".

Returns:

a non-null, immutable Set

See Also:

• create(String, Config)

supports

@Deprecated
public boolean supports(String type)

Deprecated.

For use by the Helidon Config subsystem only.

Returns true if and only if the Set returned by an invocation of the supported() method contains it.

Parameters:

type - the type to test

Returns:

true if and only if the Set returned by an invocation of the supported() method contains it

See Also:

• supported()
• create(String, Config)