com.jp.protection.pub
Interface LicenseBase

All Known Subinterfaces:

License

All Known Implementing Classes:

LicenseBaseImpl, LicenseImpl, LicenseInfo

public interface LicenseBase

This class represents "basic license" abstraction. It provides methods that allows for obtaining information about the license itself such as license number, for which product the license is issued for, license issue date etc. 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	NO_GRACE_PERIOD
static int	OPTION_CHECK_NUMBER_OF_COPIES Defines requirement to check number of simultaneously running copies. Note, this option is applicable for USER_LICENSING_FLOATING user licensing models.
static int	OPTION_COUNT_ANY_HOSTS Defines requirement to check number of simultaneously running copies running on any hosts. Note, this option is applicable for USER_LICENSING_FLOATING and USER_LICENSING_FLOATING_LS user licensing models.
static int	OPTION_COUNT_DIFF_HOSTS Defines requirement to check number of simultaneously running copies running on different hosts. Note, this option is applicable for USER_LICENSING_FLOATING and USER_LICENSING_FLOATING_LS user licensing models.
static int	OPTION_DISALLOW_SEVERAL_COPIES_SAME_HOST Defines requirement to disallow running of several copies on the same host. Note, this option is applicable for USER_LICENSING_NAMED or USER_LICENSING_NAMED_LS user licensing models.
static int	OPTION_REQUIRE_ACTIVATION Defines requirement to activate license to enable use of protected application. Note: this option can not be set together with the OPTION_REQUIRE_ACTIVATION_LOCK. Note, this option is applicable for USER_LICENSING_NAMED user licensing models
static int	OPTION_REQUIRE_ACTIVATION_LOCK Defines requirement to lock license to a particular computer system.
static int	OPTION_REQUIRE_USER_INFO Defines requirement to provide user information during the license activation. Note, this option is applicable for USER_LICENSING_NAMED user licensing models.
static java.lang.String[]	PROPERTIES
static java.lang.String	PROPERTY_GRACE_PERIOD
static java.lang.String	PROPERTY_LICENSE_EXPIRE_DATE
static java.lang.String	PROPERTY_LICENSE_ISSUE_DATE
static java.lang.String	PROPERTY_LICENSE_NUMBER
static java.lang.String	PROPERTY_LICENSE_OPTIONS
static java.lang.String	PROPERTY_LICENSE_TYPE
static java.lang.String	PROPERTY_NUMBER_COPIES
static java.lang.String	PROPERTY_PRODUCT
static java.lang.String	PROPERTY_PRODUCT_EDITION
static java.lang.String	PROPERTY_PRODUCT_MAJOR_VERSION
static java.lang.String	PROPERTY_PRODUCT_MINOR_VERSION
static java.lang.String	PROPERTY_USER_LICENSING_MODEL
static int	TYPE_COMMERCIAL Defines commercial type of the license.
static int	TYPE_EVALUATION Defines evaluation type of the license.
static int	TYPE_EXTENDED_EVALUATION Defines evaluation type of the license that allows extension of the evaluation period.
static int	USER_LICENSING_FLOATING Defines "floating user" licensing model.
static int	USER_LICENSING_FLOATING_LS Defines the "floating user - Licensing Server" licensing model model.
static int	USER_LICENSING_NAMED Defines the "named user" licensing model.
static int	USER_LICENSING_NAMED_LS Defines "named user - Licensing Server" licensing model model.
static int	USER_LICENSING_UNCOUNTED Defines the "uncounted user" licensing model.
static int	USER_LICENSING_UNKNOWN Defines value for unknown user licensing model.

Method Summary

int	getGracePeriod() Returns number of days the license is still valid after reaching expiration date.
java.util.Date	getLicenseExpireDate() Returns license expiration date.
java.util.Date	getLicenseIssueDate() Returns license issue date.
java.lang.String	getLicenseNumber() Returns number of the license.
int	getLicenseOptions() Returns the license options.
int	getLicenseType() Returns type of the license.
int	getNumberCopies() Returns number of application copies allowed to concurrently run with this license.
java.lang.String	getProduct() Returns identifier of the product the license is issued for.
java.lang.String	getProductEdition() Returns identifier of the product editions the license is issued for.
int	getProductMajorVersion() Returns major version of the product.
int	getProductMinorVersion() Returns minor version of the product.
int	getUserLicensingModel() Returns user licensing model.

