tenduke.scale.api.config.InMemoryTendukeScaleConfig Class Reference

Detailed Description

Data class that stores memory based configuration of the 10Duke Scale SDK for Java.

Notes on values contained in instance members vs. values returned from implementation of interface tenduke.sdk.core.model.config.AuthConfig:

• tenduke.sdk.core.model.config.ConfigOperationMode controls logic to return the configuration contract's default values vs. the plain field value. Default values are defined by tenduke.sdk.core.model.config.AuthConfig (interface default implementation body).
• Documentation that talks about undefined values: an undefined value means technically null, Optional.empty() and any negative value for the primitive type number fields (HTTP timeout, local redirect port, token refresh leeway).

Inheritance diagram for tenduke.scale.api.config.InMemoryTendukeScaleConfig:

Public Member Functions
	InMemoryTendukeScaleConfig ()
	InMemoryTendukeScaleConfig (final URI licensingApiUrl)
	InMemoryTendukeScaleConfig (final URI licensingApiUrl, final ConfigOperationMode operationMode)
URI	licensingApiUrl ()
	Protocol and host name for the 10Duke API base URL. Returns the licensing API URL.
Optional< String >	licensingApiAuthorizationModel ()
	Method of authorization used for API calls.
boolean	tokenAutomaticInvalidationDisabled ()
	Controls whether automatic token invalidation on heartbeat failure is disabled.

Additional Inherited Members
Public Attributes inherited from tenduke.scale.api.config.TendukeScaleConfig
String	LICENSING_API_JWKS_URLS_PATH = "/licensing-signing-keys/.well-known/jwks.json"
	URL path to read public key used to verify JWTs received from the API: /licensing-signing-keys/.well-known/jwks.json.

Constructor & Destructor Documentation

InMemoryTendukeScaleConfig() [1/3]

tenduke.scale.api.config.InMemoryTendukeScaleConfig.InMemoryTendukeScaleConfig

(

)

InMemoryTendukeScaleConfig() [2/3]

tenduke.scale.api.config.InMemoryTendukeScaleConfig.InMemoryTendukeScaleConfig

(

final URI

licensingApiUrl

)

InMemoryTendukeScaleConfig() [3/3]

tenduke.scale.api.config.InMemoryTendukeScaleConfig.InMemoryTendukeScaleConfig	(	final URI	licensingApiUrl,
		final ConfigOperationMode	operationMode )

Member Function Documentation

licensingApiAuthorizationModel()

Optional< String > tenduke.scale.api.config.InMemoryTendukeScaleConfig.licensingApiAuthorizationModel

(

)

Method of authorization used for API calls.

Returns

A constant value denoting the API Authorization model. Defaults to: empty, which works for license key based API authorization.

Implements tenduke.scale.api.config.TendukeScaleConfig.

licensingApiUrl()

URI tenduke.scale.api.config.InMemoryTendukeScaleConfig.licensingApiUrl

(

)

Protocol and host name for the 10Duke API base URL.

Returns

the licensing API URL.

Returns

The 10Duke API base URL or null if the value has not been set.

Implements tenduke.scale.api.config.TendukeScaleConfig.

tokenAutomaticInvalidationDisabled()

boolean tenduke.scale.api.config.InMemoryTendukeScaleConfig.tokenAutomaticInvalidationDisabled

(

)

Controls whether automatic token invalidation on heartbeat failure is disabled.

When this returns true, the automatic invalidation of tokens on specific heartbeat failures is disabled. When false (default), tokens will be automatically invalidated when heartbeat fails with critical error codes.

Returns

true if automatic token invalidation is disabled, false otherwise. Defaults to false (automatic invalidation enabled).

Implements tenduke.scale.api.config.TendukeScaleConfig.

---

The documentation for this class was generated from the following file:

• api/src/main/java/tenduke/scale/api/config/InMemoryTendukeScaleConfig.java