LicenseData.LicenseDataBuilder (Licensespring Core 2.20.1 API)

java.lang.Object
- com.licensespring.LicenseData.LicenseDataBuilder

Enclosing class:: LicenseData

public static class LicenseData.LicenseDataBuilder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LicenseData.LicenseDataBuilder`	`active(Boolean active)` Is License active.
`LicenseData.LicenseDataBuilder`	`allowGracePeriod(Boolean allowGracePeriod)` Is grace period allowed.
`LicenseData.LicenseDataBuilder`	`allowNegativeConsumptions(Boolean allowNegativeConsumptions)` Are negative consumptions allowed
`LicenseData.LicenseDataBuilder`	`allowOverages(boolean allowOverages)` Are overages allowed.
`LicenseData.LicenseDataBuilder`	`allowUnlimitedActivations(Boolean allowUnlimitedActivations)` Are unlimited activations allowed.
`LicenseData.LicenseDataBuilder`	`allowUnlimitedConsumptions(Boolean allowUnlimitedConsumptions)` Are unlimited consumptions allowed.
`LicenseData.LicenseDataBuilder`	`borrowedUntil(ZonedDateTime borrowedUntil)` Indicates time until license is borrowed.
`LicenseData`	`build()`
`LicenseData.LicenseDataBuilder`	`canBorrow(Boolean canBorrow)` Indicates whether a license can be borrowed.
`LicenseData.LicenseDataBuilder`	`consumptionPeriod(ConsumptionPeriod consumptionPeriod)` Period when the consumption uses (and overages if enabled) are reset `ConsumptionPeriod`
`LicenseData.LicenseDataBuilder`	`customer(Customer customer)` Customer who purchased this particular license
`LicenseData.LicenseDataBuilder`	`customFields(List<CustomField> customFields)` List of custom fields that can be set in LicenseSpring platform.
`LicenseData.LicenseDataBuilder`	`date(String date)` Date
`LicenseData.LicenseDataBuilder`	`deviceId(Long deviceId)` Device ID represents the unique identifier of the device associated with the license.
`LicenseData.LicenseDataBuilder`	`enableMaintenancePeriod(Boolean enableMaintenancePeriod)` Is maintenance period enabled.
`LicenseData.LicenseDataBuilder`	`floatingInUse(Boolean floatingInUse)` Used only with floating cloud/on-premises setup.
`LicenseData.LicenseDataBuilder`	`floatingInUseDevices(Integer floatingInUseDevices)` Used only with floating cloud/on-premises setup.
`LicenseData.LicenseDataBuilder`	`floatingTimeout(int floatingTimeout)` Used only with floating cloud/on-premises setup.
`LicenseData.LicenseDataBuilder`	`floatingUsers(int floatingUsers)` Used only with floating cloud/on-premises setup.
`LicenseData.LicenseDataBuilder`	`gracePeriod(int gracePeriod)` Grace period
`LicenseData.LicenseDataBuilder`	`hardwareId(String hardwareId)` Hardware ID.
`LicenseData.LicenseDataBuilder`	`id(Long id)` License ID represents the unique identifier of the license.
`LicenseData.LicenseDataBuilder`	`isAirGapped(boolean isAirGapped)` Used only with Air Gapped Licensing.
`LicenseData.LicenseDataBuilder`	`isBorrowed(Boolean isBorrowed)` Indicates whether a license is borrowed.
`LicenseData.LicenseDataBuilder`	`isFloating(Boolean isFloating)` Used only with on-premise floating setup (using an on-premise server).
`LicenseData.LicenseDataBuilder`	`isFloatingCloud(boolean isFloatingCloud)` Used only with floating cloud setup.
`LicenseData.LicenseDataBuilder`	`isHardwareKeyAuth(Boolean isHardwareKeyAuth)` Is hardware key auth
`LicenseData.LicenseDataBuilder`	`isTrial(boolean isTrial)` Trial licenses have limitations that can be set.
`LicenseData.LicenseDataBuilder`	`licenseKey(String licenseKey)` License key.
`LicenseData.LicenseDataBuilder`	`licenseSignature(String licenseSignature)` Signature that is used to sign this license by the LS servers.
`LicenseData.LicenseDataBuilder`	`licenseType(LicenseType licenseType)` Possible license types: PERPETUAL, SUBSCRIPTION, TIME-LIMITED, CONSUMPTION, UNKNOWN
`LicenseData.LicenseDataBuilder`	`maintenancePeriod(ZonedDateTime maintenancePeriod)` Maintenance period of license.
`LicenseData.LicenseDataBuilder`	`maxActivations(int maxActivations)` The maximum number of active devices that can share this license.
`LicenseData.LicenseDataBuilder`	`maxBorrowTime(int maxBorrowTime)` Maximum period a license can be borrowed measured in hours.
`LicenseData.LicenseDataBuilder`	`maxConsumptions(Integer maxConsumptions)` Maximal consumptions of this license.
`LicenseData.LicenseDataBuilder`	`maxOverages(int maxOverages)` Maximal overages of this license (uses after consumptions have been used up).
`LicenseData.LicenseDataBuilder`	`maxTransfers(int maxTransfers)` Max transfers.
`LicenseData.LicenseDataBuilder`	`metadata(com.google.gson.JsonElement metadata)` JSON metadata of the license.
`LicenseData.LicenseDataBuilder`	`offlineSignature(String offlineSignature)` Offline signature.
`LicenseData.LicenseDataBuilder`	`preventVm(boolean preventVm)` License settings if the license if permitted to run on VMs
`LicenseData.LicenseDataBuilder`	`productDetails(Product productDetails)` The parent product assigned to this license.
`LicenseData.LicenseDataBuilder`	`productFeatures(List<LicenseFeature> productFeatures)` Each license can have its own list of features included.
`LicenseData.LicenseDataBuilder`	`request(String request)` "activation" or "deactivation"
`LicenseData.LicenseDataBuilder`	`requestId(String requestId)` Request ID
`LicenseData.LicenseDataBuilder`	`resetConsumption(Boolean resetConsumption)` Settings for licences with `LicenseType.CONSUMPTION` type.
`LicenseData.LicenseDataBuilder`	`timesActivated(int timesActivated)` Number of times this license is activated.
`String`	`toString()`
`LicenseData.LicenseDataBuilder`	`totalConsumptions(Integer totalConsumptions)` Total consumptions of this license as seen by the LS servers.
`LicenseData.LicenseDataBuilder`	`transferCount(int transferCount)` Counts the number of license transfers between different devices.
`LicenseData.LicenseDataBuilder`	`user(LicenseUser user)` The `LicenseUser` object present in user based licenses
`LicenseData.LicenseDataBuilder`	`validityPeriod(ZonedDateTime validityPeriod)` After validity period passes license will become invalid.
`LicenseData.LicenseDataBuilder`	`variables(List<DeviceVariable> variables)` Device variables.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - id
```
public LicenseData.LicenseDataBuilder id(Long id)
```
    License ID represents the unique identifier of the license.
    
    Returns:
    
    this.
  - active
```
public LicenseData.LicenseDataBuilder active(Boolean active)
```
    Is License active.
    
    Returns:
    
    this.
  - allowGracePeriod
```
public LicenseData.LicenseDataBuilder allowGracePeriod(Boolean allowGracePeriod)
```
    Is grace period allowed.
    
    Returns:
    
    this.
  - allowOverages
```
public LicenseData.LicenseDataBuilder allowOverages(boolean allowOverages)
```
    Are overages allowed.
    
    Returns:
    
    this.
  - allowUnlimitedActivations
```
public LicenseData.LicenseDataBuilder allowUnlimitedActivations(Boolean allowUnlimitedActivations)
```
    Are unlimited activations allowed.
    
    Returns:
    
    this.
  - canBorrow
```
public LicenseData.LicenseDataBuilder canBorrow(Boolean canBorrow)
```
    Indicates whether a license can be borrowed.
    
    Returns:
    
    this.
  - isBorrowed
```
public LicenseData.LicenseDataBuilder isBorrowed(Boolean isBorrowed)
```
    Indicates whether a license is borrowed.
    
    Returns:
    
    this.
  - borrowedUntil
```
public LicenseData.LicenseDataBuilder borrowedUntil(ZonedDateTime borrowedUntil)
```
    Indicates time until license is borrowed.
    
    Returns:
    
    this.
  - customFields
```
public LicenseData.LicenseDataBuilder customFields(List<CustomField> customFields)
```
    List of custom fields that can be set in LicenseSpring platform. Dynamic parameters can be sent to the client application in this manner.
    
    Returns:
    
    this.
  - customer
```
public LicenseData.LicenseDataBuilder customer(Customer customer)
```
    Customer who purchased this particular license
    
    Returns:
    
    this.
  - deviceId
```
public LicenseData.LicenseDataBuilder deviceId(Long deviceId)
```
    Device ID represents the unique identifier of the device associated with the license.
    
    Returns:
    
    this.
  - enableMaintenancePeriod
```
public LicenseData.LicenseDataBuilder enableMaintenancePeriod(Boolean enableMaintenancePeriod)
```
    Is maintenance period enabled.
    
    Returns:
    
    this.
  - floatingTimeout
```
public LicenseData.LicenseDataBuilder floatingTimeout(int floatingTimeout)
```
    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
    
    Returns:
    
    this.
  - gracePeriod
```
public LicenseData.LicenseDataBuilder gracePeriod(int gracePeriod)
```
    Grace period
    
    Returns:
    
    this.
  - isAirGapped
```
public LicenseData.LicenseDataBuilder isAirGapped(boolean isAirGapped)
```
    Used only with Air Gapped Licensing.
    
    Returns:
    
    this.
  - isFloatingCloud
```
public LicenseData.LicenseDataBuilder isFloatingCloud(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:
    
    this.
  - isFloating
```
public LicenseData.LicenseDataBuilder isFloating(Boolean isFloating)
```
    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:
    
    this.
  - isHardwareKeyAuth
```
public LicenseData.LicenseDataBuilder isHardwareKeyAuth(Boolean isHardwareKeyAuth)
```
    Is hardware key auth
    
    Returns:
    
    this.
  - isTrial
```
public LicenseData.LicenseDataBuilder isTrial(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:
    
    this.
  - licenseKey
```
public LicenseData.LicenseDataBuilder licenseKey(String licenseKey)
```
    License key.
    
    Returns:
    
    this.
  - licenseType
```
public LicenseData.LicenseDataBuilder licenseType(LicenseType licenseType)
```
    Possible license types: PERPETUAL, SUBSCRIPTION, TIME-LIMITED, CONSUMPTION, UNKNOWN
    
    Returns:
    
    this.
  - maintenancePeriod
```
public LicenseData.LicenseDataBuilder maintenancePeriod(ZonedDateTime maintenancePeriod)
```
    Maintenance period of license. Use this property when determining if the user has maintenance support from the client application.
    
    Returns:
    
    this.
  - maxActivations
```
public LicenseData.LicenseDataBuilder maxActivations(int maxActivations)
```
    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:
    
    this.
  - maxBorrowTime
```
public LicenseData.LicenseDataBuilder maxBorrowTime(int maxBorrowTime)
```
    Maximum period a license can be borrowed measured in hours.
    
    Returns:
    
    this.
  - maxOverages
```
public LicenseData.LicenseDataBuilder maxOverages(int maxOverages)
```
    Maximal overages of this license (uses after consumptions have been used up). 0 indicates unlimited overages. Returns null if LicenseData.licenseType is not LicenseType.CONSUMPTION
    
    Returns:
    
    this.
  - maxTransfers
```
public LicenseData.LicenseDataBuilder maxTransfers(int maxTransfers)
```
    Max transfers.
    
    Returns:
    
    this.
  - metadata
```
public LicenseData.LicenseDataBuilder metadata(com.google.gson.JsonElement metadata)
```
    JSON metadata of the license.
    
    Returns:
    
    this.
  - preventVm
```
public LicenseData.LicenseDataBuilder preventVm(boolean preventVm)
```
    License settings if the license if permitted to run on VMs
    
    Returns:
    
    this.
  - productDetails
```
public LicenseData.LicenseDataBuilder productDetails(Product productDetails)
```
    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:
    
    this.
  - productFeatures
```
public LicenseData.LicenseDataBuilder productFeatures(List<LicenseFeature> productFeatures)
```
    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.
    
    Returns:
    
    this.
  - timesActivated
```
public LicenseData.LicenseDataBuilder timesActivated(int timesActivated)
```
    Number of times this license is activated. Activation is the process of assigning a device (hardware-id) to a particular license.
    
    Returns:
    
    this.
  - transferCount
```
public LicenseData.LicenseDataBuilder transferCount(int transferCount)
```
    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:
    
    this.
  - validityPeriod
```
public LicenseData.LicenseDataBuilder validityPeriod(ZonedDateTime validityPeriod)
```
    After validity period passes license will become invalid. This applies only to LicenseType.TIME_LIMITED type of license.
    
    Returns:
    
    this.
  - variables
```
public LicenseData.LicenseDataBuilder variables(List<DeviceVariable> variables)
```
    Device variables.
    
    Returns:
    
    this.
  - maxConsumptions
```
public LicenseData.LicenseDataBuilder maxConsumptions(Integer maxConsumptions)
```
    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 LicenseData.licenseType is not LicenseType.CONSUMPTION
    
    Returns:
    
    this.
  - allowUnlimitedConsumptions
```
public LicenseData.LicenseDataBuilder allowUnlimitedConsumptions(Boolean allowUnlimitedConsumptions)
```
    Are unlimited consumptions allowed.
    
    Returns:
    
    this.
  - totalConsumptions
```
public LicenseData.LicenseDataBuilder totalConsumptions(Integer totalConsumptions)
```
    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 LicenseData.licenseType is not LicenseType.CONSUMPTION
    
    Returns:
    
    this.
  - resetConsumption
```
public LicenseData.LicenseDataBuilder resetConsumption(Boolean resetConsumption)
```
    Settings for licences with LicenseType.CONSUMPTION type. Indicates if consumptions reset after a defined period. if true, will also have the LicenseData.consumptionPeriod field
    
    Returns:
    
    this.
  - consumptionPeriod
```
public LicenseData.LicenseDataBuilder consumptionPeriod(ConsumptionPeriod consumptionPeriod)
```
    Period when the consumption uses (and overages if enabled) are reset ConsumptionPeriod
    
    Returns:
    
    this.
  - allowNegativeConsumptions
```
public LicenseData.LicenseDataBuilder allowNegativeConsumptions(Boolean allowNegativeConsumptions)
```
    Are negative consumptions allowed
    
    Returns:
    
    this.
  - licenseSignature
```
public LicenseData.LicenseDataBuilder licenseSignature(String licenseSignature)
```
    Signature that is used to sign this license by the LS servers.
    
    Returns:
    
    this.
  - requestId
```
public LicenseData.LicenseDataBuilder requestId(String requestId)
```
    Request ID
    
    Returns:
    
    this.
  - request
```
public LicenseData.LicenseDataBuilder request(String request)
```
    "activation" or "deactivation"
    
    Returns:
    
    this.
  - hardwareId
```
public LicenseData.LicenseDataBuilder hardwareId(String hardwareId)
```
    Hardware ID.
    
    Returns:
    
    this.
  - date
```
public LicenseData.LicenseDataBuilder date(String date)
```
    Date
    
    Returns:
    
    this.
  - offlineSignature
```
public LicenseData.LicenseDataBuilder offlineSignature(String offlineSignature)
```
    Offline signature.
    
    Returns:
    
    this.
  - floatingUsers
```
public LicenseData.LicenseDataBuilder floatingUsers(int floatingUsers)
```
    Used only with floating cloud/on-premises setup. The maximum amount of floating users that can use the license at the same time.
    
    Returns:
    
    this.
  - floatingInUseDevices
```
public LicenseData.LicenseDataBuilder floatingInUseDevices(Integer floatingInUseDevices)
```
    Used only with floating cloud/on-premises setup. The number of devices currently using the license.
    
    Returns:
    
    this.
  - floatingInUse
```
public LicenseData.LicenseDataBuilder floatingInUse(Boolean floatingInUse)
```
    Used only with floating cloud/on-premises setup. Indicates if the floating license is in use. True after activating a floating license.
    
    Returns:
    
    this.
  - user
```
public LicenseData.LicenseDataBuilder user(LicenseUser user)
```
    The LicenseUser object present in user based licenses
    
    Returns:
    
    this.
  - build
```
public LicenseData build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class LicenseData.LicenseDataBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

id

active

allowGracePeriod

allowOverages

allowUnlimitedActivations

canBorrow

isBorrowed

borrowedUntil

customFields

customer

deviceId

enableMaintenancePeriod

floatingTimeout

gracePeriod

isAirGapped

isFloatingCloud

isFloating

isHardwareKeyAuth

isTrial

licenseKey

licenseType

maintenancePeriod

maxActivations

maxBorrowTime

maxOverages

maxTransfers

metadata

preventVm

productDetails

productFeatures

timesActivated

transferCount

validityPeriod

variables

maxConsumptions

allowUnlimitedConsumptions

totalConsumptions

resetConsumption

consumptionPeriod

allowNegativeConsumptions

licenseSignature

requestId

request

hardwareId

date

offlineSignature

floatingUsers

floatingInUseDevices

floatingInUse

user

build

toString