BaseLicense (sdn-apidoc 2.0.0 API)

java.lang.Object
- com.h3c.license.BaseLicense

All Implemented Interfaces:: License

public class BaseLicense
extends Object
implements License

Base license data carrier.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseLicense(LicenseType type, boolean base, short prodId, short appVersion, int lockId, short metricId, int metricQty, short sno, short expDays)` Constructor to create a license DTO to hold existing license info.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`activated()` Activation date of this license key as applied during license activation.
`boolean`	`base()` License expansion type, e.g base, incremental
`long`	`created()` Creation date of this license key as created by the licensing portal.
`short`	`daysToExpire()` Number of days until license expiration as measured since license created.
`short`	`deactivationCode()` Deactivation code as issued by the product as a result of key deactivation.
`boolean`	`equals(Object license)`
`protected String`	`formatDate(long dt)` Format the long date value to dd MMM yyyy
`short`	`frameworkVersion()` Version of the licensing framework that generated this license key.
`int`	`hashCode()`
`String`	`key()` Human readable encoded license key issued by the licensing portal.
`int`	`lockId()` Lock Id (or hardware Id) to which this license is locked.
`short`	`metricId()` Identifier of the metric whose value will be used to enforce compliance with this license key.
`int`	`metricQuantity()` Maximum licensed quantity of the particular metric identified by metric id.
`short`	`productId()` Product identifier as registered in the licensing portal.
`short`	`productVersion()` Major version number of the licensed product.
`short`	`serialNumber()` Unique number for a given lock-id.
`LicenseStatus`	`status()` Status of the license key, e.g.
`String`	`toString()`
`LicenseType`	`type()` License type, production, trial, etc.

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

- Constructor Detail
  - BaseLicense
```
protected BaseLicense(LicenseType type,
           boolean base,
           short prodId,
           short appVersion,
           int lockId,
           short metricId,
           int metricQty,
           short sno,
           short expDays)
```
    Constructor to create a license DTO to hold existing license info.
    
    Parameters:
    type - license type e.g. DEMO, PRODUCTION, TEST. TRIAL
    base - license expansion type
    prodId - product licensed for
    appVersion - version of the product licensed for
    lockId - software install id
    metricId - licensed for metric i.e. users, nodes, CPUs
    metricQty - licensed quantity
    sno - license record unique number for that lock id
    expDays - license expires in days since it is created
- Method Detail
  - frameworkVersion
```
public short frameworkVersion()
```
    Description copied from interface: License
    
    Version of the licensing framework that generated this license key.
    
    Specified by:
    
    frameworkVersion in interface License
    
    Returns:
    licensing framework version number
  - type
```
public LicenseType type()
```
    Description copied from interface: License
    
    License type, production, trial, etc.
    
    Specified by:
    
    type in interface License
    
    Returns:
    license type
  - status
```
public LicenseStatus status()
```
    Description copied from interface: License
    
    Status of the license key, e.g. new, active, expired, etc.
    
    Specified by:
    
    status in interface License
    
    Returns:
    license status
  - productId
```
public short productId()
```
    Description copied from interface: License
    
    Product identifier as registered in the licensing portal.
    
    Specified by:
    
    productId in interface License
    
    Returns:
    product identifier
  - productVersion
```
public short productVersion()
```
    Description copied from interface: License
    
    Major version number of the licensed product.
    
    Specified by:
    
    productVersion in interface License
    
    Returns:
    product major version number
  - lockId
```
public int lockId()
```
    Description copied from interface: License
    
    Lock Id (or hardware Id) to which this license is locked.
    
    Specified by:
    
    lockId in interface License
    
    Returns:
    3-byte value of the lock-id
  - created
```
public long created()
```
    Description copied from interface: License
    
    Creation date of this license key as created by the licensing portal.
    
    Specified by:
    
    created in interface License
    
    Returns:
    creation date in millis since epoch
  - activated
```
public long activated()
```
    Description copied from interface: License
    
    Activation date of this license key as applied during license activation.
    
    Specified by:
    
    activated in interface License
    
    Returns:
    activation date in millis since epoch
  - metricId
```
public short metricId()
```
    Description copied from interface: License
    
    Identifier of the metric whose value will be used to enforce compliance with this license key. This must correspond to a well-know value.
    
    Specified by:
    
    metricId in interface License
    
    Returns:
    metric identifier
  - metricQuantity
```
public int metricQuantity()
```
    Description copied from interface: License
    
    Maximum licensed quantity of the particular metric identified by metric id.
    
    Specified by:
    
    metricQuantity in interface License
    
    Returns:
    licensed quantity
  - deactivationCode
```
public short deactivationCode()
```
    Description copied from interface: License
    
    Deactivation code as issued by the product as a result of key deactivation.
    
    Specified by:
    
    deactivationCode in interface License
    
    Returns:
    deactivation code
  - serialNumber
```
public short serialNumber()
```
    Description copied from interface: License
    
    Unique number for a given lock-id. It is used to differentiate licensed issued to the same lock id; issued by the portal.
    
    Specified by:
    
    serialNumber in interface License
    
    Returns:
    serial number
  - daysToExpire
```
public short daysToExpire()
```
    Description copied from interface: License
    
    Number of days until license expiration as measured since license created.
    
    Specified by:
    
    daysToExpire in interface License
    
    Returns:
    number of days this license key is good for since activation
  - base
```
public boolean base()
```
    Description copied from interface: License
    
    License expansion type, e.g base, incremental
    
    Specified by:
    
    base in interface License
    
    Returns:
    license expansion type
  - key
```
public String key()
```
    Description copied from interface: License
    
    Human readable encoded license key issued by the licensing portal.
    
    Specified by:
    
    key in interface License
    
    Returns:
    encoded license key
  - formatDate
```
protected String formatDate(long dt)
```
    Format the long date value to dd MMM yyyy
    
    Parameters:
    dt - the date needs to be formatted
    
    Returns:
    formatted date string
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object license)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class BaseLicense

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseLicense

Method Detail

frameworkVersion

type

status

productId

productVersion

lockId

created

activated

metricId

metricQuantity

deactivationCode

serialNumber

daysToExpire

base

key

formatDate

toString

equals

hashCode