Module io.helidon.integrations.oci
Package io.helidon.integrations.oci

Class ConfigMethodConfig.BuilderBase<BUILDER extends ConfigMethodConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigMethodConfig>

java.lang.Object
io.helidon.integrations.oci.ConfigMethodConfig.BuilderBase<BUILDER,PROTOTYPE>
Type Parameters:
BUILDER - type of the builder extending this abstract builder
PROTOTYPE - type of the prototype interface that would be built by Prototype.Builder.buildPrototype()
All Implemented Interfaces:
Prototype.Builder<BUILDER,PROTOTYPE>, Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Direct Known Subclasses:
ConfigMethodConfig.Builder
Enclosing interface:
ConfigMethodConfig
public abstract static class ConfigMethodConfig.BuilderBase<BUILDER extends ConfigMethodConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigMethodConfig> extends Object implements Prototype.ConfiguredBuilder<BUILDER,PROTOTYPE>
Fluent API builder base for ConfigMethodConfig.

  • Constructor Details

    • BuilderBase

      protected BuilderBase()
      Protected to support extensibility.

  • Method Details

    • from

      public BUILDER from(ConfigMethodConfig prototype)
      Update this builder from an existing prototype instance. This method disables automatic service discovery.
      Parameters:
      prototype - existing prototype to update this builder from
      Returns:
      updated builder instance

    • from

      public BUILDER from(ConfigMethodConfig.BuilderBase<?,?> builder)
      Update this builder from an existing prototype builder instance.
      Parameters:
      builder - existing builder prototype to update this builder from
      Returns:
      updated builder instance

    • config

      public BUILDER config(Config config)
      Update builder from configuration (node of this type). If a value is present in configuration, it would override currently configured values.
      Specified by:
      config in interface Prototype.ConfiguredBuilder<BUILDER extends ConfigMethodConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ConfigMethodConfig>
      Parameters:
      config - configuration instance used to obtain values to update this builder
      Returns:
      updated builder instance

    • region

      public BUILDER region(String region)
      The OCI region.
      Parameters:
      region - the OCI region
      Returns:
      updated builder instance
      See Also:

    • fingerprint

      public BUILDER fingerprint(String fingerprint)
      The OCI authentication fingerprint.

      This configuration property must be provided in order to set the API signing key's fingerprint. See SimpleAuthenticationDetailsProvider.getFingerprint() for more details.

      Parameters:
      fingerprint - the OCI authentication fingerprint
      Returns:
      updated builder instance
      See Also:

    • clearPrivateKey

      public BUILDER clearPrivateKey()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • privateKey

      public BUILDER privateKey(Resource privateKey)
      The OCI authentication private key resource. A resource can be defined as a resource on classpath, file on the file system, base64 encoded text value in config, or plain-text value in config.

      If not defined, we will use .oci/oic_api_key.pem file in user home directory.

      Parameters:
      privateKey - the OCI authentication key file
      Returns:
      updated builder instance
      See Also:

    • privateKey

      public BUILDER privateKey(ResourceConfig privateKeyConfig)
      The OCI authentication private key resource. A resource can be defined as a resource on classpath, file on the file system, base64 encoded text value in config, or plain-text value in config.

      If not defined, we will use .oci/oic_api_key.pem file in user home directory.

      Parameters:
      privateKeyConfig - the OCI authentication key file
      Returns:
      updated builder instance
      See Also:

    • privateKey

      public BUILDER privateKey(Consumer<ResourceConfig.Builder> consumer)
      The OCI authentication private key resource. A resource can be defined as a resource on classpath, file on the file system, base64 encoded text value in config, or plain-text value in config.

      If not defined, we will use .oci/oic_api_key.pem file in user home directory.

      Parameters:
      consumer - the OCI authentication key file
      Returns:
      updated builder instance
      See Also:

    • clearPassphrase

      public BUILDER clearPassphrase()
      Clear existing value of this property.
      Returns:
      updated builder instance
      See Also:

    • passphrase

      public BUILDER passphrase(char[] passphrase)
      The OCI authentication passphrase.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPassphraseCharacters().

      Parameters:
      passphrase - the OCI authentication passphrase
      Returns:
      updated builder instance
      See Also:

    • passphrase

      public BUILDER passphrase(String passphrase)
      The OCI authentication passphrase.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPassphraseCharacters().

      Parameters:
      passphrase - the OCI authentication passphrase
      Returns:
      updated builder instance
      See Also:

    • tenantId

      public BUILDER tenantId(String tenantId)
      The OCI tenant id.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getTenantId().

      Parameters:
      tenantId - the OCI tenant id
      Returns:
      updated builder instance
      See Also:

    • userId

      public BUILDER userId(String userId)
      The OCI user id.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getUserId().

      Parameters:
      userId - the OCI user id
      Returns:
      updated builder instance
      See Also:

    • region

      public Optional<String> region()
      The OCI region.
      Returns:
      the region

    • fingerprint

      public Optional<String> fingerprint()
      The OCI authentication fingerprint.

      This configuration property must be provided in order to set the API signing key's fingerprint. See SimpleAuthenticationDetailsProvider.getFingerprint() for more details.

      Returns:
      the fingerprint

    • privateKey

      public Optional<Resource> privateKey()
      The OCI authentication private key resource. A resource can be defined as a resource on classpath, file on the file system, base64 encoded text value in config, or plain-text value in config.

      If not defined, we will use .oci/oic_api_key.pem file in user home directory.

      Returns:
      the private key

    • passphrase

      public Optional<char[]> passphrase()
      The OCI authentication passphrase.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPassphraseCharacters().

      Returns:
      the passphrase

    • tenantId

      public Optional<String> tenantId()
      The OCI tenant id.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getTenantId().

      Returns:
      the tenant id

    • userId

      public Optional<String> userId()
      The OCI user id.

      This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getUserId().

      Returns:
      the user id

    • config

      public Optional<Config> config()
      If this instance was configured, this would be the config instance used.
      Returns:
      config node used to configure this builder, or empty if not configured

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • preBuildPrototype

      protected void preBuildPrototype()
      Handles providers and decorators.

    • validatePrototype

      protected void validatePrototype()
      Validates required properties.