Module io.helidon.integrations.oci
Package io.helidon.integrations.oci
Class OciConfig.BuilderBase.OciConfigImpl
java.lang.Object
io.helidon.integrations.oci.OciConfig.BuilderBase.OciConfigImpl
- All Implemented Interfaces:
Prototype.Api
,OciConfig
- Enclosing class:
OciConfig.BuilderBase<BUILDER extends OciConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OciConfig>
Generated implementation of the prototype, can be extended by descendant prototype implementations.
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.helidon.integrations.oci.OciConfig
OciConfig.Builder, OciConfig.BuilderBase<BUILDER extends OciConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OciConfig> -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
OciConfigImpl
(OciConfig.BuilderBase<?, ?> builder) Create an instance providing a builder. -
Method Summary
Modifier and TypeMethodDescriptionList of attempted authentication strategies in caseOciConfig.authenticationMethod()
is set to "auto".Authentication method to use.Timeout of authentication operations, where applicable.config()
Get the config used to update the builder.Config file method configuration (if provided and used).Config method configuration (if provided and used).boolean
Customization of federation endpoint for authentication providers.int
hashCode()
The OCI IMDS URI (http URL pointing to the metadata service, if customization needed).Customize the number of retries to contact IMDS service.The OCI IMDS connection timeout.Optional
<com.oracle.bmc.Region> region()
Explicit region.Session token method configuration (if provided and used).tenantId()
OCI tenant id for Instance Principal, Resource Principal or OKE Workload.toString()
-
Field Details
-
AUTHENTICATION_METHOD_AUTO
Default authentication method. The default is to use automatic discovery - i.e. cycle through possible providers until one yields an authentication details provider instance.- See Also:
-
-
Constructor Details
-
OciConfigImpl
Create an instance providing a builder.- Parameters:
builder
- extending builder base of this prototype
-
-
Method Details
-
region
Description copied from interface:OciConfig
Explicit region. The configured region will be used by region provider. This may be ignored by authentication detail providers, as in most cases region is provided by them. -
authenticationMethod
Description copied from interface:OciConfig
Authentication method to use. If the configured method is not available, an exception would be thrown for OCI related services.Known and supported authentication strategies for public OCI:
- "auto" - use the list of
OciConfig.allowedAuthenticationMethods()
(in the provided order), and choose the first one capable of providing data - "config" -
use configuration of the application to obtain values needed to set up connectivity, uses
SimpleAuthenticationDetailsProvider
- "config-file" - use configuration file of OCI (
home/.oci/config
), usesConfigFileAuthenticationDetailsProvider
resource-principal
- use identity of the OCI resource the service is executed on (fn), usesResourcePrincipalAuthenticationDetailsProvider
, and is available in a separate modulehelidon-integrations-oci-authentication-resource
instance-principal
- use identity of the OCI instance the service is running on, usesInstancePrincipalsAuthenticationDetailsProvider
, and is available in a separate modulehelidon-integrations-oci-authentication-resource
oke-workload-identity
- use identity of the OCI Kubernetes workload, usescom.oracle.bmc.auth.okeworkloadidentity.OkeWorkloadIdentityAuthenticationDetailsProvider
, and is available in a separate modulehelidon-integrations-oci-authentication-oke-workload
- Specified by:
authenticationMethod
in interfaceOciConfig
- Returns:
- the authentication method to apply
- "auto" - use the list of
-
allowedAuthenticationMethods
Description copied from interface:OciConfig
List of attempted authentication strategies in caseOciConfig.authenticationMethod()
is set to "auto".In case the list is empty, all available strategies will be tried, ordered by their
Weight
- Specified by:
allowedAuthenticationMethods
in interfaceOciConfig
- Returns:
- list of authentication strategies to be tried
- See Also:
-
configMethodConfig
Description copied from interface:OciConfig
Config method configuration (if provided and used).- Specified by:
configMethodConfig
in interfaceOciConfig
- Returns:
- information needed for config
OciConfig.authenticationMethod()
-
configFileMethodConfig
Description copied from interface:OciConfig
Config file method configuration (if provided and used).- Specified by:
configFileMethodConfig
in interfaceOciConfig
- Returns:
- information to customize config for
OciConfig.authenticationMethod()
-
sessionTokenMethodConfig
Description copied from interface:OciConfig
Session token method configuration (if provided and used).- Specified by:
sessionTokenMethodConfig
in interfaceOciConfig
- Returns:
- information to customize config for
OciConfig.authenticationMethod()
-
imdsTimeout
Description copied from interface:OciConfig
The OCI IMDS connection timeout. This is used to auto-detect availability.This configuration property is used when attempting to connect to the metadata service.
- Specified by:
imdsTimeout
in interfaceOciConfig
- Returns:
- the OCI IMDS connection timeout
-
imdsBaseUri
Description copied from interface:OciConfig
The OCI IMDS URI (http URL pointing to the metadata service, if customization needed).- Specified by:
imdsBaseUri
in interfaceOciConfig
- Returns:
- the OCI IMDS URI
-
imdsDetectRetries
Description copied from interface:OciConfig
Customize the number of retries to contact IMDS service.- Specified by:
imdsDetectRetries
in interfaceOciConfig
- Returns:
- number of retries, each provider has its own defaults
-
authenticationTimeout
Description copied from interface:OciConfig
Timeout of authentication operations, where applicable. This is a timeout for each operation (if there are retries, each timeout will be this duration). Defaults to 10 seconds.- Specified by:
authenticationTimeout
in interfaceOciConfig
- Returns:
- authentication operation timeout
-
federationEndpoint
Description copied from interface:OciConfig
Customization of federation endpoint for authentication providers.- Specified by:
federationEndpoint
in interfaceOciConfig
- Returns:
- custom federation endpoint URI
-
tenantId
Description copied from interface:OciConfig
OCI tenant id for Instance Principal, Resource Principal or OKE Workload. -
config
Description copied from interface:OciConfig
Get the config used to update the builder. -
toString
-
equals
-
hashCode
public int hashCode()
-