Field Detail

PROPERTY_GRACE_PERIOD

static final java.lang.String PROPERTY_GRACE_PERIOD

See Also:

Constant Field Values

PROPERTY_LICENSE_EXPIRE_DATE

static final java.lang.String PROPERTY_LICENSE_EXPIRE_DATE

See Also:

Constant Field Values

PROPERTY_LICENSE_ISSUE_DATE

static final java.lang.String PROPERTY_LICENSE_ISSUE_DATE

See Also:

Constant Field Values

PROPERTY_LICENSE_NUMBER

static final java.lang.String PROPERTY_LICENSE_NUMBER

See Also:

Constant Field Values

PROPERTY_LICENSE_OPTIONS

static final java.lang.String PROPERTY_LICENSE_OPTIONS

See Also:

Constant Field Values

PROPERTY_LICENSE_TYPE

static final java.lang.String PROPERTY_LICENSE_TYPE

See Also:

Constant Field Values

PROPERTY_NUMBER_COPIES

static final java.lang.String PROPERTY_NUMBER_COPIES

See Also:

Constant Field Values

PROPERTY_PRODUCT

static final java.lang.String PROPERTY_PRODUCT

See Also:

Constant Field Values

PROPERTY_PRODUCT_EDITION

static final java.lang.String PROPERTY_PRODUCT_EDITION

See Also:

Constant Field Values

PROPERTY_PRODUCT_MAJOR_VERSION

static final java.lang.String PROPERTY_PRODUCT_MAJOR_VERSION

See Also:

Constant Field Values

PROPERTY_PRODUCT_MINOR_VERSION

static final java.lang.String PROPERTY_PRODUCT_MINOR_VERSION

See Also:

Constant Field Values

PROPERTY_USER_LICENSING_MODEL

static final java.lang.String PROPERTY_USER_LICENSING_MODEL

See Also:

Constant Field Values

PROPERTIES

static final java.lang.String[] PROPERTIES

TYPE_EVALUATION

static final int TYPE_EVALUATION

Defines evaluation type of the license.

See Also:

Constant Field Values

TYPE_EXTENDED_EVALUATION

static final int TYPE_EXTENDED_EVALUATION

Defines evaluation type of the license that allows extension of the evaluation period.

See Also:

Constant Field Values

TYPE_COMMERCIAL

static final int TYPE_COMMERCIAL

Defines commercial type of the license.

See Also:

Constant Field Values

NO_GRACE_PERIOD

static final int NO_GRACE_PERIOD

See Also:

Constant Field Values

OPTION_REQUIRE_ACTIVATION

static final int OPTION_REQUIRE_ACTIVATION

Defines requirement to activate license to enable use of protected application.
Note: this option can not be set together with the OPTION_REQUIRE_ACTIVATION_LOCK.
Note, this option is applicable for USER_LICENSING_NAMED user licensing models

See Also:

Constant Field Values

OPTION_REQUIRE_ACTIVATION_LOCK

static final int OPTION_REQUIRE_ACTIVATION_LOCK

Defines requirement to lock license to a particular computer system.
Note, this option can not be set together with the OPTION_REQUIRE_ACTIVATION.
Note, this option is applicable for USER_LICENSING_NAMED user licensing models.

See Also:

Constant Field Values

OPTION_REQUIRE_USER_INFO

static final int OPTION_REQUIRE_USER_INFO

Defines requirement to provide user information during the license activation.
Note, this option is applicable for USER_LICENSING_NAMED user licensing models.

See Also:

Constant Field Values

OPTION_CHECK_NUMBER_OF_COPIES

static final int OPTION_CHECK_NUMBER_OF_COPIES

Defines requirement to check number of simultaneously running copies.
Note, this option is applicable for USER_LICENSING_FLOATING user licensing models.

See Also:

Constant Field Values

OPTION_COUNT_ANY_HOSTS

static final int OPTION_COUNT_ANY_HOSTS

Defines requirement to check number of simultaneously running copies running on any hosts.
Note, this option is applicable for USER_LICENSING_FLOATING and USER_LICENSING_FLOATING_LS user licensing models.

See Also:

Constant Field Values

