com.licensespring.model.order

Class OrderLicense

java.lang.Object

com.licensespring.model.order.OrderLicense

public final class OrderLicense
extends Object

License to be ordered. Both license key and user types are supported, however unlike other APIs the field user or key must be used exclusively.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrderLicense.OrderLicenseBuilder

Method Summary

Modifier and Type	Method and Description
static OrderLicense.OrderLicenseBuilder	builder()
boolean	equals(Object o)
String	getConsumptionPeriod() Period after which the consumptions are reset to 0.
Integer	getFloatingUsers() How many floating users can use this.
String	getKey() License key, use the generateLicenseKeys method on LicenseSpringManager to generate unique keys.
LicenseType	getLicenseType() Type of license - value can be either trial, perpetual, consumption or time-limited
String	getMaintenanceDuration() duration of license maintenance period - value examples: 1y (one year) or 2m (2 months) or 3d (3 days).
Integer	getMaxActivations() Maximum times the license can be activated on different devices (default is 1)
Integer	getMaxConsumptions() Maximum consumptions of the license for CONSUMPTION type of licenses.
Integer	getMaxOverages() Maximum amount of overages over the max consumption limit.
List<Feature>	getProductFeatures() List of available features assigned to this license.
List<UserBasedLicense>	getUsers() User fields for which the license is being generated.
String	getValidDuration() Duration is used for time-limited licenses.
ZonedDateTime	getValidityPeriod() Final end date and time license is valid.
int	hashCode()
boolean	isAllowOverages() Allows for overages for CONSUMPTION type of license, allowing more consumptions than maxConsumptions.
boolean	isEnableMaintenancePeriod() Whether license should consider maintenance duration, used in pair with maintenance_duration
boolean	isFloating() Whether or not this license is of floating type.
boolean	isFloatingCloud() Whether or not this license is of floating type.
boolean	isPreventVm() Prevent license activation on VM environments for the license.
boolean	isResetConsumption() Consumptions can be auto-reset on a period by setting this field with the consumptionPeriod defined.
boolean	isTrial() Trial licenses are temporary licenses which have validity duration defined on the global level (product) or on the validityPeriod field.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static OrderLicense.OrderLicenseBuilder builder()

getUsers

public List<UserBasedLicense> getUsers()

User fields for which the license is being generated. Use this property when building on user-based products. Products can only use one type of initialization.

getKey

public String getKey()

License key, use the generateLicenseKeys method on LicenseSpringManager to generate unique keys.

getMaxActivations

public Integer getMaxActivations()

Maximum times the license can be activated on different devices (default is 1)

getValidDuration

public String getValidDuration()

Duration is used for time-limited licenses. For Trial licenses this field is used, unless specified on a global product level. Other License types are not affected by this Valid entries: 15d, 1m, 1y,

isEnableMaintenancePeriod

public boolean isEnableMaintenancePeriod()

Whether license should consider maintenance duration, used in pair with maintenance_duration

getMaintenanceDuration

public String getMaintenanceDuration()

duration of license maintenance period - value examples: 1y (one year) or 2m (2 months) or 3d (3 days).

getLicenseType

public LicenseType getLicenseType()

Type of license - value can be either trial, perpetual, consumption or time-limited

getValidityPeriod

public ZonedDateTime getValidityPeriod()

Final end date and time license is valid.

getProductFeatures

public List<Feature> getProductFeatures()

List of available features assigned to this license. Must be already created on the product level.

isTrial

public boolean isTrial()

Trial licenses are temporary licenses which have validity duration defined on the global level (product) or on the validityPeriod field.

getMaxConsumptions

public Integer getMaxConsumptions()

Maximum consumptions of the license for CONSUMPTION type of licenses.

isAllowOverages

public boolean isAllowOverages()

Allows for overages for CONSUMPTION type of license, allowing more consumptions than maxConsumptions.

getMaxOverages

public Integer getMaxOverages()

Maximum amount of overages over the max consumption limit.

isResetConsumption

public boolean isResetConsumption()

Consumptions can be auto-reset on a period by setting this field with the consumptionPeriod defined.

getConsumptionPeriod

public String getConsumptionPeriod()

Period after which the consumptions are reset to 0. 1y (one year) or 2m (2 months) or 3d (3 days)

isPreventVm

public boolean isPreventVm()

Prevent license activation on VM environments for the license.

isFloating

public boolean isFloating()

Whether or not this license is of floating type. Note that floating type means on-premises/offline floating with a proxy server. isFloatingCloud has to be false if this field is set.

isFloatingCloud

public boolean isFloatingCloud()

Whether or not this license is of floating type. Note that floating type means on-premises/offline floating with a proxy server. isFloating has to be false if this field is set.

getFloatingUsers

public Integer getFloatingUsers()

How many floating users can use this.

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