Module io.helidon.integrations.oci
Package io.helidon.integrations.oci
Interface SessionTokenMethodConfig
- All Superinterfaces:
Prototype.Api
- All Known Implementing Classes:
SessionTokenMethodConfig.BuilderBase.SessionTokenMethodConfigImpl
Configuration of the
config
authentication method.- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic class
Fluent API builder forSessionTokenMethodConfig
.static class
SessionTokenMethodConfig.BuilderBase<BUILDER extends SessionTokenMethodConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends SessionTokenMethodConfig> Fluent API builder base forSessionTokenMethodConfig
. -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a new fluent API builder to customize configuration.builder
(SessionTokenMethodConfig instance) Create a new fluent API builder from an existing instance.static SessionTokenMethodConfig
create()
Create a new instance with default values.static SessionTokenMethodConfig
Create a new instance from configuration.The OCI authentication fingerprint.Delay of the first refresh.Optional
<char[]> The OCI authentication passphrase.The OCI authentication private key resource.Refresh period, i.e.region()
The OCI region.Customize the scheduled executor service to use for scheduling.Maximal lifetime of a session.Session token value.Session token path.tenantId()
The OCI tenant id.userId()
The OCI user id.
-
Method Details
-
builder
Create a new fluent API builder to customize configuration.- Returns:
- a new builder
-
builder
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
Create a new instance from configuration.- Parameters:
config
- used to configure the new instance- Returns:
- a new instance configured from configuration
-
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
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
Session token path. If both this value, andsessionToken()
is defined, the value ofsessionToken()
is used.- Returns:
- session token path
-
sessionToken
Session token value. If both this value, andsessionTokenPath()
is defined, this value is used.- Returns:
- session token
-
initialRefreshDelay
Delay of the first refresh. Defaults to 0, to refresh immediately (implemented in the authentication details provider).- Returns:
- initial refresh delay
- See Also:
-
refreshPeriod
Refresh period, i.e. how often refresh occurs. Defaults to 55 minutes (implemented in the authentication details provider).- Returns:
- refresh period
- See Also:
-
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
-