tenduke.scale.client.LicenseCheckoutApiCallFactory Class Reference

Detailed Description

This class implements raw HTTP 10Duke Scale License Checkout API mapping into a Java Client.

Public Member Functions
Call	checkout (final Map< String, String > headers, final List< LicenseCheckoutArguments > consumptionArguments)
	Make request to checkout license(s).
Call	checkout (final Map< String, String > headers, final String licenseKey, final List< LicenseCheckoutArguments > consumptionArguments)
	Make request to checkout license(s) using a license key.
Call	heartbeat (final Map< String, String > headers, final List< LicenseHeartbeatArguments > heartbeatArguments)
	Make request to heartbeat a license checkout made previously.
Call	heartbeat (final Map< String, String > headers, final String licenseKey, final List< LicenseHeartbeatArguments > heartbeatArguments)
	Make request to heartbeat a license checkout made previously.
Call	release (final Map< String, String > headers, final List< LicenseReleaseArguments > releaseArguments)
	Make a request to release license checkout(s).
Call	release (final Map< String, String > headers, final String licenseKey, final List< LicenseReleaseArguments > releaseArguments)
	Make a request to release license checkout(s).
Call	startMeteredUse (final Map< String, String > headers, final List< LicenseCheckoutArguments > consumptionArguments)
	Make request to start metered use of license(s).
Call	startMeteredUse (final Map< String, String > headers, final String licenseKey, final List< LicenseCheckoutArguments > consumptionArguments)
	Make request to start metered use of license(s) with a license key.
Call	heartbeatMeteredUse (final Map< String, String > headers, final List< LicenseHeartbeatArguments > heartbeatArguments)
	Make request to heartbeat metered use of license(s).
Call	heartbeatMeteredUse (final Map< String, String > headers, final String licenseKey, final List< LicenseHeartbeatArguments > heartbeatArguments)
	Make request to heartbeat metered use of license(s) with a license key.
Call	endMeteredUse (final Map< String, String > headers, final List< LicenseReleaseArguments > releaseArguments)
	Make request to end metered use of license(s).
Call	endMeteredUse (final Map< String, String > headers, final String licenseKey, final List< LicenseReleaseArguments > releaseArguments)
	Make request to end metered use of license(s) with a license key.
Call	describeLicensesAsFeatureFlags (final Map< String, String > headers, final UUID licenseeId, final UUID licenseConsumerId, final String productNameFilter)
	Describes licenses as feature flags for licenses that are accessible by a given license consumer.
Call	describeLicenseConsumerLicenses (final Map< String, String > headers, final UUID licenseeId, final UUID licenseConsumerId, final String filterField, final String filterValue, final boolean withMetadata)
	Makes a request to describe licenses that are accessible by a license consumer.
Call	describeLicenseKeyLicenses (final Map< String, String > headers, final String licenseKey, final boolean withMetadata)
	Makes a request to describe licenses that are accessible by a license key.
Call	describeLicenseConsumerLicensees (final Map< String, String > headers, final UUID licenseConsumerId)
	Makes a request to dDescribes a license consumers licensee associations.
Call	describeLicenseConsumerClientBindings (final Map< String, String > headers, final UUID licenseeId, final UUID licenseConsumerId, final String filterField, final String filterValue, final boolean withMetadata)
	Makes a call to describe license consumption client bindings currently known for the license consumer.
Call	describeLicenseClientBindings (final Map< String, String > headers, final UUID licenseeId, final UUID licenseId, final UUID licenseConsumerId, final String filterField, final String filterValue, final boolean withMetadata)
	Makes a call that describes current client bindings for a specific license.
Call	findLicenseClientBinding (final Map< String, String > headers, final UUID licenseeId, final long clientBindingId, final boolean withMetadata)
	Makes a call to finds and describe a specific client binding.

Member Function Documentation

checkout() [1/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.checkout	(	final Map< String, String >	headers,
		final List< LicenseCheckoutArguments >	consumptionArguments )

Make request to checkout license(s).

HTTP POST request path: /licensing/actions/checkout.

Parameters

headers	Request headers to send, must include the Authorization header.
consumptionArguments	List of consumption arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

checkout() [2/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.checkout	(	final Map< String, String >	headers,
		final String	licenseKey,
		final List< LicenseCheckoutArguments >	consumptionArguments )

Make request to checkout license(s) using a license key.

HTTP POST request path: /licensing/actions/checkout/{license_key}}.

Parameters

headers	Request headers to send.
licenseKey	The license key used for checkout.
consumptionArguments	List of consumption arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

describeLicenseClientBindings()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.describeLicenseClientBindings	(	final Map< String, String >	headers,
		final UUID	licenseeId,
		final UUID	licenseId,
		final UUID	licenseConsumerId,
		final String	filterField,
		final String	filterValue,
		final boolean	withMetadata )

Makes a call that describes current client bindings for a specific license.

This provides information about e.g. what devices a license is currently checked out on, what license consumers (users) are using the license, etc. HTTP GET request path: "/licensing/actions/describe-license-client-bindings".

Returns

An HTTP call that returns a list of LicenseConsumerClientBindingStatus object.

describeLicenseConsumerClientBindings()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.describeLicenseConsumerClientBindings	(	final Map< String, String >	headers,
		final UUID	licenseeId,
		final UUID	licenseConsumerId,
		final String	filterField,
		final String	filterValue,
		final boolean	withMetadata )

Makes a call to describe license consumption client bindings currently known for the license consumer.

HTTP GET request path: "/licensing/actions/describe-license-consumer-client-bindings".

Returns

An HTTP call that returns a list of LicenseConsumerClientBindingStatus object.

describeLicenseConsumerLicensees()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.describeLicenseConsumerLicensees	(	final Map< String, String >	headers,
		final UUID	licenseConsumerId )

Makes a request to dDescribes a license consumers licensee associations.

HTTP GET request path: "/licensing/actions/describe-license-consumer-licensees".

Returns

An HTTP call that returns a list of Licensee objects.

describeLicenseConsumerLicenses()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.describeLicenseConsumerLicenses	(	final Map< String, String >	headers,
		final UUID	licenseeId,
		final UUID	licenseConsumerId,
		final String	filterField,
		final String	filterValue,
		final boolean	withMetadata )

Makes a request to describe licenses that are accessible by a license consumer.

HTTP GET request path: "/licensing/actions/describe-license-consumer-licenses".

Returns

An HTTP call that returns a list of LicenseConsumerLicensesStatus objects.

describeLicenseKeyLicenses()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.describeLicenseKeyLicenses	(	final Map< String, String >	headers,
		final String	licenseKey,
		final boolean	withMetadata )

Makes a request to describe licenses that are accessible by a license key.

HTTP GET request path: "/licensing/actions/describe-license-key".

Returns

An HTTP call that returns a list of LicenseConsumerLicensesStatus objects.

describeLicensesAsFeatureFlags()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.describeLicensesAsFeatureFlags	(	final Map< String, String >	headers,
		final UUID	licenseeId,
		final UUID	licenseConsumerId,
		final String	productNameFilter )

Describes licenses as feature flags for licenses that are accessible by a given license consumer.

Returns

An HTTP call that returns a mapping of distinct license product names to distinct license features (for each unique product name the super set of features).

endMeteredUse() [1/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.endMeteredUse	(	final Map< String, String >	headers,
		final List< LicenseReleaseArguments >	releaseArguments )

Make request to end metered use of license(s).

HTTP POST request path: /licensing/actions/end-metered-use.

Parameters

headers	Request headers to send, must include the Authorization header.
releaseArguments	List of release arguments that form the request body.

Returns

An HTTP call that returns array of LicenseReleaseResult objects.

endMeteredUse() [2/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.endMeteredUse	(	final Map< String, String >	headers,
		final String	licenseKey,
		final List< LicenseReleaseArguments >	releaseArguments )

Make request to end metered use of license(s) with a license key.

HTTP POST request path: /licensing/actions/end-metered-use/{licenseKey}.

Parameters

headers	Request headers to send, must include the Authorization header.
licenseKey	The license key that was originally used to make the checkout.
releaseArguments	List of release arguments that form the request body.

Returns

An HTTP call that returns array of LicenseReleaseResult objects.

findLicenseClientBinding()

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.findLicenseClientBinding	(	final Map< String, String >	headers,
		final UUID	licenseeId,
		final long	clientBindingId,
		final boolean	withMetadata )

Makes a call to finds and describe a specific client binding.

This provides information about e.g. what devices a license is currently checked out on, what license consumers (users) are using the license, etc. HTTP GET request path: "/licensing/actions/find-license-client-binding".

Returns

An HTTP call that returns a singleton list with an LicenseConsumerClientBindingStatus object.

heartbeat() [1/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.heartbeat	(	final Map< String, String >	headers,
		final List< LicenseHeartbeatArguments >	heartbeatArguments )

Make request to heartbeat a license checkout made previously.

HTTP POST request path: /licensing/actions/heartbeat.

Parameters

headers	Request headers to send.
heartbeatArguments	List of heartbeat arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

heartbeat() [2/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.heartbeat	(	final Map< String, String >	headers,
		final String	licenseKey,
		final List< LicenseHeartbeatArguments >	heartbeatArguments )

Make request to heartbeat a license checkout made previously.

HTTP POST request path: /licensing/actions/heartbeat/{license_key}.

Parameters

headers	Request headers to send.
licenseKey	The license key used for checkout.
heartbeatArguments	List of heartbeat arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

heartbeatMeteredUse() [1/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.heartbeatMeteredUse	(	final Map< String, String >	headers,
		final List< LicenseHeartbeatArguments >	heartbeatArguments )

Make request to heartbeat metered use of license(s).

HTTP POST request path: /licensing/actions/heartbeat-metered-use.

Parameters

headers	Request headers to send, must include the Authorization header.
heartbeatArguments	List of heartbeat arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

heartbeatMeteredUse() [2/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.heartbeatMeteredUse	(	final Map< String, String >	headers,
		final String	licenseKey,
		final List< LicenseHeartbeatArguments >	heartbeatArguments )

Make request to heartbeat metered use of license(s) with a license key.

HTTP POST request path: /licensing/actions/heartbeat-metered-use/{licenseKey}.

Parameters

headers	Request headers to send, must include the Authorization header.
licenseKey	License key used to authorize license consumption.
heartbeatArguments	List of heartbeat arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

release() [1/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.release	(	final Map< String, String >	headers,
		final List< LicenseReleaseArguments >	releaseArguments )

Make a request to release license checkout(s).

HTTP POST request path: "/licensing/actions/release"

Parameters

headers	Headers to set for the request-
releaseArguments	Release arguments that define the checkouts to release.

Returns

An HTTP call that returns an array of LicenseReleaseResult objects.

release() [2/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.release	(	final Map< String, String >	headers,
		final String	licenseKey,
		final List< LicenseReleaseArguments >	releaseArguments )

Make a request to release license checkout(s).

HTTP POST request path: "/licensing/actions/release/{licenseKey}"

Parameters

headers	Headers to set for the request.
licenseKey	The license key that was originally used to make the checkout.
releaseArguments	Release arguments that define the checkouts to release.

Returns

An HTTP call that returns an array of LicenseReleaseResult objects.

startMeteredUse() [1/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.startMeteredUse	(	final Map< String, String >	headers,
		final List< LicenseCheckoutArguments >	consumptionArguments )

Make request to start metered use of license(s).

HTTP POST request path: /licensing/actions/start-metered-use.

Parameters

headers	Request headers to send, must include the Authorization header.
consumptionArguments	List of consumption arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

startMeteredUse() [2/2]

Call tenduke.scale.client.LicenseCheckoutApiCallFactory.startMeteredUse	(	final Map< String, String >	headers,
		final String	licenseKey,
		final List< LicenseCheckoutArguments >	consumptionArguments )

Make request to start metered use of license(s) with a license key.

HTTP POST request path: /licensing/actions/start-metered-use/{licenseKey}.

Parameters

headers	Request headers to send, must include the Authorization header.
licenseKey	License key used to authorize license consumption.
consumptionArguments	List of consumption arguments that form the request body.

Returns

An array of license tokens (JWTs in a JSON array).

---

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

• license-checkout-api-cli/src/main/java/tenduke/scale/client/LicenseCheckoutApiCallFactory.java