10Duke Scale SDK for Java
Loading...
Searching...
No Matches
tenduke.scale.api.LicenseCheckoutClient Interface Reference

Detailed Description

License checkout client interface that uses  LicenseCheckoutHttpClient to operate the checkout API and TokenManager to store tokens received from the API.

Inheritance diagram for tenduke.scale.api.LicenseCheckoutClient:
tenduke.scale.client.DefaultLicenseCheckoutClient

Public Member Functions

List< LicenseTokencheckoutLicense (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< LicenseTokencheckoutLicenseByKey (String licenseKey, Map< String, String > claims, List< LicenseCheckoutArguments > consumptionArguments)
 Checkout a license using a license key.
 
List< LicenseTokenstartMeteredUseOfLicense (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< LicenseTokenstartMeteredUseByLicenseKey (String licenseKey, Map< String, String > claims, List< LicenseCheckoutArguments > consumptionArguments)
 Starts metered use of a license using a license key.
 
List< LicenseTokenheartbeatLicense (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< LicenseTokenheartbeatMeteredLicense (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< LicenseTokenheartbeatLicense (Map< String, String > claims, String licenseKey, List< LicenseHeartbeatArguments > heartbeatArguments)
 Heartbeat a license using a license key.
 
List< LicenseTokenheartbeatMeteredLicense (Map< String, String > claims, String licenseKey, List< LicenseHeartbeatArguments > heartbeatArguments)
 Heartbeat a metered license using a license key.
 
List< LicenseReleaseResultreleaseLicense (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< LicenseReleaseResultreleaseLicense (Map< String, String > claims, String licenseKey, List< LicenseReleaseArguments > releaseArguments)
 Release a license using a license key.
 
List< LicenseReleaseResultendMeteredLicenseUse (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< LicenseReleaseResultendMeteredLicenseUse (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< LicenseedescribeLicenseConsumerLicensees (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.
 

Member Function Documentation

◆ checkoutLicense()

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.

Parameters
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
consumptionArgumentsList of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument.
Returns
License checkout result as LicenseToken's. Note: checkout failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ checkoutLicenseByKey()

List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.checkoutLicenseByKey ( String licenseKey,
Map< String, String > claims,
List< LicenseCheckoutArguments > consumptionArguments )

Checkout a license using a license key.

Parameters
licenseKeyThe license key, must not be blank.
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
consumptionArgumentsList of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument.
Returns
License checkout result LicenseToken's. Note: checkout failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicenseClientBindings()

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.

Parameters
licenseeIdAn identifier to scope the find within licenses of a specific licensee.
licenseIdThe identifier of the license, which client bindings are requested.
licenseConsumerIdOptional identifier of the license consumer, which client bindings are requested.
filterFieldName of field to apply filter value on. Defaults to null (no filtering). See the API docs for allowed values.
filterValueFilter value to apply on licenses. Defaults to null (no filtering).
withMetadataFlag 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.
offsetOffset for paging results.
maxCountLimit for controlling result size.
orderByField name to order results by. Defaults to the LicenseConsumptionClientBinding.validFrom field. See the API docs for allowed values.
ascFlag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order.
Returns
A LicenseConsumerClientBindingStatus with information about the license consumption client binding. Throws an ApiException if the client binding is not found.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicenseConsumerClientBindings()

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.

Parameters
licenseeIdIdentifier of the licensee that the license belongs to.
licenseConsumerIdIdentifier 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.
filterFieldName of field to apply filter value on. Defaults to null (no filtering). See the API docs for allowed values.
filterValueFilter value to apply on licenses. Defaults to null (no filtering).
withMetadataFlag 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.
offsetOffset for paging results. Defaults to 0.
maxCountLimit for controlling result size. Defaults to 5.
orderByField name to order results by. Defaults to the LicenseConsumptionClientBinding.validFrom field. See the API docs for allowed values.
ascFlag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order.
Returns
Information about a license consumer's current license consumption client binding.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicenseConsumerLicensees()

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.

Parameters
licenseConsumerIdIdentifier 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.
offsetOffset for paging results. Defaults to 0.
maxCountLimit for controlling result size. Defaults to 5.
orderByField name to order results by. Defaults to the Licensee.naturalId field. See the API docs for allowed values.
ascFlag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order.
Returns
A list of licensees who's licenses the license consumer is entitled to use.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicenseConsumerLicenses()

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.

Parameters
licenseeIdIdentifier of the licensee that the license belongs to.
licenseConsumerIdIdentifier 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.
filterFieldName of field to apply filter value on. Defaults to null (no filtering). See the API docs for allowed values.
filterValueFilter value to apply on licenses. Defaults to null (no filtering).
withMetadataFlag 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.
offsetOffset for paging results. Defaults to 0. Applies to licenses, not the additional information included when parameter withMetadata == true.
maxCountLimit for controlling result size. Defaults to 5. Applies to licenses, not the additional information included when parameter withMetadata == true.
orderByField name to order results by. Defaults to the License.validFrom field. See the API docs for allowed values.
ascFlag that controls ordering in ascending vs. descending order. Defaults to false, meaning descending order.
Returns
Information about a licensee's licenses that a license consumer is entitled to use.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicenseKeyLicenses()

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.

Parameters
licenseKeyThe license key used to query license information.
withMetadataFlag 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.
Returns
Information about the license(s) that the license key entitles to use.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicensesAsFeatureFlags()

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.

Parameters
licenseeIdIdentifier of the licensee that the licenses belongs to.
licenseConsumerIdIdentifier 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.
filterValueProduct name to match in result. Defaults to null (no filtering). The match is full name, case insensitive
Returns
A list of feature flags structured with a per product breakdown describing what is enabled for the license consumer.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ describeLicensesAsFeatureFlagsJwt()

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.

Parameters
licenseeIdIdentifier of the licensee that the licenses belongs to.
licenseConsumerIdIdentifier 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.
filterValueProduct name to match in result. Defaults to null (no filtering). The match is full name, case insensitive
Returns
A JWT with information about feature flags enabled for a license consumer.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ endMeteredLicenseUse() [1/2]

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.

Parameters
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
releaseArgumentsList of argument objects specific for each license to release. The list must contain at least 1 release argument.
Returns
License release result 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.

◆ endMeteredLicenseUse() [2/2]

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.

Parameters
licenseKeyThe license key, must not be blank.
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
releaseArgumentsList of argument objects specific for each license to release. The list must contain at least 1 release argument.
Returns
License release result 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.

◆ findLicenseClientBinding()

LicenseConsumerClientBindingStatus tenduke.scale.api.LicenseCheckoutClient.findLicenseClientBinding ( UUID licenseeId,
long clientBindingId,
boolean withMetadata )

Finds a specific license consumption client binding.

Parameters
licenseeIdThe identifier to scope the find within licenses of a specific licensee.
clientBindingIdIdentifier of the license consumption client binding to find.
withMetadataFlag to control if additional metadata is included in the response. A false value will yield better performance.
Returns
A LicenseConsumerClientBindingStatus with information about the license consumption client binding. Throws an ApiException if the client binding is not found.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ heartbeatLicense() [1/2]

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.

Parameters
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
heartbeatArgumentsList of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument.
Returns
License heartbeat result LicenseToken's. Note: heartbeat failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ heartbeatLicense() [2/2]

List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.heartbeatLicense ( Map< String, String > claims,
String licenseKey,
List< LicenseHeartbeatArguments > heartbeatArguments )

Heartbeat a license using a license key.

Parameters
licenseKeyThe license key, must not be blank.
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
heartbeatArgumentsList of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument.
Returns
License heartbeat result LicenseToken's. Note: heartbeat failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ heartbeatMeteredLicense() [1/2]

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.

Parameters
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
heartbeatArgumentsList of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument.
Returns
License heartbeat result LicenseToken's. Note: heartbeat failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ heartbeatMeteredLicense() [2/2]

List< LicenseToken > tenduke.scale.api.LicenseCheckoutClient.heartbeatMeteredLicense ( Map< String, String > claims,
String licenseKey,
List< LicenseHeartbeatArguments > heartbeatArguments )

Heartbeat a metered license using a license key.

Parameters
licenseKeyThe license key, must not be blank.
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
heartbeatArgumentsList of argument objects specific for each license to heartbeat. The list must contain at least 1 heartbeat argument.
Returns
License heartbeat result LicenseToken's. Note: heartbeat failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ releaseLicense() [1/2]

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.

Parameters
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
releaseArgumentsList of argument objects specific for each license to release. The list must contain at least 1 release argument.
Returns
License release result 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.

◆ releaseLicense() [2/2]

List< LicenseReleaseResult > tenduke.scale.api.LicenseCheckoutClient.releaseLicense ( Map< String, String > claims,
String licenseKey,
List< LicenseReleaseArguments > releaseArguments )

Release a license using a license key.

Parameters
licenseKeyThe license key, must not be blank.
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
releaseArgumentsList of argument objects specific for each license to release. The list must contain at least 1 release argument.
Returns
License release result 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.

◆ startMeteredUseByLicenseKey()

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.

Parameters
licenseKeyThe license key, must not be blank.
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
consumptionArgumentsList of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument.
Returns
License checkout result LicenseToken's. Note: checkout failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.

◆ startMeteredUseOfLicense()

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.

Parameters
claimsClient application claims like hardware id, etc. Use model class ClientClaims as utility to assemble the claims.
consumptionArgumentsList of argument objects specific for each license to checkout. The list must contain at least 1 consumption argument.
Returns
License checkout result LicenseToken's. Note: checkout failure is also communicated as a LicenseToken.

Implemented in tenduke.scale.client.DefaultLicenseCheckoutClient.


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