com.licensespring.management.model

Class BackOfficeLicense

java.lang.Object

com.licensespring.management.model.BackOfficeLicense

public final class BackOfficeLicense
extends Object

Model for server license data.

Constructor Summary

Constructors

Constructor and Description

BackOfficeLicense(Long id, String status, Integer floatingInUseDevices, BackOfficeCustomer customer, List<BackOfficeLicenseFeature> productFeatures, LicenseUser[] licenseUsers, LicenseUser licenseUser, String orderStoreId, int activeUpToDateDevices, int totalActiveDevices, BackOfficeLicenseProduct product, ZonedDateTime createdAt, ZonedDateTime updatedAt, String licenseKey, Boolean active, Boolean enabled, ZonedDateTime timeActivated, ZonedDateTime timeDisabled, Integer maxActivations, Integer timesActivated, String validDuration, String validityPeriod, com.licensespring.model.LicenseType licenseType, Boolean enableMaintenancePeriod, String maintenanceDuration, String maintenancePeriod, Boolean isTrial, Integer maxConsumptions, Integer totalConsumptions, String subscriptionId, ZonedDateTime lastCheck, Boolean preventVm, Boolean allowOverages, Integer maxOverages, Boolean resetConsumption, String consumptionPeriod, Integer trialDays, Boolean isFloating, Boolean isFloatingCloud, Integer floatingUsers, String note, Integer maxLicenseUsers, Long order, Long orderItem, Integer disabledUser)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getActive() Whether or not the license is actively being used.
int	getActiveUpToDateDevices() Total number of devices that are currently using this license.
Boolean	getAllowOverages() Should the SDKs and server allow consumption over max consumption parameter.
String	getConsumptionPeriod() The resetConsumption parameter must be set Example values: week, month or year The field is only relevant for the LicenseType.CONSUMPTION
ZonedDateTime	getCreatedAt() When the license was created.
BackOfficeCustomer	getCustomer() Customer model whom ordered the license.
Integer	getDisabledUser() Id of the user that disabled the license.
Boolean	getEnabled() If the license is enabled.
Boolean	getEnableMaintenancePeriod() Whether the maintenance period is set.
Integer	getFloatingInUseDevices() Number of devices that are currently active, if license is floating.
Integer	getFloatingUsers() How many floating users can use this.
Long	getId() 16 digit license id, isn't manually generated.
Boolean	getIsFloating() Whether or not this license is of floating type.
Boolean	getIsFloatingCloud() Whether or not this license is of floating type.
Boolean	getIsTrial() Whether or not this is a trial license
ZonedDateTime	getLastCheck() Last time a device checked this license on the servers
String	getLicenseKey() LicenseKey is not null if the license is key-based.
com.licensespring.model.LicenseType	getLicenseType() Which type of license was set
LicenseUser	getLicenseUser() Legacy field.
LicenseUser[]	getLicenseUsers() List of LicenseUser models whom uses the license.
String	getMaintenanceDuration() The duration of the maintenance window (support).
String	getMaintenancePeriod() Legacy / Undocumented
Integer	getMaxActivations() Number of times this license can be activated on different devices.
Integer	getMaxConsumptions() Maximum consumptions that can be made.
Integer	getMaxLicenseUsers() Maximum number of users that can use this license.
Integer	getMaxOverages() How many additional consumptions can be made over the max consumptions.
String	getNote() Note that can be added in the LicenseSpring platform.
Long	getOrder() 16 digit id of the order, can't be manually changed.
Long	getOrderItem() 16 digit id of the order item this license belongs to.
String	getOrderStoreId() Store id of the order that can be manually generated.
Boolean	getPreventVm() Should activation of this license be prevented within VM environments.
BackOfficeLicenseProduct	getProduct() Product object that contains the name and the id of the product.
List<BackOfficeLicenseFeature>	getProductFeatures() List of features that are available for usage on this license.
Boolean	getResetConsumption() Should the consumptions be reset after a period.
String	getStatus() Status of the license.
String	getSubscriptionId() Id of the subscription model.
ZonedDateTime	getTimeActivated() Time when the license was activated.
ZonedDateTime	getTimeDisabled() Time when the license was disabled.
Integer	getTimesActivated() Number of times this license was activated.
int	getTotalActiveDevices() Total number of devices that have status "active".
Integer	getTotalConsumptions() Total consumptions that were made so far.
Integer	getTrialDays() Number of days when the trial expires - after activation
ZonedDateTime	getUpdatedAt() When the license was updated.
String	getValidDuration() Only LicenseType.TIME_LIMITED or any Trial type take this field into consideration.
String	getValidityPeriod() Final end date and time license is valid.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BackOfficeLicense

public BackOfficeLicense(Long id,
                         String status,
                         Integer floatingInUseDevices,
                         BackOfficeCustomer customer,
                         List<BackOfficeLicenseFeature> productFeatures,
                         LicenseUser[] licenseUsers,
                         LicenseUser licenseUser,
                         String orderStoreId,
                         int activeUpToDateDevices,
                         int totalActiveDevices,
                         BackOfficeLicenseProduct product,
                         ZonedDateTime createdAt,
                         ZonedDateTime updatedAt,
                         String licenseKey,
                         Boolean active,
                         Boolean enabled,
                         ZonedDateTime timeActivated,
                         ZonedDateTime timeDisabled,
                         Integer maxActivations,
                         Integer timesActivated,
                         String validDuration,
                         String validityPeriod,
                         com.licensespring.model.LicenseType licenseType,
                         Boolean enableMaintenancePeriod,
                         String maintenanceDuration,
                         String maintenancePeriod,
                         Boolean isTrial,
                         Integer maxConsumptions,
                         Integer totalConsumptions,
                         String subscriptionId,
                         ZonedDateTime lastCheck,
                         Boolean preventVm,
                         Boolean allowOverages,
                         Integer maxOverages,
                         Boolean resetConsumption,
                         String consumptionPeriod,
                         Integer trialDays,
                         Boolean isFloating,
                         Boolean isFloatingCloud,
                         Integer floatingUsers,
                         String note,
                         Integer maxLicenseUsers,
                         Long order,
                         Long orderItem,
                         Integer disabledUser)

