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(String name, String code, String featureType, int maxConsumption, int totalConsumptions, ZonedDateTime expiryDate, boolean allowOverages, int maxOverages)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCode() Unique code of the feature use for reference purposes.
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.
int	getMaxConsumption() Number of max consumptions.
int	getMaxOverages() Maximal overages of this feature (uses after consumptions have been used up).
String	getName() Name of the feature use for reference purposes.
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(String name,
                      String code,
                      String featureType,
                      int maxConsumption,
                      int totalConsumptions,
                      ZonedDateTime expiryDate,
                      boolean allowOverages,
                      int maxOverages)

Method Detail

getName

public String getName()

Name of the feature use for reference purposes.

Returns:

Feature name

getCode

public String getCode()

Unique code of the feature use for reference purposes.

Returns:

Feature code

getFeatureType

public String getFeatureType()

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

Returns:

Feature type

getMaxConsumption

public int getMaxConsumption()

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

Returns:

Number of max consumptions

getTotalConsumptions

public int getTotalConsumptions()

Number of consumptions currently being used.

Returns:

Number of consumptions

getExpiryDate

public ZonedDateTime getExpiryDate()

The expiration date of the feature (can be null)

Returns:

Feature expiration date

isAllowOverages

public boolean isAllowOverages()

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

Returns:

True or false

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

Returns:

Maximal consumptions defined on the license feature model

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