tenduke.scale.api.config.TendukeScaleConfig Interface Reference

Detailed Description

Interface to implement for providing required and optional configuration items used by the 10Duke Scale SDK for Java.

Note: depending on the application's licensing use case only parts of this interface may be implemented. E.g. the MVP implementation for a desktop application needing licenses based on license keys is implementing the licensingApiUrl() method.

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

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

Public Attributes
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.

Member Function Documentation

licensingApiAuthorizationModel()

default Optional< String > tenduke.scale.api.config.TendukeScaleConfig.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.

Implemented in tenduke.scale.api.config.InMemoryTendukeScaleConfig, tenduke.scale.api.config.TendukeScaleConfigWithFallback, and tenduke.scale.config.typesafe.TypesafeTendukeScaleConfig.

licensingApiUrl()

URI tenduke.scale.api.config.TendukeScaleConfig.licensingApiUrl

(

)

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

Returns

the licensing API URL.

Implemented in tenduke.scale.api.config.InMemoryTendukeScaleConfig, tenduke.scale.api.config.MinViableTendukeScaleConfig, tenduke.scale.api.config.TendukeScaleConfigWithFallback, and tenduke.scale.config.typesafe.TypesafeTendukeScaleConfig.

tokenAutomaticInvalidationDisabled()

boolean tenduke.scale.api.config.TendukeScaleConfig.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).

Implemented in tenduke.scale.api.config.InMemoryTendukeScaleConfig, tenduke.scale.api.config.MinViableTendukeScaleConfig, tenduke.scale.api.config.TendukeScaleConfigWithFallback, and tenduke.scale.config.typesafe.TypesafeTendukeScaleConfig.

Member Data Documentation

LICENSING_API_JWKS_URLS_PATH

String tenduke.scale.api.config.TendukeScaleConfig.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.

---

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

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