com.licensespring.model

Class LicenseFeature

java.lang.Object

com.licensespring.model.LicenseFeature

public final class LicenseFeature
extends Object

To use a feature, each license must have it's own list of features included. Since a license belongs to a particular product, the product must have the feature created, in order for the feature to be included within the license. There are two types of License features: "activation" or "consumption".

ACTIVATION licenses are simple: they are a signal for end-user application to know whether or not a user with this license can access those features.

CONSUMPTION licenses can define a maximum amount of consumnptions with which the user can access a feature. After the limit has been reached, any check to feature consumption will throw a validation exception. Unlike the License Consumption, the reset and overage features are not currently implemented.

Constructor Summary

Constructors

Constructor and Description
LicenseFeature(Long id, String code, String name, String featureType, ZonedDateTime expiryDate, Object metadata, Boolean isFloating, Boolean isFloatingCloud, Long floatingTimeout, Long floatingUsers, int maxConsumption, Boolean allowUnlimitedConsumptions, int totalConsumptions, boolean allowOverages, int maxOverages, Boolean resetConsumption, ConsumptionPeriod consumptionPeriod)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getAllowUnlimitedConsumptions() Boolean indicating whether to allow unlimited activations.
String	getCode() Unique code of the feature use for reference purposes.
ConsumptionPeriod	getConsumptionPeriod() ConsumptionPeriod for LicenseType.CONSUMPTION feature type
ZonedDateTime	getExpiryDate() The expiration date of the feature (can be null)
String	getFeatureType() Type of the feature ("activation" or "consumption"), as explained in the class definition javadoc.
Long	getFloatingTimeout() Floating timeout in minutes.
Long	getFloatingUsers() Used only with floating cloud/on-premises setup.
Long	getId() Unique id of the feature.
Boolean	getIsFloating() Boolean indicating if feature is floating feature.
Boolean	getIsFloatingCloud() Used only with floating cloud setup.
int	getMaxConsumption() Number of max consumptions.
int	getMaxOverages() Maximal overages of this feature (uses after consumptions have been used up).
Object	getMetadata() JSON metadata of the feature.
String	getName() Name of the feature use for reference purposes.
Boolean	getResetConsumption() Settings for features with LicenseType.CONSUMPTION type.
int	getTotalConsumptions() Number of consumptions currently being used.
int	hashCode()
boolean	isAllowOverages() License feature settings if it allows overages (used in licences with type LicenseType.CONSUMPTION)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LicenseFeature

public LicenseFeature(Long id,
                      String code,
                      String name,
                      String featureType,
                      ZonedDateTime expiryDate,
                      Object metadata,
                      Boolean isFloating,
                      Boolean isFloatingCloud,
                      Long floatingTimeout,
                      Long floatingUsers,
                      int maxConsumption,
                      Boolean allowUnlimitedConsumptions,
                      int totalConsumptions,
                      boolean allowOverages,
                      int maxOverages,
                      Boolean resetConsumption,
                      ConsumptionPeriod consumptionPeriod)

Method Detail

getId

public Long getId()

Unique id of the feature.

getCode

public String getCode()

Unique code of the feature use for reference purposes.

getName

public String getName()

Name of the feature use for reference purposes.

getFeatureType

public String getFeatureType()

Type of the feature ("activation" or "consumption"), as explained in the class definition javadoc.

getExpiryDate

public ZonedDateTime getExpiryDate()

The expiration date of the feature (can be null)

getMetadata

public Object getMetadata()

JSON metadata of the feature.

getIsFloating

public Boolean getIsFloating()

Boolean indicating if feature is floating feature.

getIsFloatingCloud

public Boolean getIsFloatingCloud()

Used only with floating cloud setup. Boolean value indicating is feature a floating cloud option.

getFloatingTimeout

public Long getFloatingTimeout()

Floating timeout in minutes. After this period has elapsed, the license will release the device id that has checked it out.

getFloatingUsers

public Long getFloatingUsers()

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

getMaxConsumption

public int getMaxConsumption()

Number of max consumptions. only applies to "consumption" type

getAllowUnlimitedConsumptions

public Boolean getAllowUnlimitedConsumptions()

Boolean indicating whether to allow unlimited activations.

getTotalConsumptions

public int getTotalConsumptions()

Number of consumptions currently being used.

isAllowOverages

public boolean isAllowOverages()

License feature settings if it allows overages (used in licences with type LicenseType.CONSUMPTION)

getMaxOverages

public int getMaxOverages()

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

getResetConsumption

public Boolean getResetConsumption()

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

getConsumptionPeriod

public ConsumptionPeriod getConsumptionPeriod()

ConsumptionPeriod for LicenseType.CONSUMPTION feature type

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