com.licensespring

Class LicenseData

java.lang.Object

com.licensespring.LicenseData

public final class LicenseData
extends Object

License data is the main license model returned by LS servers. A single license can have multiple devices attached to it. This is controlled by the activations parameter, which sets the maximum amount of devices that can be active at any time with a particular license. The class is immutable, once created cannot be modified.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LicenseData.LicenseDataBuilder

Method Summary

Modifier and Type	Method and Description
static LicenseData.LicenseDataBuilder	builder()
long	daysRemaining() Returns number of days before the license expires.
boolean	equals(Object o)
ConsumptionPeriod	getConsumptionPeriod() Period when the consumption uses (and overages if enabled) are reset ConsumptionPeriod
Customer	getCustomer() Customer who purchased this particular license
List<CustomField>	getCustomFields() List of custom fields that can be set in LicenseSpring platform.
Long	getDeviceId() Device ID represents the unique identifier of the device associated with the license.
Boolean	getFloatingInUse() Used only with floating cloud/on-premises setup.
Integer	getFloatingInUseDevices() Used only with floating cloud/on-premises setup.
int	getFloatingTimeout() Used only with floating cloud/on-premises setup.
int	getFloatingUsers() Used only with floating cloud/on-premises setup.
Long	getId() License ID represents the unique identifier of the license.
Boolean	getIsFloating() Used only with on-premise floating setup (using an on-premise server).
String	getLicenseSignature() Signature that is used to sign this license by the LS servers.
LicenseType	getLicenseType() Possible license types: PERPETUAL, SUBSCRIPTION, TIME-LIMITED, CONSUMPTION, UNKNOWN
ZonedDateTime	getMaintenancePeriod() Maintenance period of license.
int	getMaxActivations() The maximum number of active devices that can share this license.
int	getMaxBorrowTime() Maximum period a license can be borrowed measured in hours.
Integer	getMaxConsumptions() Maximal consumptions of this license.
int	getMaxOverages() Maximal overages of this license (uses after consumptions have been used up).
Product	getProductDetails() The parent product assigned to this license.
List<LicenseFeature>	getProductFeatures() Each license can have it's own list of features included.
Boolean	getResetConsumption() Settings for licences with LicenseType.CONSUMPTION type.
int	getTimesActivated() Number of times this license is activated.
Integer	getTotalConsumptions() Total consumptions of this license as seen by the LS servers.
int	getTransferCount() Counts the number of license transfers between different devices.
ZonedDateTime	getValidityPeriod() After validity period passes license will become invalid.
boolean	hasConsumptionFeature(String feature) Checks whether this license contains the passed consumption feature (by feature code and the consumption type)
boolean	hasFeature(String feature) Checks whether this license contains the passed feature (by feature code)
int	hashCode()
boolean	isAirGapped() Used only with Air Gapped Licensing.
boolean	isAllowOverages() License settings if the license allows overages (used in licences with type LicenseType.CONSUMPTION)
boolean	isCanBorrow() Indicates whether a license can be borrowed.
boolean	isExpired() Returns information on license expiration.
boolean	isFloatingCloud() Used only with floating cloud setup.
boolean	isPreventVm() License settings if the license if permitted to run on VMs
boolean	isTrial() Trial licenses have limitations that can be set.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isExpired

public boolean isExpired()

Returns information on license expiration. Only Trial licenses as well as LicenseType.TIME_LIMITED type can expire.

Returns:

whether or no the license has expired

hasFeature

public boolean hasFeature(String feature)

Checks whether this license contains the passed feature (by feature code)

Parameters:

feature - - the code of the feature

Returns:

true if present on the license

hasConsumptionFeature

public boolean hasConsumptionFeature(String feature)

Checks whether this license contains the passed consumption feature (by feature code and the consumption type)

Parameters:

feature - - the code of the feature

Returns:

true if present on the license

daysRemaining

public long daysRemaining()

Returns number of days before the license expires. Only Trial licenses as well as LicenseType.TIME_LIMITED type can expire.

Returns:

Remaining days

builder

public static LicenseData.LicenseDataBuilder builder()

getId

public Long getId()

License ID represents the unique identifier of the license.

Returns:

License ID

getDeviceId

public Long getDeviceId()

Device ID represents the unique identifier of the device associated with the license.

Returns:

Device ID

getLicenseSignature

public String getLicenseSignature()

Signature that is used to sign this license by the LS servers.

Returns:

Signature

getLicenseType

public LicenseType getLicenseType()

Possible license types: PERPETUAL, SUBSCRIPTION, TIME-LIMITED, CONSUMPTION, UNKNOWN

Returns:

License type

isTrial

public boolean isTrial()

Trial licenses have limitations that can be set. End users cannot modify a trial license, but a new license must be issued or alternatively can be modified within LS platform / Management SDK.

Returns:

True or false.

