LicenseData (Licensespring Core 2.20.1 API)

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`LicenseData.LicenseDataBuilder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LicenseData.LicenseDataBuilder`	`builder()`
`long`	`daysRemaining()` Returns number of days before the license expires.
`boolean`	`equals(Object o)`
`Boolean`	`getActive()` Is License active.
`Boolean`	`getAllowGracePeriod()` Is grace period allowed.
`Boolean`	`getAllowNegativeConsumptions()` Are negative consumptions allowed
`Boolean`	`getAllowUnlimitedActivations()` Are unlimited activations allowed.
`Boolean`	`getAllowUnlimitedConsumptions()` Are unlimited consumptions allowed.
`ZonedDateTime`	`getBorrowedUntil()` Indicates time until license is borrowed.
`Boolean`	`getCanBorrow()` Indicates whether a license can be borrowed.
`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.
`String`	`getDate()` Date
`Long`	`getDeviceId()` Device ID represents the unique identifier of the device associated with the license.
`Boolean`	`getEnableMaintenancePeriod()` Is maintenance period enabled.
`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.
`int`	`getGracePeriod()` Grace period
`String`	`getHardwareId()` Hardware ID.
`Long`	`getId()` License ID represents the unique identifier of the license.
`Boolean`	`getIsBorrowed()` Indicates whether a license is borrowed.
`Boolean`	`getIsFloating()` Used only with on-premise floating setup (using an on-premise server).
`Boolean`	`getIsHardwareKeyAuth()` Is hardware key auth
`String`	`getLicenseKey()` License key.
`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).
`int`	`getMaxTransfers()` Max transfers.
`com.google.gson.JsonElement`	`getMetadata()` JSON metadata of the license.
`String`	`getOfflineSignature()` Offline signature.
`Product`	`getProductDetails()` The parent product assigned to this license.
`List<LicenseFeature>`	`getProductFeatures()` Each license can have its own list of features included.
`String`	`getRequest()` "activation" or "deactivation"
`String`	`getRequestId()` Request ID
`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.
`LicenseUser`	`getUser()` The `LicenseUser` object present in user based licenses
`ZonedDateTime`	`getValidityPeriod()` After validity period passes license will become invalid.
`List<DeviceVariable>`	`getVariables()` Device variables.
`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()` Are overages allowed.
`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.
  - getActive
```
public Boolean getActive()
```
    Is License active.
  - getAllowGracePeriod
```
public Boolean getAllowGracePeriod()
```
    Is grace period allowed.
  - isAllowOverages
```
public boolean isAllowOverages()
```
    Are overages allowed.
  - getAllowUnlimitedActivations
```
public Boolean getAllowUnlimitedActivations()
```
    Are unlimited activations allowed.
  - getCanBorrow
```
public Boolean getCanBorrow()
```
    Indicates whether a license can be borrowed.
  - getIsBorrowed
```
public Boolean getIsBorrowed()
```
    Indicates whether a license is borrowed.
  - getBorrowedUntil
```
public ZonedDateTime getBorrowedUntil()
```
    Indicates time until license is borrowed.
  - 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.
  - getCustomer
```
public Customer getCustomer()
```
    Customer who purchased this particular license
  - getDeviceId
```
public Long getDeviceId()
```
    Device ID represents the unique identifier of the device associated with the license.
  - getEnableMaintenancePeriod
```
public Boolean getEnableMaintenancePeriod()
```
    Is maintenance period enabled.
  - 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
  - getGracePeriod
```
public int getGracePeriod()
```
    Grace period
  - isAirGapped
```
public boolean isAirGapped()
```
    Used only with Air Gapped Licensing.
  - 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.
  - 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.
  - getIsHardwareKeyAuth
```
public Boolean getIsHardwareKeyAuth()
```
    Is hardware key auth
  - 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.
  - getLicenseKey
```
public String getLicenseKey()
```
    License key.
  - getLicenseType
```
public LicenseType getLicenseType()
```
    Possible license types: PERPETUAL, SUBSCRIPTION, TIME-LIMITED, CONSUMPTION, UNKNOWN
  - getMaintenancePeriod
```
public ZonedDateTime getMaintenancePeriod()
```
    Maintenance period of license. Use this property when determining if the user has maintenance support from the client application.
  - 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.
  - getMaxBorrowTime
```
public int getMaxBorrowTime()
```
    Maximum period a license can be borrowed measured in hours.
  - 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
  - getMaxTransfers
```
public int getMaxTransfers()
```
    Max transfers.
  - getMetadata
```
public com.google.gson.JsonElement getMetadata()
```
    JSON metadata of the license.
  - isPreventVm
```
public boolean isPreventVm()
```
    License settings if the license if permitted to run on VMs
  - 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.
  - getProductFeatures
```
public List<LicenseFeature> getProductFeatures()
```
    Each license can have its own list of features included. Features must be created at the product level, for them to be included within a particular 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.
  - 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.
  - getValidityPeriod
```
public ZonedDateTime getValidityPeriod()
```
    After validity period passes license will become invalid. This applies only to LicenseType.TIME_LIMITED type of license.
  - getVariables
```
public List<DeviceVariable> getVariables()
```
    Device variables.
  - 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
  - getAllowUnlimitedConsumptions
```
public Boolean getAllowUnlimitedConsumptions()
```
    Are unlimited consumptions allowed.
  - 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
  - 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
  - getConsumptionPeriod
```
public ConsumptionPeriod getConsumptionPeriod()
```
    Period when the consumption uses (and overages if enabled) are reset ConsumptionPeriod
  - getAllowNegativeConsumptions
```
public Boolean getAllowNegativeConsumptions()
```
    Are negative consumptions allowed
  - getLicenseSignature
```
public String getLicenseSignature()
```
    Signature that is used to sign this license by the LS servers.
  - getRequestId
```
public String getRequestId()
```
    Request ID
  - getRequest
```
public String getRequest()
```
    "activation" or "deactivation"
  - getHardwareId
```
public String getHardwareId()
```
    Hardware ID.
  - getDate
```
public String getDate()
```
    Date
  - getOfflineSignature
```
public String getOfflineSignature()
```
    Offline signature.
  - 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.
  - getFloatingInUseDevices
```
public Integer getFloatingInUseDevices()
```
    Used only with floating cloud/on-premises setup. The number of devices currently 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.
  - getUser
```
public LicenseUser getUser()
```
    The LicenseUser object present in user based licenses
  - 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

Class LicenseData

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isExpired

hasFeature

hasConsumptionFeature

daysRemaining

builder

getId

getActive

getAllowGracePeriod

isAllowOverages

getAllowUnlimitedActivations

getCanBorrow

getIsBorrowed

getBorrowedUntil

getCustomFields

getCustomer

getDeviceId

getEnableMaintenancePeriod

getFloatingTimeout

getGracePeriod

isAirGapped

isFloatingCloud

getIsFloating

getIsHardwareKeyAuth

isTrial

getLicenseKey

getLicenseType

getMaintenancePeriod

getMaxActivations

getMaxBorrowTime

getMaxOverages

getMaxTransfers

getMetadata

isPreventVm

getProductDetails

getProductFeatures

getTimesActivated

getTransferCount

getValidityPeriod

getVariables

getMaxConsumptions

getAllowUnlimitedConsumptions

getTotalConsumptions

getResetConsumption

getConsumptionPeriod

getAllowNegativeConsumptions

getLicenseSignature

getRequestId

getRequest

getHardwareId

getDate

getOfflineSignature

getFloatingUsers

getFloatingInUseDevices

getFloatingInUse

getUser

equals

hashCode

toString