com.jp.protection.pub.pro.lserver
Interface LicensingService

All Known Implementing Classes:

BasicLicensingServiceProvider.LicensingServiceProxy

public interface LicensingService

The interface for obtaining licenses and working with the license locks using the Licensing Server

Since:

3.0

Field Summary

static java.lang.String	ATTR_AVAILABLE_PROCESSORS
static java.lang.String	ATTR_CURRENT_LICENSE_DIGEST
static java.lang.String	ATTR_GLOBAL_IP_ADDRESS
static java.lang.String	ATTR_HOST_NAME
static java.lang.String	ATTR_INSTALL_ID
static java.lang.String	ATTR_IP_ADDRESS
static java.lang.String	ATTR_JAVA_VERSION
static java.lang.String	ATTR_LOGIN
static java.lang.String	ATTR_MAC_ADDRESS
static java.lang.String	ATTR_MAC_ADDRESSES
static java.lang.String	ATTR_PASSWORD
static java.lang.String	ATTR_TOTAL_MEMORY
static java.lang.String	ATTR_URL
static java.lang.String	ATTR_USER_NAME
static java.lang.String	ATTR_VENDOR_ID

Method Summary

LicensingServiceResult	canLockLicense(LicenseData.Request aRequest, java.util.Map anAttributes) Query the Licensing Server to check whether the license lock can be acquired
LicensingServiceResult.CheckoutResult	checkoutLicense(java.lang.String aTicket, java.util.Map anAttributes) Check outs the license to allow offline use
LicensingServiceResult	confirmLicenseLock(java.lang.String aTicket, java.util.Map anAttributes) Notifies the Licensing Server that the license lock is still in use
LicensingServiceResult.LicenseResult	getLicense(LicenseData.Request aRequest, java.util.Map anAttributes) Obtains a license from the Licensing Server
LicensingServiceResult	lockLicense(LicenseData.Request aRequest, java.util.Map anAttributes) Acquires license lock using the Licensing Server
LicensingServiceResult	unlockLicense(java.lang.String aTicket, java.util.Map anAttributes) Releases the license lock

Field Detail

ATTR_AVAILABLE_PROCESSORS

static final java.lang.String ATTR_AVAILABLE_PROCESSORS

See Also:

Constant Field Values

ATTR_IP_ADDRESS

static final java.lang.String ATTR_IP_ADDRESS

See Also:

Constant Field Values

ATTR_HOST_NAME

static final java.lang.String ATTR_HOST_NAME

See Also:

Constant Field Values

ATTR_MAC_ADDRESS

static final java.lang.String ATTR_MAC_ADDRESS

See Also:

Constant Field Values

ATTR_MAC_ADDRESSES

static final java.lang.String ATTR_MAC_ADDRESSES

See Also:

Constant Field Values

ATTR_INSTALL_ID

static final java.lang.String ATTR_INSTALL_ID

See Also:

Constant Field Values

ATTR_USER_NAME

static final java.lang.String ATTR_USER_NAME

See Also:

Constant Field Values

ATTR_JAVA_VERSION

static final java.lang.String ATTR_JAVA_VERSION

See Also:

Constant Field Values

ATTR_LOGIN

static final java.lang.String ATTR_LOGIN

See Also:

Constant Field Values

ATTR_PASSWORD

static final java.lang.String ATTR_PASSWORD

See Also:

Constant Field Values

ATTR_URL

static final java.lang.String ATTR_URL

See Also:

Constant Field Values

ATTR_VENDOR_ID

static final java.lang.String ATTR_VENDOR_ID

See Also:

Constant Field Values

ATTR_GLOBAL_IP_ADDRESS

static final java.lang.String ATTR_GLOBAL_IP_ADDRESS

See Also:

Constant Field Values

ATTR_TOTAL_MEMORY

static final java.lang.String ATTR_TOTAL_MEMORY

See Also:

Constant Field Values

ATTR_CURRENT_LICENSE_DIGEST

static final java.lang.String ATTR_CURRENT_LICENSE_DIGEST

See Also:

Constant Field Values

Method Detail

getLicense

LicensingServiceResult.LicenseResult getLicense(LicenseData.Request aRequest,
                                                java.util.Map anAttributes)

Obtains a license from the Licensing Server

Parameters:

aRequest - request which identifies license to get

anAttributes - attributes (identified by ATTR_ keys) which describe client environment.

Returns:

operation result

lockLicense

LicensingServiceResult lockLicense(LicenseData.Request aRequest,
                                   java.util.Map anAttributes)

Acquires license lock using the Licensing Server

Parameters:

aRequest - request which identifies license to acquire lock for

anAttributes - attributes (identified by ATTR_ keys) which describe client environment.

Returns:

operation result

canLockLicense

LicensingServiceResult canLockLicense(LicenseData.Request aRequest,
                                      java.util.Map anAttributes)

Query the Licensing Server to check whether the license lock can be acquired

Parameters:

aRequest - request which identifies license to acquire lock for

anAttributes - attributes (identified by ATTR_ keys) which describe client environment.

Returns:

operation result

confirmLicenseLock

LicensingServiceResult confirmLicenseLock(java.lang.String aTicket,
                                          java.util.Map anAttributes)

Notifies the Licensing Server that the license lock is still in use

Parameters:

aTicket - ticket unique identifies the license session for the lock

anAttributes - attributes (identified by ATTR_ keys) which describe client environment.

Returns:

operation result

unlockLicense

LicensingServiceResult unlockLicense(java.lang.String aTicket,
                                     java.util.Map anAttributes)

Releases the license lock

Parameters:

aTicket - ticket unique identifies the license session for the lock

anAttributes - attributes (identified by ATTR_ keys) which describe client environment.

Returns:

operation result

checkoutLicense

LicensingServiceResult.CheckoutResult checkoutLicense(java.lang.String aTicket,
                                                      java.util.Map anAttributes)

Check outs the license to allow offline use

Parameters:

aTicket - ticket unique identifies the license session to checkout

anAttributes - attributes (identified by ATTR_ keys) which describe client environment.

Returns:

operation result

Since:

v5.0