OPTION_COUNT_DIFF_HOSTS

static final int OPTION_COUNT_DIFF_HOSTS

Defines requirement to check number of simultaneously running copies running on different hosts.
Note, this option is applicable for USER_LICENSING_FLOATING and USER_LICENSING_FLOATING_LS user licensing models.

See Also:

Constant Field Values

OPTION_DISALLOW_SEVERAL_COPIES_SAME_HOST

static final int OPTION_DISALLOW_SEVERAL_COPIES_SAME_HOST

Defines requirement to disallow running of several copies on the same host.
Note, this option is applicable for USER_LICENSING_NAMED or USER_LICENSING_NAMED_LS user licensing models.

See Also:

Constant Field Values

USER_LICENSING_UNKNOWN

static final int USER_LICENSING_UNKNOWN

Defines value for unknown user licensing model. Allowed only for version 2.x-1.x licenses.

Since:

3.0

See Also:

Constant Field Values

USER_LICENSING_UNCOUNTED

static final int USER_LICENSING_UNCOUNTED

Defines the "uncounted user" licensing model. The "uncounted user" model means that any number of the users can work concurrently with the license regardless of the license's number of copies value.

Since:

3.0

See Also:

Constant Field Values

USER_LICENSING_FLOATING

static final int USER_LICENSING_FLOATING

Defines "floating user" licensing model. The "floating user" means that only a certain number of the users can work concurrently with the license according to the license's number of copies value. Actual usage check is done using network broadcast facility.

Since:

3.0

See Also:

Constant Field Values

USER_LICENSING_NAMED

static final int USER_LICENSING_NAMED

Defines the "named user" licensing model. The "named user" model means that only a certain number of the users can work with the license according to the license's number of copies value. This is done via activation and/or activation-and-lock facility.

Since:

3.0

See Also:

Constant Field Values

USER_LICENSING_FLOATING_LS

static final int USER_LICENSING_FLOATING_LS

Defines the "floating user - Licensing Server" licensing model model. The "floating user - Licensing Server" means that only a certain number of the users can work concurrently with the license according to the license's number of copies value. Actual usage check is done by contacting the Licensing Server and acquiring the license lock.

Since:

3.0

See Also:

Constant Field Values

USER_LICENSING_NAMED_LS

static final int USER_LICENSING_NAMED_LS

Defines "named user - Licensing Server" licensing model model. The "named user - Licensing Server" model means that only a certain number of the users can work with the license according to the license's number of copies value. Actual usage check is done by contacting the Licensing Server and acquiring the license lock.

Since:

3.0

See Also:

Constant Field Values

Method Detail

getLicenseOptions

int getLicenseOptions()

Returns the license options. The value can be one of OPTION_ constants.

Returns:

the license options

getLicenseNumber

java.lang.String getLicenseNumber()

Returns number of the license.

Returns:

the number of the license.

getLicenseType

int getLicenseType()

Returns type of the license.

Returns:

license type, which can be one of the TYPE_ constants.

getNumberCopies

int getNumberCopies()

Returns number of application copies allowed to concurrently run with this license.

Returns:

actual number of copies or the DONT_CHECK if any (unlimited).

getGracePeriod

int getGracePeriod()

Returns number of days the license is still valid after reaching expiration date.

Returns:

actual number of days or the NO_GRACE_PERIOD if there is no grace period specified.

getProduct

java.lang.String getProduct()

Returns identifier of the product the license is issued for.

Returns:

identifier of the product.

getProductEdition

java.lang.String getProductEdition()

Returns identifier of the product editions the license is issued for.

Returns:

identifier of the product edition.

getProductMajorVersion

int getProductMajorVersion()

Returns major version of the product.

Returns:

major version number

getProductMinorVersion

int getProductMinorVersion()

Returns minor version of the product.

Returns:

minor version number

getLicenseExpireDate

java.util.Date getLicenseExpireDate()

Returns license expiration date.

Returns:

license expiration date or null if unspecified.

getLicenseIssueDate

java.util.Date getLicenseIssueDate()

Returns license issue date.

Returns:

license issue date or null if unspecified.

getUserLicensingModel

int getUserLicensingModel()

Returns user licensing model.

Returns:

user licensing model as on of USER_LICENSING_ constants.

Since:

3.0