|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface License
This class extends "basic license" abstraction by providing additional information that describes license state obtained during license check and validation. Such information can be used by application to decide whether particular functionality or even application as whole is allowed to run.
Field Summary | |
---|---|
static int |
CASE_COMMERCIAL_ENABLED
Specifies case of valid commercial license (Professional Edition only) |
static int |
CASE_ENABLED
Specifies case of valid license (Standard Edition only) |
static int |
CASE_EVALUATION_ENABLED
Specifies case of valid evaluation license |
static int |
CASE_EXPIRED_ENABLED
Specifies case of expired commercial license |
static int |
CASE_EXPIRED_EVALUATION_ENABLED
Specifies case of expired evaluation license |
static int |
CASE_INVALID_ENABLED
Specifies case of invalid license |
static int |
KIND_NEW
Defines NEW Kind of a license. |
static int |
KIND_UPGRADE
Defines UPGRADE Kind of a license. |
static int |
NO_LIMIT
|
static int |
NO_USAGE_LIMIT
|
static java.lang.String |
PREFIX
Defines prefix for standard license properties |
static java.lang.String |
PROPERTY_ACTIVATION_GRACE_PERIOD
Defines property name for storing activation grace period |
static java.lang.String |
PROPERTY_ACTIVATION_KEY
Defines property name for storing activation key |
static java.lang.String |
PROPERTY_ADDRESS
|
static java.lang.String |
PROPERTY_CHECKOUT_PERIOD
Defines property name for storing checkout period |
static java.lang.String |
PROPERTY_CITY
|
static java.lang.String |
PROPERTY_COMPANY
|
static java.lang.String |
PROPERTY_COUNTRY
|
static java.lang.String |
PROPERTY_CPU_LIMIT
Defines property name for storing CPU/Core limit |
static java.lang.String |
PROPERTY_EMAIL
|
static java.lang.String |
PROPERTY_FIRST_NAME
|
static java.lang.String |
PROPERTY_LAST_NAME
|
static java.lang.String |
PROPERTY_LICENSE_KIND
Defines property name for storing license kind |
static java.lang.String |
PROPERTY_LICENSING_SERVER_ADDRESS
Defines property name for storing Licensing Server address |
static java.lang.String |
PROPERTY_LOCK_GRACE_PERIOD
Defines property name for storing lock grace period |
static java.lang.String |
PROPERTY_LOCK_PERIOD
Defines property name for storing lock period |
static java.lang.String |
PROPERTY_MAIN_LICENSE
Defines property name for storing a reference to a main license (as a License Number) |
static java.lang.String |
PROPERTY_MEMORY_LIMIT
Defines property name for storing memory limit |
static java.lang.String |
PROPERTY_PHONE
|
static java.lang.String |
PROPERTY_PREV_LICENSE_MAJOR_VERSION
|
static java.lang.String |
PROPERTY_PREV_LICENSE_MINOR_PRODUCT_EDITIONS
|
static java.lang.String |
PROPERTY_PREV_LICENSE_MINOR_VERSION
|
static java.lang.String |
PROPERTY_SERIAL_NUMBER
Defines property name for storing serial number |
static java.lang.String |
PROPERTY_STATE
|
static java.lang.String |
PROPERTY_TITLE
|
static java.lang.String |
PROPERTY_USAGE_GRACE_PERIOD
Defines property name for storing usage grace period |
static java.lang.String |
PROPERTY_USAGE_LIMIT
Defines property name for storing usage count limit |
static java.lang.String |
PROPERTY_ZIP
|
static int |
STATE_EXPIRED
Defines expired state of the license, which means that license is already expired. |
static int |
STATE_INVALID
Defines invalid state of the license. |
static int |
STATE_LOCK_VIOLATED
Defines that license is a valid one but it has been locked to a different computer system. |
static int |
STATE_NOT_ACTIVATED
Defines not activated state of the license, which means that license is either a valid commercial license or a not yet expired evaluation that needs to be activated. |
static int |
STATE_NOT_LOCKED
Defines the not-locked state of the license. |
static int |
STATE_OK
Defines OK state of the license, which means that license is either a valid commercial license or not yet expired evaluation. |
static int |
STATE_UNKNOWN
Defines unknown state of the license, which means that license just been read and is not checked or validated yet. |
Method Summary | |
---|---|
int |
getActivationGracePeriod()
Returns activation grace period (in days) for the license |
java.lang.String |
getActivationKey()
Returns activation key of the license |
int |
getCheckoutPeriod()
Returns period in days the license is allowed to work offline after checkout without need to obtain/renew lock from the Licensing Server (applicable for USER_LICENSING_NAMED_LS model only) |
int |
getCPULimit()
Returns CPU/Cores limit |
int |
getLicenseKind()
Returns kind of a license |
java.lang.String |
getLicenseLocation()
Returns location of the license |
int |
getLicenseState()
Returns the state of the license |
java.lang.String |
getLicenseText()
Returns the license agreement text. |
java.lang.String |
getLicensingServerAddress()
Returns address of Licensing Server in form of IP address or domain name. |
int |
getLockGracePeriod()
Returns lock grace period (in days) for the license |
int |
getLockPeriod()
Returns period in days the license must retain lock to a particular user (applicable for USER_LICENSING_NAMED_LS model only) |
long |
getMemoryLimit()
Returns memory limit in bytes |
int |
getPrevLicenseMajorVersion()
Returns major version of previous license required for the Upgrade kind of license |
int |
getPrevLicenseMinorVersion()
Returns minor version of previous license required for the Upgrade kind of license |
java.util.List<java.lang.String> |
getPrevLicenseProductEditions()
Returns product editions of previous license required for Upgrade kind of license |
java.util.Collection |
getProductFeatureNames()
Returns product features' identifiers contained in the license. |
java.lang.String |
getProperty(java.lang.String aName,
java.lang.String aDefault)
Gets license property by its name |
java.util.Collection |
getPropertyNames()
Returns the names of the properties contained in the license |
java.lang.String |
getSerialNumber()
Returns serial number for the license |
int |
getUsageGracePeriod()
Returns usage grace period (in usages) for the license |
int |
getUsageLimit()
Returns usage limit for the license |
boolean |
isProductFeatureInLicense(java.lang.String aFeature)
Checks whether certain product feature (functionality) is included into the license. |
boolean |
isProductFeatureSupported(java.lang.String aFeature)
Checks whether certain product feature (functionality) is supported (allowed to be used) by the license. |
boolean |
isProductFeatureSupported(java.lang.String aFeature,
int aCase)
Checks whether specified feature is supported for the given license type and state combination. |
Methods inherited from interface com.jp.protection.pub.LicenseBase |
---|
getGracePeriod, getLicenseExpireDate, getLicenseIssueDate, getLicenseNumber, getLicenseOptions, getLicenseType, getNumberCopies, getProduct, getProductEdition, getProductMajorVersion, getProductMinorVersion, getUserLicensingModel |
Field Detail |
---|
static final java.lang.String PROPERTY_LICENSING_SERVER_ADDRESS
static final java.lang.String PROPERTY_ACTIVATION_KEY
static final java.lang.String PROPERTY_ACTIVATION_GRACE_PERIOD
static final java.lang.String PROPERTY_LOCK_GRACE_PERIOD
static final java.lang.String PROPERTY_SERIAL_NUMBER
static final java.lang.String PROPERTY_USAGE_GRACE_PERIOD
static final java.lang.String PROPERTY_USAGE_LIMIT
static final java.lang.String PREFIX
static final java.lang.String PROPERTY_MAIN_LICENSE
static final java.lang.String PROPERTY_CPU_LIMIT
static final java.lang.String PROPERTY_MEMORY_LIMIT
static final java.lang.String PROPERTY_LOCK_PERIOD
static final java.lang.String PROPERTY_CHECKOUT_PERIOD
static final java.lang.String PROPERTY_LICENSE_KIND
static final java.lang.String PROPERTY_PREV_LICENSE_MAJOR_VERSION
static final java.lang.String PROPERTY_PREV_LICENSE_MINOR_VERSION
static final java.lang.String PROPERTY_PREV_LICENSE_MINOR_PRODUCT_EDITIONS
static final java.lang.String PROPERTY_FIRST_NAME
static final java.lang.String PROPERTY_LAST_NAME
static final java.lang.String PROPERTY_TITLE
static final java.lang.String PROPERTY_COMPANY
static final java.lang.String PROPERTY_PHONE
static final java.lang.String PROPERTY_EMAIL
static final java.lang.String PROPERTY_ADDRESS
static final java.lang.String PROPERTY_CITY
static final java.lang.String PROPERTY_ZIP
static final java.lang.String PROPERTY_STATE
static final java.lang.String PROPERTY_COUNTRY
static final int NO_LIMIT
static final int NO_USAGE_LIMIT
static final int STATE_UNKNOWN
static final int STATE_OK
static final int STATE_EXPIRED
static final int STATE_INVALID
static final int STATE_NOT_ACTIVATED
static final int STATE_LOCK_VIOLATED
static final int STATE_NOT_LOCKED
static final int CASE_ENABLED
static final int CASE_COMMERCIAL_ENABLED
static final int CASE_EVALUATION_ENABLED
static final int CASE_EXPIRED_ENABLED
static final int CASE_EXPIRED_EVALUATION_ENABLED
static final int CASE_INVALID_ENABLED
static final int KIND_NEW
NEW
Kind of a license. Such licenses don't impose additional requirements for been valid
static final int KIND_UPGRADE
UPGRADE
Kind of a license. Upgrade licenses require existence of licenses of previous versions
for been valid
Method Detail |
---|
int getLicenseState()
STATE_
constantsboolean isProductFeatureInLicense(java.lang.String aFeature)
aFeature
- identifier of a feature to check
true
if feature is included into the license,
false
otherwise.boolean isProductFeatureSupported(java.lang.String aFeature)
isProductFeatureSupported(aFeature, CASE_ENABLED)
for Standard Edition
or isProductFeatureSupported(aFeature, CASE_COMMERCIAL_ENABLED)
for Professional Edition.
aFeature
- identifier of a feature to check
true
if feature is supported by the license,
false
otherwise. If feature is not found in the license
it is considered to be unsupported.boolean isProductFeatureSupported(java.lang.String aFeature, int aCase)
aFeature
- identifier of a feature to checkaCase
- defines license type and state combination to check a feature
against to. Should be one of the CASE_
constants.
true
if product feature is supported,
false
otherwisejava.util.Collection getProductFeatureNames()
java.lang.String getLicenseText()
java.lang.String getLicenseLocation()
java.lang.String getProperty(java.lang.String aName, java.lang.String aDefault)
aName
- property nameaDefault
- default property value used if property is not found in the license
aDefault
value if property is not found in the licensejava.util.Collection getPropertyNames()
java.lang.String getActivationKey()
int getActivationGracePeriod()
NO_GRACE_PERIOD
if no grace period is allowedint getLockGracePeriod()
NO_GRACE_PERIOD
if no grace period is allowedjava.lang.String getSerialNumber()
java.lang.String getLicensingServerAddress()
int getUsageLimit()
int getUsageGracePeriod()
NO_GRACE_PERIOD
if no grace period is allowedint getCPULimit()
long getMemoryLimit()
int getLockPeriod()
USER_LICENSING_NAMED_LS
model only)
int getCheckoutPeriod()
USER_LICENSING_NAMED_LS
model only)
int getLicenseKind()
KIND_
constantsint getPrevLicenseMajorVersion()
int getPrevLicenseMinorVersion()
java.util.List<java.lang.String> getPrevLicenseProductEditions()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |