10Duke Scale SDK for Java
|
License checkout client interface that uses LicenseCheckoutHttpClient
to operate the checkout API and TokenManager
to store tokens received from the API.
Public Member Functions | |
List< LicenseToken > | checkoutLicense (Map< String, String > claims, List< LicenseCheckoutArguments > consumptionArguments) |
Checkout a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization. | |
List< LicenseToken > | checkoutLicenseByKey (String licenseKey, Map< String, String > claims, List< LicenseCheckoutArguments > consumptionArguments) |
Checkout a license using a license key. | |
List< LicenseToken > | startMeteredUseOfLicense (Map< String, String > claims, List< LicenseCheckoutArguments > consumptionArguments) |
Starts metered use of a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization. | |
List< LicenseToken > | startMeteredUseByLicenseKey (String licenseKey, Map< String, String > claims, List< LicenseCheckoutArguments > consumptionArguments) |
Starts metered use of a license using a license key. | |
List< LicenseToken > | heartbeatLicense (Map< String, String > claims, List< LicenseHeartbeatArguments > heartbeatArguments) |
Heartbeat a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization. | |
List< LicenseToken > | heartbeatMeteredLicense (Map< String, String > claims, List< LicenseHeartbeatArguments > heartbeatArguments) |
Heartbeat a metered license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization. | |
List< LicenseToken > | heartbeatLicense (Map< String, String > claims, String licenseKey, List< LicenseHeartbeatArguments > heartbeatArguments) |
Heartbeat a license using a license key. | |
List< LicenseToken > | heartbeatMeteredLicense (Map< String, String > claims, String licenseKey, List< LicenseHeartbeatArguments > heartbeatArguments) |
Heartbeat a metered license using a license key. | |
List< LicenseReleaseResult > | releaseLicense (Map< String, String > claims, List< LicenseReleaseArguments > releaseArguments) |
Release a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization. | |
List< LicenseReleaseResult > | releaseLicense (Map< String, String > claims, String licenseKey, List< LicenseReleaseArguments > releaseArguments) |
Release a license using a license key. | |
List< LicenseReleaseResult > | endMeteredLicenseUse (Map< String, String > claims, List< LicenseReleaseArguments > releaseArguments) |
End a metered license usage by using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization. | |
List< LicenseReleaseResult > | endMeteredLicenseUse (Map< String, String > claims, String licenseKey, List< LicenseReleaseArguments > releaseArguments) |
End a metered license usage by using a license key. | |
FeatureFlagsResponse | describeLicensesAsFeatureFlags (UUID licenseeId, UUID licenseConsumerId, String filterValue) |
Analyzes licenses that a license consumer has access to and describes those licenses as feature flags. | |
String | describeLicensesAsFeatureFlagsJwt (UUID licenseeId, UUID licenseConsumerId, String filterValue) |
Analyzes licenses that a license consumer has access to and describes those licenses as feature flags. | |
LicenseConsumerLicensesStatus | describeLicenseConsumerLicenses (UUID licenseeId, UUID licenseConsumerId, String filterField, String filterValue, boolean withMetadata, int offset, int maxCount, String orderBy, boolean asc) |
Analyzes licenses that a license consumer has access to and describes the license status to determine the likely outcome if trying to use the licenses. | |
LicenseKeyLicensesStatus | describeLicenseKeyLicenses (String licenseKey, boolean withMetadata) |
Analyzes the license(s) that a license key entitles access to and describes the license status to determine the likely outcome if trying to use the license(s). | |
List< Licensee > | describeLicenseConsumerLicensees (UUID licenseConsumerId, int offset, int maxCount, String orderBy, boolean asc) |
Analyzes what licensees a license consumer is associated with. | |
LicenseConsumerClientBindingStatus | describeLicenseConsumerClientBindings (UUID licenseeId, UUID licenseConsumerId, String filterField, String filterValue, boolean withMetadata, int offset, int maxCount, String orderBy, boolean asc) |
Analyzes licenses that a license consumer is known to have a checkout for currently. | |
LicenseConsumerClientBindingStatus | describeLicenseClientBindings (UUID licenseeId, UUID licenseId, UUID licenseConsumerId, String filterField, String filterValue, boolean withMetadata, int offset, int maxCount, String orderBy, boolean asc) |
Analyzes currently known checkouts for a specific license. | |
LicenseConsumerClientBindingStatus | findLicenseClientBinding (UUID licenseeId, long clientBindingId, boolean withMetadata) |
Finds a specific license consumption client binding. | |
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.checkoutLicense | ( | Map< String, String > | claims, |
List< LicenseCheckoutArguments > | consumptionArguments ) |
Checkout a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization.
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
consumptionArguments | List of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument. |
LicenseToken
's. Note: checkout failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.checkoutLicenseByKey | ( | String | licenseKey, |
Map< String, String > | claims, | ||
List< LicenseCheckoutArguments > | consumptionArguments ) |
Checkout a license using a license key.
licenseKey | The license key, must not be blank. |
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
consumptionArguments | List of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument. |
LicenseToken
's. Note: checkout failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
LicenseConsumerClientBindingStatus tenduke.scale.api.LicenseCheckoutClient.describeLicenseClientBindings | ( | UUID | licenseeId, |
UUID | licenseId, | ||
UUID | licenseConsumerId, | ||
String | filterField, | ||
String | filterValue, | ||
boolean | withMetadata, | ||
int | offset, | ||
int | maxCount, | ||
String | orderBy, | ||
boolean | asc ) |
Analyzes currently known checkouts for a specific license.
This endpoint can be called using Scale JWT authorization. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.
licenseeId | An identifier to scope the find within licenses of a specific licensee. |
licenseId | The identifier of the license, which client bindings are requested. |
licenseConsumerId | Optional identifier of the license consumer, which client bindings are requested. |
filterField | Name of field to apply filter value on. Defaults to null (no filtering). See the API docs for allowed values. |
filterValue | Filter value to apply on licenses. Defaults to null (no filtering). |
withMetadata | Flag to control including verbose information about the licenses and client bindings. Setting this option to true will fetch contract, order, subscription and external reference information at time of original license grant, the license container, a possible license key and related product information. For client bindings the additional information is related to license consumption objects and license consumers. Defaults to false. |
offset | Offset for paging results. |
maxCount | Limit for controlling result size. |
orderBy | Field name to order results by. Defaults to the LicenseConsumptionClientBinding.validFrom field. See the API docs for allowed values. |
asc | Flag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order. |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
LicenseConsumerClientBindingStatus tenduke.scale.api.LicenseCheckoutClient.describeLicenseConsumerClientBindings | ( | UUID | licenseeId, |
UUID | licenseConsumerId, | ||
String | filterField, | ||
String | filterValue, | ||
boolean | withMetadata, | ||
int | offset, | ||
int | maxCount, | ||
String | orderBy, | ||
boolean | asc ) |
Analyzes licenses that a license consumer is known to have a checkout for currently.
This endpoint can be called using either Scale JWT authorization or by using an OIDC Id Token. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.
licenseeId | Identifier of the licensee that the license belongs to. |
licenseConsumerId | Identifier of the license consumer that the the information is scoped to. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model. |
filterField | Name of field to apply filter value on. Defaults to null (no filtering). See the API docs for allowed values. |
filterValue | Filter value to apply on licenses. Defaults to null (no filtering). |
withMetadata | Flag to control including verbose information about the licenses and client bindings. Setting this option to true will fetch contract, order, subscription and external reference information at time of original license grant, the license container, a possible license key and related product information. For client bindings the additional information is related to license consumption objects and license consumers. Defaults to false. |
offset | Offset for paging results. Defaults to 0. |
maxCount | Limit for controlling result size. Defaults to 5. |
orderBy | Field name to order results by. Defaults to the LicenseConsumptionClientBinding.validFrom field. See the API docs for allowed values. |
asc | Flag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order. |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< Licensee > tenduke.scale.api.LicenseCheckoutClient.describeLicenseConsumerLicensees | ( | UUID | licenseConsumerId, |
int | offset, | ||
int | maxCount, | ||
String | orderBy, | ||
boolean | asc ) |
Analyzes what licensees a license consumer is associated with.
The association is defined as a relation between a license consumer and one or more license containers that belong to licensees. This API method can be called using either Scale JWT authorization or by using an OIDC Id Token. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.
licenseConsumerId | Identifier of the license consumer to query licensees for. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model. |
offset | Offset for paging results. Defaults to 0. |
maxCount | Limit for controlling result size. Defaults to 5. |
orderBy | Field name to order results by. Defaults to the Licensee.naturalId field. See the API docs for allowed values. |
asc | Flag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order. |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
LicenseConsumerLicensesStatus tenduke.scale.api.LicenseCheckoutClient.describeLicenseConsumerLicenses | ( | UUID | licenseeId, |
UUID | licenseConsumerId, | ||
String | filterField, | ||
String | filterValue, | ||
boolean | withMetadata, | ||
int | offset, | ||
int | maxCount, | ||
String | orderBy, | ||
boolean | asc ) |
Analyzes licenses that a license consumer has access to and describes the license status to determine the likely outcome if trying to use the licenses.
This endpoint can be called using either Scale JWT authorization or an OIDC ID Token. When using Scale JWT authorization, the minimum permission grant definition is Licensing.action. NOTE: Paging parameters apply to licenses (the main level of data in the response). In other words, paging does not affect the additional information that is included in the response when parameter withMetadata == true.
licenseeId | Identifier of the licensee that the license belongs to. |
licenseConsumerId | Identifier of the license consumer that the the information is scoped to. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model. |
filterField | Name of field to apply filter value on. Defaults to null (no filtering). See the API docs for allowed values. |
filterValue | Filter value to apply on licenses. Defaults to null (no filtering). |
withMetadata | Flag to control including verbose information about the licenses. Setting this option to true will fetch contract, order, subscription and external reference information at time of original license grant, the license container, a possible license key and related product information. Defaults to false. |
offset | Offset for paging results. Defaults to 0. Applies to licenses, not the additional information included when parameter withMetadata == true. |
maxCount | Limit for controlling result size. Defaults to 5. Applies to licenses, not the additional information included when parameter withMetadata == true. |
orderBy | Field name to order results by. Defaults to the License.validFrom field. See the API docs for allowed values. |
asc | Flag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order. |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
LicenseKeyLicensesStatus tenduke.scale.api.LicenseCheckoutClient.describeLicenseKeyLicenses | ( | String | licenseKey, |
boolean | withMetadata ) |
Analyzes the license(s) that a license key entitles access to and describes the license status to determine the likely outcome if trying to use the license(s).
This endpoint authorizes access based on the validity of the license key alone.
licenseKey | The license key used to query license information. |
withMetadata | Flag to control including verbose information about the licenses. Setting this option to true will fetch contract, order, subscription and external reference information at time of original license grant, the license container, a possible license key and related product information. |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
FeatureFlagsResponse tenduke.scale.api.LicenseCheckoutClient.describeLicensesAsFeatureFlags | ( | UUID | licenseeId, |
UUID | licenseConsumerId, | ||
String | filterValue ) |
Analyzes licenses that a license consumer has access to and describes those licenses as feature flags.
This endpoint can be called using either Scale JWT authorization or by using an OIDC Id Token. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.
licenseeId | Identifier of the licensee that the licenses belongs to. |
licenseConsumerId | Identifier of the license consumer that the the information is scoped to. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model. |
filterValue | Product name to match in result. Defaults to null (no filtering). The match is full name, case insensitive |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
String tenduke.scale.api.LicenseCheckoutClient.describeLicensesAsFeatureFlagsJwt | ( | UUID | licenseeId, |
UUID | licenseConsumerId, | ||
String | filterValue ) |
Analyzes licenses that a license consumer has access to and describes those licenses as feature flags.
This endpoint can be called using either Scale JWT authorization or by using an OIDC Id Token. When using the Scale JWT authorization option the minimum permission grant definition is: Licensing.action.
licenseeId | Identifier of the licensee that the licenses belongs to. |
licenseConsumerId | Identifier of the license consumer that the the information is scoped to. NOTE: This parameter is required when using Scale JWT API authorization. Ignore this request parameter when using an OIDC Id Token as the API authorization model. |
filterValue | Product name to match in result. Defaults to null (no filtering). The match is full name, case insensitive |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseReleaseResult > tenduke.scale.api.LicenseCheckoutClient.endMeteredLicenseUse | ( | Map< String, String > | claims, |
List< LicenseReleaseArguments > | releaseArguments ) |
End a metered license usage by using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization.
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
releaseArguments | List of argument objects specific for each license to release. The list must contain at least 1 release argument. |
tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
's. Note: release failure is also communicated as a tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseReleaseResult > tenduke.scale.api.LicenseCheckoutClient.endMeteredLicenseUse | ( | Map< String, String > | claims, |
String | licenseKey, | ||
List< LicenseReleaseArguments > | releaseArguments ) |
End a metered license usage by using a license key.
licenseKey | The license key, must not be blank. |
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
releaseArguments | List of argument objects specific for each license to release. The list must contain at least 1 release argument. |
tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
's. Note: release failure is also communicated as a tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
LicenseConsumerClientBindingStatus tenduke.scale.api.LicenseCheckoutClient.findLicenseClientBinding | ( | UUID | licenseeId, |
long | clientBindingId, | ||
boolean | withMetadata ) |
Finds a specific license consumption client binding.
licenseeId | The identifier to scope the find within licenses of a specific licensee. |
clientBindingId | Identifier of the license consumption client binding to find. |
withMetadata | Flag to control if additional metadata is included in the response. A false value will yield better performance. |
Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.heartbeatLicense | ( | Map< String, String > | claims, |
List< LicenseHeartbeatArguments > | heartbeatArguments ) |
Heartbeat a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization.
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
heartbeatArguments | List of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument. |
LicenseToken
's. Note: heartbeat failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.heartbeatLicense | ( | Map< String, String > | claims, |
String | licenseKey, | ||
List< LicenseHeartbeatArguments > | heartbeatArguments ) |
Heartbeat a license using a license key.
licenseKey | The license key, must not be blank. |
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
heartbeatArguments | List of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument. |
LicenseToken
's. Note: heartbeat failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.heartbeatMeteredLicense | ( | Map< String, String > | claims, |
List< LicenseHeartbeatArguments > | heartbeatArguments ) |
Heartbeat a metered license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization.
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
heartbeatArguments | List of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument. |
LicenseToken
's. Note: heartbeat failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.heartbeatMeteredLicense | ( | Map< String, String > | claims, |
String | licenseKey, | ||
List< LicenseHeartbeatArguments > | heartbeatArguments ) |
Heartbeat a metered license using a license key.
licenseKey | The license key, must not be blank. |
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
heartbeatArguments | List of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument. |
LicenseToken
's. Note: heartbeat failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseReleaseResult > tenduke.scale.api.LicenseCheckoutClient.releaseLicense | ( | Map< String, String > | claims, |
List< LicenseReleaseArguments > | releaseArguments ) |
Release a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization.
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
releaseArguments | List of argument objects specific for each license to release. The list must contain at least 1 release argument. |
tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
's. Note: release failure is also communicated as a tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseReleaseResult > tenduke.scale.api.LicenseCheckoutClient.releaseLicense | ( | Map< String, String > | claims, |
String | licenseKey, | ||
List< LicenseReleaseArguments > | releaseArguments ) |
Release a license using a license key.
licenseKey | The license key, must not be blank. |
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
releaseArguments | List of argument objects specific for each license to release. The list must contain at least 1 release argument. |
tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
's. Note: release failure is also communicated as a tenduke.scale.api.model.licensecheckout.LicenseReleaseResult
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.startMeteredUseByLicenseKey | ( | String | licenseKey, |
Map< String, String > | claims, | ||
List< LicenseCheckoutArguments > | consumptionArguments ) |
Starts metered use of a license using a license key.
licenseKey | The license key, must not be blank. |
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
consumptionArguments | List of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument. |
LicenseToken
's. Note: checkout failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.
List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.startMeteredUseOfLicense | ( | Map< String, String > | claims, |
List< LicenseCheckoutArguments > | consumptionArguments ) |
Starts metered use of a license using either Open ID Connect API authorization (OIDC, identity based licensing) or using the Scale JWT API authorization.
claims | Client application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims. |
consumptionArguments | List of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument. |
LicenseToken
's. Note: checkout failure is also communicated as a LicenseToken
. Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.