com.jp.protection.pub.pro.integration
Interface LicensingFacade

All Known Subinterfaces:

LicensingFacadeDelegate

All Known Implementing Classes:

LicensingFacadeWS, LocalLicensingFacade

public interface LicensingFacade

This interface provides methods required for licenses acquisition and activation. General process for implementations of all methods that return the LicensingFacadeResult is as follows:

1. If there no errors, then generate license according to specified parameters, convert it to array of bytes, wrap it into an LicensingFacadeResult instance with the result code LicensingFacadeResult.RESULT_OK and return such result.
2. If there is an error which has some meaning to the user then create the LicensingFacadeResult instance with the result code LicensingFacadeResult.RESULT_ERROR, specify error message and return such result.
3. If there is some system errors due to misconfiguration or other reasons just throw appropriate exception.

Field Summary

static java.lang.String	ARGUMENT_ACTIVATION_KEY Defines name for 'Activation Key' argument
static java.lang.String	ARGUMENT_ACTIVATION_LOCK_KEY Defines name for 'Activation and Lock Key' argument
static java.lang.String	ARGUMENT_HOST_NAME Defines name for 'host' argument
static java.lang.String	ARGUMENT_IP_ADDRESS Defines name for 'IP address' argument
static java.lang.String	ARGUMENT_LICENSE_FEATURE_PREFIX Defines prefix name for 'feature' argument.
static java.lang.String	ARGUMENT_LICENSE_PROPERTY_FREFIX Defines prefix name for 'property' argument.
static java.lang.String	ARGUMENT_LOCALE Defines name for 'locale' argument
static java.lang.String	ARGUMENT_USE_COUNT_LEFT Defines name for 'use count left' argument
static java.lang.String	ARGUMENT_USER Defines name for 'user' argument

Method Summary

LicensingFacadeResult	activateLicense(byte[] aLicenseBytes, dev.entities.Customer aCustomer, java.lang.String anActivationKey, java.lang.String aLogin, java.lang.String aPassword, java.util.Map anArguments) Activates a license specified as an array of bytes.
LicensingFacadeResult	deactivateLicense(byte[] aLicenseBytes, java.lang.String aDeactivationKey, java.lang.String aLogin, java.lang.String aPassword, java.util.Map anArguments) Deactivates a license at the vendors side.
LicensingFacadeResult	getLicense(LicenseDescr aLicenseDescr, dev.entities.Customer aCustomer, java.lang.String aLogin, java.lang.String aPassword, java.util.Map anArguments) Generates a license according to the provided license descriptor.
LicensingFacadeResult	getLicense(LicenseInfo aLicenseInfo, dev.entities.Customer aCustomer, java.lang.String aLogin, java.lang.String aPassword, java.util.Map anArguments) Generates a license according to provided license information.
LicensingFacadeResult	getLicense(java.lang.String aSerialNumber, dev.entities.Customer aCustomer, java.lang.String aLogin, java.lang.String aPassword, java.util.Map anArguments) Generates a license according to the provided Serial Number.
java.lang.String	getVersion() Returns the version of implementation.

Field Detail

ARGUMENT_LOCALE

static final java.lang.String ARGUMENT_LOCALE

Defines name for 'locale' argument

See Also:

Constant Field Values

ARGUMENT_LICENSE_PROPERTY_FREFIX

static final java.lang.String ARGUMENT_LICENSE_PROPERTY_FREFIX

Defines prefix name for 'property' argument. Such argument can be used to specify license properties.

See Also:

Constant Field Values

ARGUMENT_LICENSE_FEATURE_PREFIX

static final java.lang.String ARGUMENT_LICENSE_FEATURE_PREFIX

Defines prefix name for 'feature' argument. Such argument can be used to specify license features.

See Also:

Constant Field Values

ARGUMENT_ACTIVATION_KEY

static final java.lang.String ARGUMENT_ACTIVATION_KEY

Defines name for 'Activation Key' argument

See Also:

Constant Field Values

ARGUMENT_ACTIVATION_LOCK_KEY

static final java.lang.String ARGUMENT_ACTIVATION_LOCK_KEY

Defines name for 'Activation and Lock Key' argument

See Also:

Constant Field Values

ARGUMENT_IP_ADDRESS

static final java.lang.String ARGUMENT_IP_ADDRESS

Defines name for 'IP address' argument

See Also:

