Class SessionTokenMethodConfig.BuilderBase<BUILDER extends SessionTokenMethodConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SessionTokenMethodConfig>
- Type Parameters:
BUILDER
- type of the builder extending this abstract builderPROTOTYPE
- type of the prototype interface that would be built byPrototype.Builder.buildPrototype()
- All Implemented Interfaces:
Prototype.Builder<BUILDER,
,PROTOTYPE> Prototype.ConfiguredBuilder<BUILDER,
PROTOTYPE>
- Direct Known Subclasses:
SessionTokenMethodConfig.Builder
- Enclosing interface:
SessionTokenMethodConfig
SessionTokenMethodConfig
.-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
Generated implementation of the prototype, can be extended by descendant prototype implementations. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionClear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.Clear existing value of this property.config()
If this instance was configured, this would be the config instance used.Update builder from configuration (node of this type).The OCI authentication fingerprint.fingerprint
(String fingerprint) The OCI authentication fingerprint.from
(SessionTokenMethodConfig prototype) Update this builder from an existing prototype instance.from
(SessionTokenMethodConfig.BuilderBase<?, ?> builder) Update this builder from an existing prototype builder instance.Delay of the first refresh.initialRefreshDelay
(Duration initialRefreshDelay) Delay of the first refresh.Optional
<char[]> The OCI authentication passphrase.passphrase
(char[] passphrase) The OCI authentication passphrase.passphrase
(String passphrase) The OCI authentication passphrase.protected void
Handles providers and decorators.The OCI authentication private key resource.privateKeyPath
(Path privateKeyPath) The OCI authentication private key resource.Refresh period, i.e.refreshPeriod
(Duration refreshPeriod) Refresh period, i.e.region()
The OCI region.The OCI region.Customize the scheduled executor service to use for scheduling.scheduler
(ScheduledExecutorService scheduler) Customize the scheduled executor service to use for scheduling.Maximal lifetime of a session.sessionLifetimeHours
(long sessionLifetimeHours) Maximal lifetime of a session.Session token value.sessionToken
(String sessionToken) Session token value.Session token path.sessionTokenPath
(Path sessionTokenPath) Session token path.tenantId()
The OCI tenant id.The OCI tenant id.toString()
userId()
The OCI user id.The OCI user id.protected void
Validates required properties.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.helidon.builder.api.Prototype.Builder
buildPrototype, self
Methods inherited from interface io.helidon.builder.api.Prototype.ConfiguredBuilder
discoverService, discoverServices
-
Constructor Details
-
BuilderBase
protected BuilderBase()Protected to support extensibility.
-
-
Method Details
-
from
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
Update this builder from an existing prototype builder instance.- Parameters:
builder
- existing builder prototype to update this builder from- Returns:
- updated builder instance
-
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 interfacePrototype.ConfiguredBuilder<BUILDER extends SessionTokenMethodConfig.BuilderBase<BUILDER,
PROTOTYPE>, PROTOTYPE extends SessionTokenMethodConfig> - Parameters:
config
- configuration instance used to obtain values to update this builder- Returns:
- updated builder instance
-
region
The OCI region.- Parameters:
region
- the OCI region- Returns:
- updated builder instance
- See Also:
-
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:
-
clearPassphrase
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
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
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
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
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:
-
clearPrivateKeyPath
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
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.- Parameters:
privateKeyPath
- the OCI authentication key file- Returns:
- updated builder instance
- See Also:
-
clearSessionTokenPath
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
sessionTokenPath
Session token path. If both this value, andsessionToken()
is defined, the value ofsessionToken()
is used.- Parameters:
sessionTokenPath
- session token path- Returns:
- updated builder instance
- See Also:
-
clearSessionToken
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
sessionToken
Session token value. If both this value, andsessionTokenPath()
is defined, this value is used.- Parameters:
sessionToken
- session token- Returns:
- updated builder instance
- See Also:
-
clearInitialRefreshDelay
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
initialRefreshDelay
Delay of the first refresh. Defaults to 0, to refresh immediately (implemented in the authentication details provider).- Parameters:
initialRefreshDelay
- initial refresh delay- Returns:
- updated builder instance
- See Also:
-
clearRefreshPeriod
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
refreshPeriod
Refresh period, i.e. how often refresh occurs. Defaults to 55 minutes (implemented in the authentication details provider).- Parameters:
refreshPeriod
- refresh period- Returns:
- updated builder instance
- See Also:
-
clearSessionLifetimeHours
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
sessionLifetimeHours
Maximal lifetime of a session. Defaults to (and maximum is) 24 hours. Can only be set to a lower value.- Parameters:
sessionLifetimeHours
- lifetime of a session in hours- Returns:
- updated builder instance
- See Also:
-
clearScheduler
Clear existing value of this property.- Returns:
- updated builder instance
- See Also:
-
scheduler
Customize the scheduled executor service to use for scheduling. Defaults to a single thread executor service.- Parameters:
scheduler
- scheduled executor service- Returns:
- updated builder instance
- See Also:
-
region
The OCI region.- Returns:
- the region
-
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
-
passphrase
The OCI authentication passphrase.This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getPassphraseCharacters().
- Returns:
- the passphrase
-
tenantId
The OCI tenant id.This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getTenantId().
- Returns:
- the tenant id
-
userId
The OCI user id.This property must be provided in order to set the SimpleAuthenticationDetailsProvider.getUserId().
- Returns:
- the 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 private key path
-
sessionTokenPath
Session token path. If both this value, andsessionToken()
is defined, the value ofsessionToken()
is used.- Returns:
- the session token path
-
sessionToken
Session token value. If both this value, andsessionTokenPath()
is defined, this value is used.- Returns:
- the session token
-
initialRefreshDelay
Delay of the first refresh. Defaults to 0, to refresh immediately (implemented in the authentication details provider).- Returns:
- the 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:
- the 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:
- the session lifetime hours
-
scheduler
Customize the scheduled executor service to use for scheduling. Defaults to a single thread executor service.- Returns:
- the scheduler
-
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
-
preBuildPrototype
protected void preBuildPrototype()Handles providers and decorators. -
validatePrototype
protected void validatePrototype()Validates required properties.
-