Module io.helidon.integrations.oci

Package io.helidon.integrations.oci

Class SessionTokenMethodConfig.BuilderBase.SessionTokenMethodConfigImpl

java.lang.Object

io.helidon.integrations.oci.SessionTokenMethodConfig.BuilderBase.SessionTokenMethodConfigImpl

All Implemented Interfaces:

Prototype.Api, SessionTokenMethodConfig

Enclosing class:

SessionTokenMethodConfig.BuilderBase<BUILDER extends SessionTokenMethodConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SessionTokenMethodConfig>

protected static class SessionTokenMethodConfig.BuilderBase.SessionTokenMethodConfigImpl
extends Object
implements SessionTokenMethodConfig

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

SessionTokenMethodConfig.Builder, SessionTokenMethodConfig.BuilderBase<BUILDER extends SessionTokenMethodConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SessionTokenMethodConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SessionTokenMethodConfigImpl(SessionTokenMethodConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	fingerprint()	The OCI authentication fingerprint.
int	hashCode()
Optional<Duration>	initialRefreshDelay()	Delay of the first refresh.
Optional<char[]>	passphrase()	The OCI authentication passphrase.
Optional<Path>	privateKeyPath()	The OCI authentication private key resource.
Optional<Duration>	refreshPeriod()	Refresh period, i.e.
String	region()	The OCI region.
Optional<ScheduledExecutorService>	scheduler()	Customize the scheduled executor service to use for scheduling.
Optional<Long>	sessionLifetimeHours()	Maximal lifetime of a session.
Optional<String>	sessionToken()	Session token value.
Optional<Path>	sessionTokenPath()	Session token path.
String	tenantId()	The OCI tenant id.
String	toString()
String	userId()	The OCI user id.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SessionTokenMethodConfigImpl

protected SessionTokenMethodConfigImpl(SessionTokenMethodConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

region

public String region()

Description copied from interface: SessionTokenMethodConfig

The OCI region.

Specified by:

region in interface SessionTokenMethodConfig

Returns:

the OCI region

fingerprint

public String fingerprint()

Description copied from interface: SessionTokenMethodConfig

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.

Specified by:

fingerprint in interface SessionTokenMethodConfig

Returns:

the OCI authentication fingerprint

passphrase

public Optional<char[]> passphrase()

Description copied from interface: SessionTokenMethodConfig

The OCI authentication passphrase.

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

Specified by:

passphrase in interface SessionTokenMethodConfig

Returns:

the OCI authentication passphrase

tenantId

public String tenantId()

Description copied from interface: SessionTokenMethodConfig

The OCI tenant id.

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

Specified by:

tenantId in interface SessionTokenMethodConfig

Returns:

the OCI tenant id

userId

public String userId()

Description copied from interface: SessionTokenMethodConfig

The OCI user id.

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

Specified by:

userId in interface SessionTokenMethodConfig

Returns:

the OCI user id

privateKeyPath

public Optional<Path> privateKeyPath()

Description copied from interface: SessionTokenMethodConfig

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.

Specified by:

privateKeyPath in interface SessionTokenMethodConfig

Returns:

the OCI authentication key file

sessionTokenPath

public Optional<Path> sessionTokenPath()

Description copied from interface: SessionTokenMethodConfig

Session token path. If both this value, and SessionTokenMethodConfig.sessionToken() is defined, the value of SessionTokenMethodConfig.sessionToken() is used.

Specified by:

sessionTokenPath in interface SessionTokenMethodConfig

Returns:

session token path

sessionToken

public Optional<String> sessionToken()

Description copied from interface: SessionTokenMethodConfig

Session token value. If both this value, and SessionTokenMethodConfig.sessionTokenPath() is defined, this value is used.

Specified by:

sessionToken in interface SessionTokenMethodConfig

Returns:

session token

initialRefreshDelay

public Optional<Duration> initialRefreshDelay()

Description copied from interface: SessionTokenMethodConfig

Delay of the first refresh. Defaults to 0, to refresh immediately (implemented in the authentication details provider).

Specified by:

initialRefreshDelay in interface SessionTokenMethodConfig

Returns:

initial refresh delay

See Also:

• SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder.initialRefreshDelay(long)

refreshPeriod

public Optional<Duration> refreshPeriod()

Description copied from interface: SessionTokenMethodConfig

Refresh period, i.e. how often refresh occurs. Defaults to 55 minutes (implemented in the authentication details provider).

Specified by:

refreshPeriod in interface SessionTokenMethodConfig

Returns:

refresh period

See Also:

• SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder.refreshPeriod(long)

sessionLifetimeHours

public Optional<Long> sessionLifetimeHours()

Description copied from interface: SessionTokenMethodConfig

Maximal lifetime of a session. Defaults to (and maximum is) 24 hours. Can only be set to a lower value.

Specified by:

sessionLifetimeHours in interface SessionTokenMethodConfig

Returns:

lifetime of a session in hours

scheduler

public Optional<ScheduledExecutorService> scheduler()

Description copied from interface: SessionTokenMethodConfig

Customize the scheduled executor service to use for scheduling. Defaults to a single thread executor service.

Specified by:

scheduler in interface SessionTokenMethodConfig

Returns:

scheduled executor service

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object