Constant Field Values

ARGUMENT_HOST_NAME

static final java.lang.String ARGUMENT_HOST_NAME

Defines name for 'host' argument

See Also:

Constant Field Values

ARGUMENT_USER

static final java.lang.String ARGUMENT_USER

Defines name for 'user' argument

See Also:

Constant Field Values

ARGUMENT_USE_COUNT_LEFT

static final java.lang.String ARGUMENT_USE_COUNT_LEFT

Defines name for 'use count left' argument

See Also:

Constant Field Values

Method Detail

getLicense

LicensingFacadeResult getLicense(LicenseDescr aLicenseDescr,
                                 dev.entities.Customer aCustomer,
                                 java.lang.String aLogin,
                                 java.lang.String aPassword,
                                 java.util.Map anArguments)

Generates a license according to the provided license descriptor. Valid login and password values should be specified to ensure that the user is eligible to get or activate certain type of license. This method is intended to be used by customers' applications to get evaluation licenses. It's quite safe to use as it allows to define only basic license attributes; exact license attributes will be specified by backend.

Parameters:

aLicenseDescr - describes license to get

aCustomer - specifies customer information, which requests a license

aLogin - login name

aPassword - password

anArguments - additional arguments can be needed for proper license getting

Returns:

a LicensingFacadeResult instance.

getLicense

LicensingFacadeResult getLicense(LicenseInfo aLicenseInfo,
                                 dev.entities.Customer aCustomer,
                                 java.lang.String aLogin,
                                 java.lang.String aPassword,
                                 java.util.Map anArguments)

Generates a license according to provided license information. Valid login and password values should be specified to ensure that the user is eligible to get or activate certain type of license. This method is intended for internal vendors' use e.g. delivering licenses using Control Center or allowing stores/resellers to generate licenses according to all specified attributes. In most of cases it should be never used by custom applications as it provides too much potential control over licenses generation.

Parameters:

aLicenseInfo - describes license to get

aCustomer - specifies customer information, which requests a license

aLogin - login name

aPassword - password

anArguments - additional arguments can be needed for proper license getting

Returns:

a LicensingFacadeResult instance.

getLicense

LicensingFacadeResult getLicense(java.lang.String aSerialNumber,
                                 dev.entities.Customer aCustomer,
                                 java.lang.String aLogin,
                                 java.lang.String aPassword,
                                 java.util.Map anArguments)

Generates a license according to the provided Serial Number. Valid login and password values should be specified to ensure that the user is eligible to get or activate certain type of license.

Parameters:

aSerialNumber - serial number

aCustomer - specifies customer information, which requests a license

aLogin - login name

aPassword - password

anArguments - additional arguments can be needed for proper license getting

Returns:

a LicensingFacadeResult instance.

activateLicense

LicensingFacadeResult activateLicense(byte[] aLicenseBytes,
                                      dev.entities.Customer aCustomer,
                                      java.lang.String anActivationKey,
                                      java.lang.String aLogin,
                                      java.lang.String aPassword,
                                      java.util.Map anArguments)

Activates a license specified as an array of bytes. Valid login and password values should be specified to ensure that the user is eligible to activate certain type of license.

Parameters:

aLicenseBytes - license to activate passed as array of bytes

aCustomer - specifies customer information, which requests a license

anActivationKey - activation key

aLogin - login name

aPassword - password

anArguments - additional arguments can be needed for proper license activation

Returns:

a LicensingFacadeResult instance.

deactivateLicense

LicensingFacadeResult deactivateLicense(byte[] aLicenseBytes,
                                        java.lang.String aDeactivationKey,
                                        java.lang.String aLogin,
                                        java.lang.String aPassword,
                                        java.util.Map anArguments)

Deactivates a license at the vendors side. The license should be previously deactivated at the customers side by call of LicenseHostPro.deactivateLicense() Valid login and password values should be specified to ensure that the user is eligible to activate certain type of license.

Parameters:

aLicenseBytes - license to deactivate passed as array of bytes

aDeactivationKey - deactivation key returned by LicenseHostPro.deactivateLicense() call

aLogin - login name

aPassword - password

anArguments - additional arguments can be needed for proper license deactivation

Returns:

a LicensingFacadeResult instance.

getVersion

java.lang.String getVersion()

Returns the version of implementation. Can be useful to avoid improper deployment issues.

Returns:

version information