getProductFeatures

public List<LicenseFeature> getProductFeatures()

Each license can have it's own list of features included. Features must be created at the product level, for them to be included within a particular license.

Returns:

Product features

getCustomFields

public List<CustomField> getCustomFields()

List of custom fields that can be set in LicenseSpring platform. Dynamic parameters can be sent to the client application in this manner.

Returns:

Custom fields

getValidityPeriod

public ZonedDateTime getValidityPeriod()

After validity period passes license will become invalid. This applies only to LicenseType.TIME_LIMITED type of license.

Returns:

Validity period

getMaintenancePeriod

public ZonedDateTime getMaintenancePeriod()

Maintenance period of license. Use this property when determening if the user has maintenance support from the client application.

Returns:

Maintenance period

getMaxActivations

public int getMaxActivations()

The maximum number of active devices that can share this license. A device is identified by the unique hardware id or other hardware id strategies. Devices can be deactivated via the SDK, freeing up space for additional devices to be added.

Returns:

maximum activations allowed on the license

getTimesActivated

public int getTimesActivated()

Number of times this license is activated. Activation is the process of assigning a device (hardware-id) to a particular license.

Returns:

Number of times this license is activated.

getTransferCount

public int getTransferCount()

Counts the number of license transfers between different devices. License transfer is defined as activation on a device different from the device it was previously activated on.

Returns:

Number of times this license has been transfered between different devices.

isPreventVm

public boolean isPreventVm()

License settings if the license if permitted to run on VMs

Returns:

True or false

getCustomer

public Customer getCustomer()

Customer who purchased this particular license

Returns:

Customer

getProductDetails

public Product getProductDetails()

The parent product assigned to this license. Note that licenses load properties from products, but the properties can be changed directly on a license level upon creating a license within the LS platform or management APIs.

Returns:

Product

getTotalConsumptions

public Integer getTotalConsumptions()

Total consumptions of this license as seen by the LS servers. Multiple devices (hardware ids) share the same common pool of consumptions. Returns null if licenseType is not LicenseType.CONSUMPTION

Returns:

Total consumptions

getMaxConsumptions

public Integer getMaxConsumptions()

Maximal consumptions of this license. After this limit has been reached, the LS servers will not allow any further devices to be added to this particular license. Returns null if licenseType is not LicenseType.CONSUMPTION

Returns:

Maximal consumptions defined on the license model

isAllowOverages

public boolean isAllowOverages()

License settings if the license allows overages (used in licences with type LicenseType.CONSUMPTION)

Returns:

True or false

getMaxOverages

public int getMaxOverages()

Maximal overages of this license (uses after consumptions have been used up). 0 indicates unlimited overages. Returns null if licenseType is not LicenseType.CONSUMPTION

Returns:

Maximal consumptions defined on the license model

getResetConsumption

public Boolean getResetConsumption()

Settings for licences with LicenseType.CONSUMPTION type. Indicates if consumptions reset after a defined period. if true, will also have the consumptionPeriod field

Returns:

True or false

getConsumptionPeriod

public ConsumptionPeriod getConsumptionPeriod()

Period when the consumption uses (and overages if enabled) are reset ConsumptionPeriod

Returns:

Period of consumption resets

isFloatingCloud

public boolean isFloatingCloud()

Used only with floating cloud setup. Boolean value indicating is license a floating cloud option. In this case FL cloud licenses are used. The license expires after Check or Activate methods must be called in order to ensure that the license is still checked out before the floating period expires.

Returns:

True or false

getIsFloating

public Boolean getIsFloating()

Used only with on-premise floating setup (using an on-premise server). Value is returned on activation. Boolean value indicating is license a floating option.

Returns:

True or false

getFloatingUsers

public int getFloatingUsers()

Used only with floating cloud/on-premises setup. The maximum amount of floating users that can use the license at the same time.

Returns:

Maximum number simultaneous floating users

getFloatingTimeout

public int getFloatingTimeout()

Used only with floating cloud/on-premises setup. Floating timeout in minutes. After this period has elapsed, the license will release the device id that has checked it out. Make sure to call checkLicense() in Floating SDK or enablePeriodicChecks() in the config

getFloatingInUseDevices

public Integer getFloatingInUseDevices()

Used only with floating cloud/on-premises setup. The number of devices currently using the license.

Returns:

number of floating device using the license

getFloatingInUse

public Boolean getFloatingInUse()

Used only with floating cloud/on-premises setup. Indicates if the floating license is in use. True after activating a floating license.

Returns:

True or false

isAirGapped

public boolean isAirGapped()

Used only with Air Gapped Licensing.

Returns:

true for the airGapped license type

isCanBorrow

public boolean isCanBorrow()

Indicates whether a license can be borrowed.

getMaxBorrowTime

public int getMaxBorrowTime()

Maximum period a license can be borrowed measured in hours.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object