Class OciConfig.BuilderBase.OciConfigImpl
- All Implemented Interfaces:
Prototype.Api
,OciConfig
- Enclosing class:
OciConfig.BuilderBase<BUILDER extends OciConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OciConfig>
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.helidon.integrations.oci.sdk.runtime.OciConfig
OciConfig.Builder, OciConfig.BuilderBase<BUILDER extends OciConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends OciConfig> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Deprecated, for removal: This API element is subject to removal in a future version.Config key of this config.static final String
Deprecated, for removal: This API element is subject to removal in a future version.Redefine the constant, as it is private in BMC.static final String
Deprecated, for removal: This API element is subject to removal in a future version.Primary hostname of metadata service. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
OciConfigImpl
(OciConfig.BuilderBase<?, ?> builder) Create an instance providing a builder. -
Method Summary
Modifier and TypeMethodDescriptionThe OCI authentication fingerprint.The OCI authentication key file.Optional
<char[]> The OCI authentication passphrase.Optional
<char[]> The OCI authentication private key.The OCI authentication key file path.The OCI region.The list of authentication strategies that will be attempted byAbstractAuthenticationDetailsProvider
when one is called for.The singular authentication strategy to apply.The OCI tenant id.The OCI user id.The OCI configuration profile path.The OCI configuration/auth profile name.boolean
default boolean
Deprecated, for removal: This API element is subject to removal in a future version.Determines whether sufficient configuration is present on this bean to be used for OCI's "file-based" authentication provider.int
hashCode()
The OCI IMDS hostname.The OCI IMDS connection timeout.Deprecated, for removal: This API element is subject to removal in a future version.The list ofOciAuthenticationDetailsProvider.AuthStrategy
names (excludingOciAuthenticationDetailsProvider.AuthStrategy.AUTO
) that are potentially applicable for use.default boolean
Deprecated, for removal: This API element is subject to removal in a future version.Determines whether sufficient configuration is present on this bean to be used for OCI's "simple" authentication provider.toString()
-
Field Details
-
CONFIG_KEY
Deprecated, for removal: This API element is subject to removal in a future version.Config key of this config.- See Also:
-
IMDS_HOSTNAME
Deprecated, for removal: This API element is subject to removal in a future version.Primary hostname of metadata service.- See Also:
-
DEFAULT_PROFILE_NAME
Deprecated, for removal: This API element is subject to removal in a future version.Redefine the constant, as it is private in BMC.- See Also:
-
-
Constructor Details
-
OciConfigImpl
Create an instance providing a builder.- Parameters:
builder
- extending builder base of this prototype
-
-
Method Details
-
authStrategy
Description copied from interface:OciConfig
The singular authentication strategy to apply. This will be preferred overOciConfig.authStrategies()
if both are present.- Specified by:
authStrategy
in interfaceOciConfig
- Returns:
- the singular authentication strategy to be applied
-
authStrategies
Description copied from interface:OciConfig
The list of authentication strategies that will be attempted byAbstractAuthenticationDetailsProvider
when one is called for. This is only used ifOciConfig.authStrategy()
is not present.auto
- if present in the list, or if no value for this property exists.config
- theSimpleAuthenticationDetailsProvider
will be used, customized with other configuration properties described here.config-file
- theConfigFileAuthenticationDetailsProvider
will be used, customized with other configuration properties described here.instance-principals
- theInstancePrincipalsAuthenticationDetailsProvider
will be used.resource-principal
- theResourcePrincipalAuthenticationDetailsProvider
will be used.
If there are more than one strategy descriptors defined, the first one that is deemed to be available/suitable will be used and all others will be ignored.
- Specified by:
authStrategies
in interfaceOciConfig
- Returns:
- the list of authentication strategies that will be applied, defaulting to
auto
- See Also:
-
configPath
Description copied from interface:OciConfig
The OCI configuration profile path.This configuration property has an effect only when
config-file
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known asfileConfigIsPresent()
. When it is present, this property must also be present and then the ConfigFileReader.parse(String) method will be passed this value. It is expected to be passed with a valid OCI configuration file path.- Specified by:
configPath
in interfaceOciConfig
- Returns:
- the OCI configuration profile path
-
configProfile
Description copied from interface:OciConfig
The OCI configuration/auth profile name.This configuration property has an effect only when
config-file
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known asfileConfigIsPresent()
. When it is present, this property may also be optionally provided in order to override the default "DEFAULT".- Specified by:
configProfile
in interfaceOciConfig
- Returns:
- the optional OCI configuration/auth profile name
-
authFingerprint
Description copied from interface:OciConfig
The OCI authentication fingerprint.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, this property must be provided in order to set the API signing key's fingerprint. See SimpleAuthenticationDetailsProvider.getFingerprint() for more details.- Specified by:
authFingerprint
in interfaceOciConfig
- Returns:
- the OCI authentication fingerprint
-
authKeyFile
Description copied from interface:OciConfig
The OCI authentication key file.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, this property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPrivateKey(). This file must exist in theuser.home
directory. Alternatively, this property can be set using eitherOciConfig.authPrivateKey()
or usingOciConfig.authPrivateKeyPath()
.- Specified by:
authKeyFile
in interfaceOciConfig
- Returns:
- the OCI authentication key file
-
authPrivateKeyPath
Description copied from interface:OciConfig
The OCI authentication key file path.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, this property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPrivateKey(). This file path is an alternative for usingOciConfig.authKeyFile()
where the file must exist in theuser.home
directory. Alternatively, this property can be set usingOciConfig.authPrivateKey()
.- Specified by:
authPrivateKeyPath
in interfaceOciConfig
- Returns:
- the OCI authentication key file path
-
authPrivateKey
Description copied from interface:OciConfig
The OCI authentication private key.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, this property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPrivateKey(). Alternatively, this property can be set using eitherOciConfig.authKeyFile()
residing in theuser.home
directory, or usingOciConfig.authPrivateKeyPath()
.- Specified by:
authPrivateKey
in interfaceOciConfig
- Returns:
- the OCI authentication private key
-
authPassphrase
Description copied from interface:OciConfig
The OCI authentication passphrase.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, this property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPassphraseCharacters().- Specified by:
authPassphrase
in interfaceOciConfig
- Returns:
- the OCI authentication passphrase
-
authRegion
Description copied from interface:OciConfig
The OCI region.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, either this property orRegionProvider
must be provide a value in order to set the ConfigFileAuthenticationDetailsProvider.getRegion().- Specified by:
authRegion
in interfaceOciConfig
- Returns:
- the OCI region
-
authTenantId
Description copied from interface:OciConfig
The OCI tenant id.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. This is also known assimpleConfigIsPresent()
. When it is present, this property must be provided in order to set the ConfigFileAuthenticationDetailsProvider.getTenantId().- Specified by:
authTenantId
in interfaceOciConfig
- Returns:
- the OCI tenant id
-
authUserId
Description copied from interface:OciConfig
The OCI user id.This configuration property has an effect only when
config
is, explicitly or implicitly, present in the value for theOciConfig.authStrategies()
. When it is present, this property must be provided in order to set the ConfigFileAuthenticationDetailsProvider.getUserId().- Specified by:
authUserId
in interfaceOciConfig
- Returns:
- the OCI user id
-
imdsHostName
Description copied from interface:OciConfig
The OCI IMDS hostname.This configuration property is used to identify the metadata service url.
- Specified by:
imdsHostName
in interfaceOciConfig
- Returns:
- the OCI IMDS hostname
-
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
- See Also:
-
toString
-
equals
-
hashCode
public int hashCode() -
potentialAuthStrategies
Deprecated, for removal: This API element is subject to removal in a future version.The list ofOciAuthenticationDetailsProvider.AuthStrategy
names (excludingOciAuthenticationDetailsProvider.AuthStrategy.AUTO
) that are potentially applicable for use. Here, "potentially applicable for use" means that it is set using theauthStrategy()
attribute on this config bean. If not present then the fall-back looks to use the values explicitly or implicitly set byauthStrategies()
. Note that the order of this list is important as it pertains to the search/strategy ordering.- Returns:
- the list of potential auth strategies that are applicable
-
fileConfigIsPresent
default boolean fileConfigIsPresent()Deprecated, for removal: This API element is subject to removal in a future version.Determines whether sufficient configuration is present on this bean to be used for OCI's "file-based" authentication provider. This matches to theOciAuthenticationDetailsProvider.AuthStrategy.CONFIG_FILE
.- Returns:
- true if there is sufficient attributes defined for file-based OCI authentication provider applicability
- See Also:
-
simpleConfigIsPresent
default boolean simpleConfigIsPresent()Deprecated, for removal: This API element is subject to removal in a future version.Determines whether sufficient configuration is present on this bean to be used for OCI's "simple" authentication provider. This matches to theOciAuthenticationDetailsProvider.AuthStrategy.CONFIG
.- Returns:
- true if there is sufficient attributes defined for simple OCI authentication provider applicability
- See Also:
-