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

Interface SessionTokenMethodConfig

All Superinterfaces:
Prototype.Api
All Known Implementing Classes:
SessionTokenMethodConfig.BuilderBase.SessionTokenMethodConfigImpl
public interface SessionTokenMethodConfig extends Prototype.Api
Configuration of the config authentication method.
See Also:

  • Method Details

    • builder

      static SessionTokenMethodConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder

    • builder

      static SessionTokenMethodConfig.Builder builder(SessionTokenMethodConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance

    • create

      static SessionTokenMethodConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration

    • create

      static SessionTokenMethodConfig create()
      Create a new instance with default values.
      Returns:
      a new instance

    • region

      String region()
      The OCI region.
      Returns:
      the OCI region

    • 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.

      Returns:
      the OCI authentication fingerprint

    • passphrase

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

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

      Returns:
      the OCI authentication passphrase

    • tenantId

      String tenantId()
      The OCI tenant id.

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

      Returns:
      the OCI tenant id

    • userId

      String userId()
      The OCI user id.

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

      Returns:
      the OCI user id

    • privateKeyPath

      Optional<Path> privateKeyPath()
      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/sessions/DEFAULT/oci_api_key.pem file in user home directory.

      Returns:
      the OCI authentication key file

    • sessionTokenPath

      Optional<Path> sessionTokenPath()
      Session token path. If both this value, and sessionToken() is defined, the value of sessionToken() is used.
      Returns:
      session token path

    • sessionToken

      Optional<String> sessionToken()
      Session token value. If both this value, and sessionTokenPath() is defined, this value is used.
      Returns:
      session token

    • initialRefreshDelay

      Optional<Duration> initialRefreshDelay()
      Delay of the first refresh. Defaults to 0, to refresh immediately (implemented in the authentication details provider).
      Returns:
      initial refresh delay
      See Also:
      • SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder.initialRefreshDelay(long)

    • refreshPeriod

      Optional<Duration> refreshPeriod()
      Refresh period, i.e. how often refresh occurs. Defaults to 55 minutes (implemented in the authentication details provider).
      Returns:
      refresh period
      See Also:
      • SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder.refreshPeriod(long)

    • sessionLifetimeHours

      Optional<Long> sessionLifetimeHours()
      Maximal lifetime of a session. Defaults to (and maximum is) 24 hours. Can only be set to a lower value.
      Returns:
      lifetime of a session in hours

    • scheduler

      Optional<ScheduledExecutorService> scheduler()
      Customize the scheduled executor service to use for scheduling. Defaults to a single thread executor service.
      Returns:
      scheduled executor service