Method Detail

getId

public Long getId()

16 digit license id, isn't manually generated.

getStatus

public String getStatus()

Status of the license. Possible values are: "active", "inactive", "disabled".

getFloatingInUseDevices

public Integer getFloatingInUseDevices()

Number of devices that are currently active, if license is floating.

getCustomer

public BackOfficeCustomer getCustomer()

Customer model whom ordered the license.

getProductFeatures

public List<BackOfficeLicenseFeature> getProductFeatures()

List of features that are available for usage on this license.

getLicenseUsers

public LicenseUser[] getLicenseUsers()

List of LicenseUser models whom uses the license.

getLicenseUser

public LicenseUser getLicenseUser()

Legacy field. License user, License can now have multiple users, so this field will be removed in the future. Might be null, if that is the case, use the list of users.

getOrderStoreId

public String getOrderStoreId()

Store id of the order that can be manually generated.

getActiveUpToDateDevices

public int getActiveUpToDateDevices()

Total number of devices that are currently using this license.

getTotalActiveDevices

public int getTotalActiveDevices()

Total number of devices that have status "active".

getProduct

public BackOfficeLicenseProduct getProduct()

Product object that contains the name and the id of the product.

getCreatedAt

public ZonedDateTime getCreatedAt()

When the license was created.

getUpdatedAt

public ZonedDateTime getUpdatedAt()

When the license was updated.

getLicenseKey

public String getLicenseKey()

LicenseKey is not null if the license is key-based. For user-based licenses this field will be nul.

getActive

public Boolean getActive()

Whether or not the license is actively being used.

getEnabled

public Boolean getEnabled()

If the license is enabled. Disabling a license will make all clients get rejections on license validation.

getTimeActivated

public ZonedDateTime getTimeActivated()

Time when the license was activated.

getTimeDisabled

public ZonedDateTime getTimeDisabled()

Time when the license was disabled.

getMaxActivations

public Integer getMaxActivations()

Number of times this license can be activated on different devices.

getTimesActivated

public Integer getTimesActivated()

Number of times this license was activated.

getValidDuration

public String getValidDuration()

Only LicenseType.TIME_LIMITED or any Trial type take this field into consideration. This field determines how long the license will be valid after activation. value examples: 1y (one year) or 2m (2 months) or 3d(3 days) or 4h (4 hours) or 5min (5 minutes). The different types of time formats cannot be mixed, so it's a number and a time format

getValidityPeriod

public String getValidityPeriod()

Final end date and time license is valid. Only used with LicenseType.TIME_LIMITED. Should not use the validDuration if this field is used.

getLicenseType

public com.licensespring.model.LicenseType getLicenseType()

Which type of license was set

getEnableMaintenancePeriod

public Boolean getEnableMaintenancePeriod()

Whether the maintenance period is set.

getMaintenanceDuration

public String getMaintenanceDuration()

The duration of the maintenance window (support). Can be accessed from the SDK where checks can be made. value examples: 1y (one year) or 2m (2 months) or 3d (3 days)

getMaintenancePeriod

public String getMaintenancePeriod()

Legacy / Undocumented

getIsTrial

public Boolean getIsTrial()

Whether or not this is a trial license

getMaxConsumptions

public Integer getMaxConsumptions()

Maximum consumptions that can be made. Checks on the license will fail if this number is reached. The number is only relevant for the LicenseType.CONSUMPTION

getTotalConsumptions

public Integer getTotalConsumptions()

Total consumptions that were made so far. This number resets if a resetPeriod is defined. The number is only relevant for the LicenseType.CONSUMPTION

getSubscriptionId

public String getSubscriptionId()

Id of the subscription model. Work in progress.

getLastCheck

public ZonedDateTime getLastCheck()

Last time a device checked this license on the servers

getPreventVm

public Boolean getPreventVm()

Should activation of this license be prevented within VM environments.

getAllowOverages

public Boolean getAllowOverages()

Should the SDKs and server allow consumption over max consumption parameter. The field is only relevant for the LicenseType.CONSUMPTION

getMaxOverages

public Integer getMaxOverages()

How many additional consumptions can be made over the max consumptions. The field is only relevant for the LicenseType.CONSUMPTION

getResetConsumption

public Boolean getResetConsumption()

Should the consumptions be reset after a period. consumptionPeriod has to be set if this feature is enabled. The field is only relevant for the LicenseType.CONSUMPTION

getConsumptionPeriod

public String getConsumptionPeriod()

The resetConsumption parameter must be set Example values: week, month or year The field is only relevant for the LicenseType.CONSUMPTION

getTrialDays

public Integer getTrialDays()

Number of days when the trial expires - after activation

getIsFloating

public Boolean getIsFloating()

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.

getIsFloatingCloud

public Boolean getIsFloatingCloud()

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.

getNote

public String getNote()

Note that can be added in the LicenseSpring platform.

getMaxLicenseUsers

public Integer getMaxLicenseUsers()

Maximum number of users that can use this license.

getOrder

public Long getOrder()

16 digit id of the order, can't be manually changed.

getOrderItem

public Long getOrderItem()

16 digit id of the order item this license belongs to.

getDisabledUser

public Integer getDisabledUser()

Id of the user that disabled the license.

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