License (TrueLicense Core 2.6.5 API)

java.lang.Object
- net.java.truelicense.core.License

Direct Known Subclasses:

LicenseContent
```
@ParametersAreNullableByDefault
 @Nullable
public class License
extends Object
```
A Java Bean which defines and provides the common properties of any license. All properties are set to null by default. However, license validation may fail if some properties are null when creating, installing or verifying license keys.
There are two options for extending a license with custom properties:
- The easiest way is to put the custom properties in a map or another JavaBean and store it in the extra property (composition).
- Another option is to subclass this class and add the custom properties (inheritance). However, you may then need to override equals(Object), too. If you do, you also need to override hashCode() for consistency.
Either way, the custom properties must support the Codec of the respective license key format - see CodecProvider.codec(). This is easiest to achieve if the respective class follows the JavaBean pattern just like this class does.
Note that this class deviates from the JavaBeans specification in that it neither implements Serializable nor Externalizable. This is because object serialization is not required with the used Codecs and creates a major obligation for any subclass.
Author:

Christian Schlichtherle

See Also:

LicenseProvider

Constructor Summary

Constructors
Constructor and Description

License()

Constructors
Constructor and Description
`License()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Returns `true` if and only if `obj` is an instance of the `class` and its properties compare equal to the properties of this license.
`int`	`getConsumerAmount()` Returns the amount of consumers which are allowed to use the licensing subject.
`String`	`getConsumerType()` Returns the description of the type of the entity or object which allocates (consumes) the license for using the licensing subject.
`Object`	`getExtra()` Returns the license extra data.
`X500Principal`	`getHolder()` Returns the distinguished name of the legal entity to which the license is granted by the issuer/vendor, typically the consumer.
`String`	`getInfo()` Returns the license information.
`Date`	`getIssued()` Returns the date/time when the license has been issued.
`X500Principal`	`getIssuer()` Returns the distinguished name of the legal entity which grants the license to the holder/consumer, typically the license vendor.
`Date`	`getNotAfter()` Returns the date/time when the license ends to be valid (expires).
`Date`	`getNotBefore()` Returns the date/time when the license begins to be valid.
`String`	`getSubject()` Returns the description of the product which requires licensing.
`int`	`hashCode()` Returns a hash code which is consistent with `equals(Object)`.
`void`	`setConsumerAmount(int consumerAmount)` Sets the amount of consumers which are allowed to use the licensing subject.
`void`	`setConsumerType(String consumerType)` Sets the description of the type of the entity or object which allocates (consumes) the license for using the licensing subject.
`void`	`setExtra(Object extra)` Sets the license extra data.
`void`	`setHolder(X500Principal holder)` Sets the distinguished name of the legal entity to which the license is granted by the issuer/vendor, typically the consumer.
`void`	`setInfo(String info)` Sets the license information.
`void`	`setIssued(Date issued)` Sets the date/time when the license has been issued.
`void`	`setIssuer(X500Principal issuer)` Sets the distinguished name of the legal entity which grants the license to the holder/consumer, typically the license vendor.
`void`	`setNotAfter(Date notAfter)` Sets the date/time when the license ends to be valid (expires).
`void`	`setNotBefore(Date notBefore)` Sets the date/time when the license begins to be valid.
`void`	`setSubject(String subject)` Sets the description of the product which requires licensing.
`void`	`setTerm(int days)` Conveniently computes the `issued` date/time, `notBefore` date/time and `notAfter` date/time properties from the given number of days.
`String`	`toString()` Returns a string representation of this object for logging and debugging purposes.

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

- Constructor Detail
  - License
```
public License()
```
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Returns true if and only if obj is an instance of the class and its properties compare equal to the properties of this license.
    
    Overrides:
    
    equals in class Object
  - getConsumerAmount
```
public final int getConsumerAmount()
```
    Returns the amount of consumers which are allowed to use the licensing subject. The default value is one in order to retain compatibility with V1 format license keys and to reduce the size of the XML encoded form (default values don't need to get encoded).
  - getConsumerType
```
public final String getConsumerType()
```
    Returns the description of the type of the entity or object which allocates (consumes) the license for using the licensing subject. This could describe a computer or a user or anything else, e.g. "User".
  - getExtra
```
public final Object getExtra()
```
    Returns the license extra data. Unlike the other properties of this class, this property is supposed to hold private information which should never be shared with the customer. It is typically used by applications in order to provide some extra data for custom validation.
  - getHolder
```
public final X500Principal getHolder()
```
    Returns the distinguished name of the legal entity to which the license is granted by the issuer/vendor, typically the consumer. This could describe a person or an organization or be a placeholder for any of these, e.g. new X500Principal("CN=Unknown").
  - getInfo
```
public final String getInfo()
```
    Returns the license information. This could be any text which may be displayed to users for informational purposes.
  - getIssued
```
public final Date getIssued()
```
    Returns the date/time when the license has been issued. Note that a protective copy is made.
  - getIssuer
```
public final X500Principal getIssuer()
```
    Returns the distinguished name of the legal entity which grants the license to the holder/consumer, typically the license vendor. This could describe a person or an organization or be a placeholder for any of these, e.g. new X500Principal("CN=Christian Schlichtherle,O=Schlichtherle IT Services").
  - getNotAfter
```
public final Date getNotAfter()
```
    Returns the date/time when the license ends to be valid (expires). Note that a protective copy is made.
  - getNotBefore
```
public final Date getNotBefore()
```
    Returns the date/time when the license begins to be valid. Note that a protective copy is made.
  - getSubject
```
public final String getSubject()
```
    Returns the description of the product which requires licensing. This could be any string, but is recommended to contain the canonical name of the application and some information for which version number range this license is applicable, e.g. "MyApp 1.X".
  - hashCode
```
public int hashCode()
```
    Returns a hash code which is consistent with equals(Object).
    
    Overrides:
    
    hashCode in class Object
  - setConsumerAmount
```
public final void setConsumerAmount(int consumerAmount)
```
    Sets the amount of consumers which are allowed to use the licensing subject.
  - setConsumerType
```
public final void setConsumerType(String consumerType)
```
    Sets the description of the type of the entity or object which allocates (consumes) the license for using the licensing subject.
  - setExtra
```
public final void setExtra(Object extra)
```
    Sets the license extra data.
    
    Parameters:
    
    extra - the license extra data. This may be any object which is supported by the configured codec.
  - setHolder
```
public final void setHolder(X500Principal holder)
```
    Sets the distinguished name of the legal entity to which the license is granted by the issuer/vendor, typically the consumer.
    
    See Also:
    
    X500PrincipalBuilder
  - setInfo
```
public final void setInfo(String info)
```
    Sets the license information.
  - setIssued
```
public final void setIssued(Date issued)
```
    Sets the date/time when the license has been issued. Note that a protective copy is made.
  - setIssuer
```
public final void setIssuer(X500Principal issuer)
```
    Sets the distinguished name of the legal entity which grants the license to the holder/consumer, typically the license vendor.
    
    See Also:
    
    X500PrincipalBuilder
  - setNotAfter
```
public final void setNotAfter(Date notAfter)
```
    Sets the date/time when the license ends to be valid (expires). Note that a protective copy is made.
  - setNotBefore
```
public final void setNotBefore(Date notBefore)
```
    Sets the date/time when the license begins to be valid. Note that a protective copy is made.
  - setSubject
```
public final void setSubject(String subject)
```
    Sets the description of the product which requires licensing.
  - setTerm
```
public final void setTerm(int days)
```
    Conveniently computes the issued date/time, notBefore date/time and notAfter date/time properties from the given number of days.
    Note that this computation depends on the system clock unless the property issued is set. This is not a security issue because this method is neither used for license initialization nor validation by a license consumer manager.
    
    Parameters:
    
    days - the validity period in (24 hour) days from now.
  - toString
```
public String toString()
```
    Returns a string representation of this object for logging and debugging purposes.
    
    Overrides:
    
    toString in class Object

Class License

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

License

Method Detail

equals

getConsumerAmount

getConsumerType

getExtra

getHolder

getInfo

getIssued

getIssuer

getNotAfter

getNotBefore

getSubject

hashCode

setConsumerAmount

setConsumerType

setExtra

setHolder

setInfo

setIssued

setIssuer

setNotAfter

setNotBefore

setSubject

setTerm

toString