License (Licensespring License Client 2.4.10 API)

java.lang.Object
- com.licensespring.License

```
public class License
extends Object
```
SDK's abstraction of the License. It contains direct server response, wrapped in the @data field. Contains utility methods to check validation and other various features. To check the license on the remote servers use the LicenseManager class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class License.LicenseBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`License.LicenseBuilder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static License.LicenseBuilder`	`builder()`
`protected boolean`	`canEqual(Object other)`
`static License`	`createFromCheck(License license, com.licensespring.dto.CheckResponse checkResponse)`
`long`	`daysPassedSinceLastCheck()`
`long`	`daysRemaining()`
`boolean`	`equals(Object o)`
`Boolean`	`getActive()`
`com.licensespring.LicenseData`	`getData()` Server license data - both online and offline activation data is stored in this field
`Boolean`	`getEnabled()`
`String`	`getHardwareId()` hardware id for which this license data has been activated for
`com.licensespring.model.LicenseIdentity`	`getIdentity()` The license identity - licenseKey or username is kept in this field
`com.licensespring.model.InstallationFile`	`getInstallationFile()` Information on the location of potential installation files.
`ZonedDateTime`	`getLastCheck()` Last time the check was performed on this
`ZonedDateTime`	`getLastUsage()` Gets updated each time the application runs
`int`	`getLocalConsumptions()` Consumptions which are tracked locally.
`Map<String,Integer>`	`getLocalFeatureConsumptions()` Map which used to increase local feature consumptions.
`int`	`getMaxActivations()`
`int`	`getMaxConsumptions()`
`com.licensespring.model.Product`	`getProduct()`
`Boolean`	`getRemoteExpired()`
`com.licensespring.internal.services.LicenseRepository`	`getRepository()`
`com.licensespring.internal.services.LicenseService`	`getService()`
`int`	`getTimesActivated()`
`int`	`getTotalConsumptions()`
`int`	`hashCode()`
`void`	`increaseConsumption()` Increases local consumptions by 1.
`void`	`increaseConsumption(int increment)` Increases local consumptions by the parameter provided.
`void`	`increaseFeatureConsumption(String feature)` Increases by 1 the consumptions of a feature provided.
`void`	`increaseFeatureConsumption(String featureCode, int increment)` Increases by increment the consumptions of a feature provided.
`boolean`	`isExpired()` Checks if license has expired locally
`void`	`localCheck()` performs a local check of the license.
`void`	`setActive(Boolean active)`
`void`	`setData(com.licensespring.LicenseData data)` Server license data - both online and offline activation data is stored in this field
`void`	`setEnabled(Boolean enabled)`
`void`	`setLastCheck(ZonedDateTime lastCheck)` Last time the check was performed on this
`void`	`setLastUsage(ZonedDateTime lastUsage)` Gets updated each time the application runs
`void`	`setLocalConsumptions(int localConsumptions)` Consumptions which are tracked locally.
`void`	`setLocalFeatureConsumptions(Map<String,Integer> localFeatureConsumptions)` Map which used to increase local feature consumptions.
`void`	`setRemoteExpired(Boolean remoteExpired)`
`void`	`setRepository(com.licensespring.internal.services.LicenseRepository repository)`
`void`	`setService(com.licensespring.internal.services.LicenseService service)`
`void`	`syncConsumptions()` The method syncs local with remote consumptions.
`String`	`toString()`

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

- Method Detail
  - createFromCheck
```
public static License createFromCheck(License license,
                                      com.licensespring.dto.CheckResponse checkResponse)
```
  - getMaxActivations
```
public int getMaxActivations()
```
  - getMaxConsumptions
```
public int getMaxConsumptions()
```
  - getTotalConsumptions
```
public int getTotalConsumptions()
```
  - getTimesActivated
```
public int getTimesActivated()
```
  - increaseConsumption
```
public void increaseConsumption()
```
    Increases local consumptions by 1. Must invoke sync method to synchronize with server.
  - increaseConsumption
```
public void increaseConsumption(int increment)
```
    Increases local consumptions by the parameter provided. Must invoke sync method to synchronize with server.
    
    Parameters:
    
    increment -
  - increaseFeatureConsumption
```
public void increaseFeatureConsumption(String feature)
```
    Increases by 1 the consumptions of a feature provided. Locally stored. Must invoke sync method to synchronize with server.
    
    Parameters:
    
    feature - feature which was consumed
  - syncConsumptions
```
public void syncConsumptions()
```
    The method syncs local with remote consumptions. Method is called with every checkLicense call. Optionally method is called periodically if setup via configuration. Method is synchronized with increaseConsumption and increaseFeatureConsumption methods.
  - increaseFeatureConsumption
```
public void increaseFeatureConsumption(String featureCode,
                                       int increment)
```
    Increases by increment the consumptions of a feature provided.
    
    Parameters:
    
    featureCode -
    
    increment -
  - isExpired
```
public boolean isExpired()
```
    Checks if license has expired locally
    
    Returns:
  - daysRemaining
```
public long daysRemaining()
```
    Returns:
    
    the number of remaining days when the license is valid. PERPETUAL and CONSUMPTION LicenseTypes return the Integer.MAX value.
  - daysPassedSinceLastCheck
```
public long daysPassedSinceLastCheck()
```
    Returns:
    
    number of days since last check was performed.
  - localCheck
```
public void localCheck()
```
    performs a local check of the license. Throws a LicenseExpiredException if the license is expired.
  - getProduct
```
public com.licensespring.model.Product getProduct()
```
  - builder
```
public static License.LicenseBuilder builder()
```
  - getData
```
public com.licensespring.LicenseData getData()
```
    Server license data - both online and offline activation data is stored in this field
  - getIdentity
```
public com.licensespring.model.LicenseIdentity getIdentity()
```
    The license identity - licenseKey or username is kept in this field
  - getInstallationFile
```
public com.licensespring.model.InstallationFile getInstallationFile()
```
    Information on the location of potential installation files. See Licensespring documentation for more information.
  - getLastCheck
```
public ZonedDateTime getLastCheck()
```
    Last time the check was performed on this
  - getLastUsage
```
public ZonedDateTime getLastUsage()
```
    Gets updated each time the application runs
  - getHardwareId
```
public String getHardwareId()
```
    hardware id for which this license data has been activated for
  - getLocalConsumptions
```
public int getLocalConsumptions()
```
    Consumptions which are tracked locally. Must be synced with server state periodically
  - getLocalFeatureConsumptions
```
public Map<String,Integer> getLocalFeatureConsumptions()
```
    Map which used to increase local feature consumptions. Must be synced with server state periodically
  - getRepository
```
public com.licensespring.internal.services.LicenseRepository getRepository()
```
  - getService
```
public com.licensespring.internal.services.LicenseService getService()
```
  - getRemoteExpired
```
public Boolean getRemoteExpired()
```
  - getActive
```
public Boolean getActive()
```
  - getEnabled
```
public Boolean getEnabled()
```
  - setData
```
public void setData(com.licensespring.LicenseData data)
```
    Server license data - both online and offline activation data is stored in this field
  - setLastCheck
```
public void setLastCheck(ZonedDateTime lastCheck)
```
    Last time the check was performed on this
  - setLastUsage
```
public void setLastUsage(ZonedDateTime lastUsage)
```
    Gets updated each time the application runs
  - setLocalConsumptions
```
public void setLocalConsumptions(int localConsumptions)
```
    Consumptions which are tracked locally. Must be synced with server state periodically
  - setLocalFeatureConsumptions
```
public void setLocalFeatureConsumptions(Map<String,Integer> localFeatureConsumptions)
```
    Map which used to increase local feature consumptions. Must be synced with server state periodically
  - setRepository
```
public void setRepository(com.licensespring.internal.services.LicenseRepository repository)
```
  - setService
```
public void setService(com.licensespring.internal.services.LicenseService service)
```
  - setRemoteExpired
```
public void setRemoteExpired(Boolean remoteExpired)
```
  - setActive
```
public void setActive(Boolean active)
```
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class License

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createFromCheck

getMaxActivations

getMaxConsumptions

getTotalConsumptions

getTimesActivated

increaseConsumption

increaseConsumption

increaseFeatureConsumption

syncConsumptions

increaseFeatureConsumption

isExpired

daysRemaining

daysPassedSinceLastCheck

localCheck

getProduct

builder

getData

getIdentity

getInstallationFile

getLastCheck

getLastUsage

getHardwareId

getLocalConsumptions

getLocalFeatureConsumptions

getRepository

getService

getRemoteExpired

getActive

getEnabled

setData

setLastCheck

setLastUsage

setLocalConsumptions

setLocalFeatureConsumptions

setRepository

setService

setRemoteExpired

setActive

setEnabled

equals

canEqual

hashCode

toString