public abstract long requestLicense(PublicKey publicKey,
                                    long units,
                                    boolean forceNumber,
                                    int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Interface org.opengroup.xslm.BasicApplicationClient

Methods

public abstract void confirm() 
 throws CommunicationException, LicenseCertificateException, 
 LicenseClientException, ResourceUnavailableException

Confirms that a license is currently in use. Should the license system not receive any confirm from the application client within the default time period specified in the certificate, the license is no longer in use and will return it to the pool of free, available licenses.

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public abstract long queryAPILevel() 
 throws CommunicationException, LicenseClientException, 
 ResourceUnavailableException

Returns the maximum API specification level supported by all license servers in the licensing system.

Returns:

the maximum API specification level supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public abstract void releaseLicense() 
 throws CommunicationException, LicenseCertificateException, 
 LicenseClientException, ResourceUnavailableException

Releases the licenses associated with this instance of the license client

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public abstract long requestLicense(PublicKey publicKey) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate)

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

DEFAULT_CONFIRM_TIME

java.lang.Object
   |
   +----org.opengroup.xslm.LicenseAgent

LicenseAgent provides implementation-independent objects, a caller (license broker or application code) can request a particular implementation of a LicenseAgent object from a particular publisher. The system will determine if there is an implementation of the requested LicenseAgent object in the package requested, and throw an exception if there is not.

public static BasicApplicationClient getBasicApplicationClientInstance
    (String licensingSystemPublisher,
    String publisherID,
    long productID,
    long versionID,
    long featureID)
 throws NoSuchPublisherException, NoSuchAPILevelException

Generates a BasicApplicationClient object as supplied from the specified publisher.

Parameters:

licensingSystemPublisher - the name of the license system publisher.

publisherID - the identifier of the software publisher

productID - the identifier of the product

versionID - the identifier of the version

featureID - the identifier of the feature

Returns:

the new BasicApplicationClient object

Throws: NoSuchPublisherException

if there is no subclass of LicenseAgent provided by the specified publisher.

Throws: NoSuchAPILevelException

if the package provded by the specified publisher does not contain the requested API level

See Also:

LicenseBroker, Publisher

public static AdvancedApplicationClient
    getAdvancedApplicationClientInstance(String licensingSystemPublisher,
                                        Session session,
                                        String publisherID,
                                        long productID,
                                        long versionID,
                                        long featureID) 
 throws NoSuchPublisherException, NoSuchAPILevelException

public void confirm() 
 throws CommunicationException, LicenseCertificateException, 
 LicenseClientException, ResourceUnavailableException

Confirms that a license is currently in use. Should the license system not receive any confirm fromthe application client within the default time period specified in the certificate, the license is no longer in use and will return it to the pool of free, available licenses.

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void releaseLicense() 
 throws CommunicationException, LicenseCertificateException, 
 LicenseClientException, ResourceUnavailableException

Releases the licenses associated with this instance of the license client

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void confirm(long confirmTime,
                    int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Confirms that a license is currently in use. Should the license system not receive any confirm from the application client within the default time period specified in the certificate, the license is no longer in use and will return it to the pool of free, available licenses.

Parameters:

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public byte[] getAuthenticationSignature() 
 throws LicenseClientException

Returns the digital signature created by the licensing system from the input and output parameters and the authorization token.

Returns:

the digital signature created by the licensing system.

Throws: LicenseClientException

if a generic license client error occurs

public void logMessage(String message,
                       int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Logs and application-specified text message into license system's log

Parameters:

message - the text string of the message, it can be of any length; however, a licensing system is not required to accept more than 4096 bytes.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long queryAPILevel() 
 throws CommunicationException, LicenseClientException, 
 ResourceUnavailableException

Returns the maximum API specification level supported by all license servers in the licensing system.

Returns:

the API level supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long[] queryFunctionalTowers() 
 throws CommunicationException, LicenseClientException, 
 ResourceUnavailableException

Returns an array of functional tower identifiers supported by all license servers in the licensing system.

Returns:

an array of functional tower identifiers supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

Returns the various types of license certificate information associated with this license client object.

Parameters:

queryType - a value which identifies the information to be returned

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

When queryType=XSLM_QUERY_PUBLISHER_INFO, the data element PUBLISHER_SECTION, if present, followed by the data element PUBLISHER_USE, if present.

When queryType=XSLM_QUERY_CUST_DEF_INFO, the data element CUSTOMER_ASSIGNED_APPL_INFO, if present.

When queryType=XSLM_QUERY_CERTIFICATE, the data element CERTIFICATE.

When queryType=XSLM_QUERY_CERT_RELATED_INFO, the data element CERTIFICATE_RELATED_INFORMATION

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void record(long counterIdentifier,
                   float counter,
                   int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Informs the license system about a metering activity in progress

Parameters:

counterIdentifier - the identifier of one of the 8 different counters (defined within the license certificate)

counter - the value of the number of units the license system should add to or subtract from the total count

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void releaseLicense(long units,
                           int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Releases some or all license units associated with this instance of the license client

Parameters:

units - number of license units to be released

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                           String namedUser,
                           int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

namedUser - the named user for which license units are being requested

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                           long confirmTime,
                           int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

confirmTime - elapsed time (in seconds) whithin which the license system may expect the next confirm.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                           String namedUser,
                           long confirmTime,
                           long units,
                           boolean forceNumber,
                           int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Requests the license system for specified number of units licenses

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

namedUser - the named user for which license units are being requested

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

units - number of license units to be requested

forceNumber - whether or not a lower number of license units than that specified should be granted

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                           long units,
                           boolean forceNumber,
                           int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

Requests the license system for specified number of license units

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

units - number of license units to be requested

forceNumber - whether or not a lower number of license units than that specified should be granted

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected final void init(Session session,
                          String publisherID,
                          long productID,
                          long versionID,
                          long featureID)

Initializes the LicenseBroker object returned by either a getBasicApplicationClientInstance or getAdvancedApplicationClientInstance method invocation.

Parameters:

session - the session this LicenseBroker object is associated with

publisherID - the identifier of the software publisher

productID - the identifier of the product

versionID - the identifier of the version

featureID - the identifier of the feature

protected abstract void engineReleaseLicense() 
 throws CommunicationException, LicenseCertificateException, 
 LicenseClientException, ResourceUnavailableException

SPI: Releases the licenses associated with this instance of the license client

Parameters:

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long engineRequestLicense(PublicKey publicKey) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

SPI: Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract void engineConfirm(long confirmTime,
                                      int authenticationToken) 
 throws CommunicationException, InvalidParameterException, 
 LicenseCertificateException, LicenseClientException, 
 ResourceUnavailableException

SPI: Confirms that a license is currently in use.

Parameters:

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract byte[] engineGetAuthenticationSignature() 
 throws LicenseClientException

SPI: Returns the digital signature created by the licensing system from the input and output parameters and the authorization token.

Returns:

the digital signature created by the licensing system.

Throws: LicenseClientException

if a generic license client error occurs

protected abstract void engineLogMessage(String message,
                                         int authenticationToken)
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Logs and application-specified text message into license system's log.

Parameters:

message - the text string of the message, it can be of any length; however, a licensing system is not required to accept more than 4096 bytes.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long engineQueryAPILevel() 
 throws CommunicationException, LicenseClientException, 
 ResourceUnavailableException

SPI: Returns the maximum API specification level supported by all license servers in the licensing system.

Returns:

the maximum API specification level supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long[] engineQueryFunctionalTowers() 
 throws CommunicationException, LicenseClientException, 
 ResourceUnavailableException

SPI: Returns the maximum API specification level supported by all license servers in the licensing system.

Returns:

the maximum API specification level supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract byte[] engineQueryCertificateInfo(int queryType, 
                              int authenticationToken) 
 throws CommunicationException, LicenseCertificateException,
 LicenseClientException, ResourceUnavailableException 

SPI: Returns the various types of license certificate information associated with this license client object.

Parameters:

queryType - a value which identifies the information to be returned

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

When queryType=XSLM_QUERY_PUBLISHER_INFO, the data element PUBLISHER_SECTION, if present, followed by the data element PUBLISHER_USE, if present.

When queryType=XSLM_QUERY_CUST_DEF_INFO, the data element CUSTOMER_ASSIGNED_APPL_INFO, if present.

When queryType=XSLM_QUERY_CERTIFICATE, the data element CERTIFICATE.

When queryType=XSLM_QUERY_CERT_RELATED_INFO, the data element CERTIFICATE_RELATED_INFORMATION

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract void engineRecord(long counterIdentifier,
                                     float counter,
                                     int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Informs the license system about a metering activity in progress

Parameters:

counterIdentifier - the identifier of one of the 8 different counters (defined within the license certificate)

counter - the value of the number of units the license system should add to or subtract from the total count

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract void engineReleaseLicense(long units,
                                             int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Releases some or all license units associated with this instance of the license client

Parameters:

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

units - number of license units to be released

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long engineRequestLicense(PublicKey publicKey,
                                             String namedUser,
                                             long confirmTime,
                                             long units,
                                             boolean forceNumber,
                                             int authenticationToken)
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Requests the license system for the specified number of units licenses.

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

namedUser - the named user for which license units are being requested

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

units - number of license units to be requested

forceNumber - whether or not a lower number of license units than that specified should be granted

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

java.lang.Object
   |
   +----org.opengroup.xslm.LicenseBroker

public abstract class LicenseBroker

extends Object

implements BasicApplicationClient, AdvancedApplicationClient, XSLMConstants The LicenseBroker class is used to render the presence of multiple licensing systems implementations transparent to application clients; that is to create the illusion of a single logical license management system, when two or more implementations are available in the environment.

Like other classes in org.opengroup.xslm, the LicenseBroker class has two major components:

LicenseBroker API (Application Program Interface)

This is the interface of methods called by applications needing License Broker services to have their requests routed to real implementations of licensing systems available in the environment. The API consists of all public methods.

LicenseBroker SPI (Service Provider Interface)

This is the interface implemented by licensing system publishers that supply specific license use management packages. It consists of all methods whose names are prefixed by engine. Each such method is called by a correspondingly-named public API method. For example, the engineRequestLicense method is called by the requestLicense method. The SPI methods are abstract; publishers must supply a concrete implementation.

Constructors

public void confirm() 
 throws CommunicationException, LicenseCertificateException,
 LicenseClientException, ResourceUnavailableException

Confirms that a license is currently in use. Should the license system not receive any confirm fromthe application client within the default time period specified in the certificate, the license is no longer in use and will return it to the pool of free, available licenses.

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void releaseLicense() 
 throws CommunicationException, LicenseCertificateException,
 LicenseClientException, ResourceUnavailableException

Releases the licenses associated with this instance of the license client

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void confirm(long confirmTime,
                    int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Confirms that a license is currently in use. Should the license system not receive any confirm from the application client within the default time period specified in the certificate, the license is no longer in use and will return it to the pool of free, available licenses.

Parameters:

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public byte[] getAuthenticationSignature() 
 throws LicenseClientException

Returns the digital signature created by the licensing system from the input and output parameters and the authorization token.

Returns:

the digital signature created by the licensing system.

Throws: LicenseClientException

if a generic license client error occurs

public String getLicensingSystemPublisherID() 
 throws LicenseClientException

Returns the licensing system publisher identifier of this LicenseBroker object. It may be used to determine how to calculate the digital signature required to authenticate the licensing system itself.

Returns:

the licensing system publisher identifier of this LicenseBrokerObject.

Throws: LicenseClientException

if a generic license client error occurs

public void logMessage(String message,
                       int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Logs and application-specified text message into license system's log

Parameters:

message - the text string of the message, it can be of any length; however, a licensing system is not required to accept more than 4096 bytes.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long queryAPILevel() 
 throws CommunicationException, LicenseClientException,
 ResourceUnavailableException

Returns the maximum API specification level supported by all license servers in the licensing system.

Returns:

the API level supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long[] queryFunctionalTowers() 
 throws CommunicationException, LicenseClientException,
 ResourceUnavailableException

Returns an array of functional tower identifiers supported by all license servers in the licensing system.

Returns:

an array of functional tower identifiers supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public byte[] queryCertificateInfo(int queryType, 
                                   int authenticationToken) 
 throws CommunicationException, LicenseCertificateException,
 LicenseClientException, ResourceUnavailableException 

Returns the various types of license certificate information associated with this license client object

Parameters:

queryType - a value which identifies the information to be returned

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

When queryType=XSLM_QUERY_PUBLISHER_INFO, the data element PUBLISHER_SECTION, if present, followed by the data element PUBLISHER_USE, if present.

When queryType=XSLM_QUERY_CUST_DEF_INFO, the data element CUSTOMER_ASSIGNED_APPL_INFO, if present.

When queryType=XSLM_QUERY_CERTIFICATE, the data element CERTIFICATE.

When queryType=XSLM_QUERY_CERT_RELATED_INFO, the data element CERTIFICATE_RELATED_INFORMATION

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void record(long counterIdentifier,
                   float counter,
                   int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Informs the license system about a metering activity in progress

Parameters:

counterIdentifier - the identifier of one of the 8 different counters (defined within the license certificate)

counter - the value of the number of units the license system should add to or subtract from the total count

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public void releaseLicense(long units,
                          int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Releases some or all license units associated with this instance of the license client

Parameters:

units - number of license units to be released

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                          String namedUser,
                          int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

namedUser - the named user for which license units are being requested

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                          long confirmTime,
                          int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

confirmTime - elapsed time (in seconds) whithin which the license system may expect the next confirm.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

Requests the license system for specified number of units licenses

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

namedUser - the named user for which license units are being requested

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

units - number of license units to be requested

forceNumber - whether or not a lower number of license units than that specified should be granted

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

public long requestLicense(PublicKey publicKey,
                          long units,
                          boolean forceNumber,
                          int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

Requests the license system for the specified number of license units

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

units - number of license units to be requested

forceNumber - whether or not a lower number of license units than that specified should be granted

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected final void init(Session session,
                         String publisherID,
                         long productID,
                         long versionID,
                         long featureID)

Initializes the LicenseBroker object returned by either a getBasicApplicationClientInstance or getAdvancedApplicationClientInstance method invocation.

Parameters:

session - the session this LicenseBroker object is associated with

publisherID - the identifier of the software publisher

productID - the identifier of the product

versionID - the identifier of the version

featureID - the identifier of the feature

 protected abstract void engineReleaseLicense() 
throws CommunicationException, LicenseCertificateException, LicenseClientException, ResourceUnavailableException

SPI: Releases the licenses associated with this instance of the license client

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long engineRequestLicense(PublicKey publicKey)
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Requests the license system for default number of units licenses (as specified within a license certificate).

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract void engineConfirm(long confirmTime,
                                     int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Confirms that a license is currently in use.

Parameters:

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract String engineGetLicensingSystemPublisherID() 
 throws LicenseClientException

SPI: Returns the licensing system publisher identifier of this LicenseBroker object. It may be used to determine how to calculate the digital signature required to authenticate the licensing system itself.

Returns:

the licensing system publisher identifier of this LicenseBrokerObject.

Throws: LicenseClientException

if a generic license client error occurs

protected abstract byte[] engineGetAuthenticationSignature() 
 throws LicenseClientException

SPI: Returns the digital signature created by the licensing system from the input and output parameters and the authorization token.

Returns:

the digital signature created by the licensing system.

Throws: LicenseClientException

if a generic license client error occurs

protected abstract void engineLogMessage(String message,
                                        int authenticationToken)
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Logs and application-specified text message into license system's log.

Parameters:

message - the text string of the message, it can be of any length; however, a licensing system is not required to accept more than 4096 bytes.

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long[] engineQueryFunctionalTowers() 
 throws CommunicationException, LicenseClientException,
 ResourceUnavailableException

SPI: Returns the maximum API specification level supported by all license servers in the licensing system.

Returns:

the maximum API specification level supported by all license servers in the licensing system

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract byte[] engineQueryCertificateInfo(int queryType, 
                              int authenticationToken)
 throws CommunicationException, LicenseCertificateException,
 LicenseClientException, ResourceUnavailableException

SPI: Returns the various types of license certificate information associated with this license client object

Parameters:

queryType - a value which identifies the information to be returned

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

When queryType=XSLM_QUERY_PUBLISHER_INFO, the data element PUBLISHER_SECTION, if present, followed by the data element PUBLISHER_USE, if present.

When queryType=XSLM_QUERY_CUST_DEF_INFO, the data element CUSTOMER_ASSIGNED_APPL_INFO, if present.

When queryType=XSLM_QUERY_CERTIFICATE, the data element CERTIFICATE.

When queryType=XSLM_QUERY_CERT_RELATED_INFO, the data element CERTIFICATE_RELATED_INFORMATION

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract void engineRecord(long counterIdentifier,
                                    float counter,
                                    int authenticationToken) 
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Informs the license system about a metering activity in progress

Parameters:

counterIdentifier - the identifier of one of the 8 different counters (defined within the license certificate)

counter - the value of the number of units the license system should add to or subtract from the total count

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract void engineReleaseLicense(long units,
                                            int authenticationToken)
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Releases some or all license units associated with this instance of the license client

Parameters:

units - number of license units to be released

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

protected abstract long engineRequestLicense(PublicKey publicKey,
                                            String namedUser,
                                            long confirmTime,
                                            long units,
                                            boolean forceNumber,
                                            int authenticationToken)
 throws CommunicationException, InvalidParameterException,
 LicenseCertificateException, LicenseClientException,
 ResourceUnavailableException

SPI: Requests the license system for the specified number of units licenses.

Parameters:

publicKey - the software publisher public key. Used to confirm authenticity of a license certificate. The value passed must match the value of the publisher's public key contained in the license certificate.

namedUser - the named user for which license units are being requested

confirmTime - elapsed time (in seconds) whithin which the liscense system may expect the next confirm.

units - number of license units to be requested

forceNumber - whether or not a lower number of license units than that specified should be granted

authenticationToken - a 32-bit arbitrary value created by the application and used as part of the licensing system authentication process

Returns:

number of license units granted

Throws: CommunicationException

if a communication error occurs between the license client and the license server

Throws: InvalidParameterException

if a parameter passed to a method is invalid

Throws: LicenseCertificateException

if the requested method cannot be completed on any license crtificate

Throws: LicenseClientException

if a generic license client error occurs

Throws: ResourceUnavailableException

if a resource required to execute the requested method is not available

java.lang.Object
   |
   +----org.opengroup.xslm.LicenseUseManagement

public final class LicenseUseManagement

extends Object

This class centralizes all License Use Management properties and common methods. One of its primary uses is to manage License System Publishers.

public static int insertPublisherAt(Publisher publisher,
                                   int position)

Adds a new publisher, at a specified position. The position is the preference order in which publishers are chosen when no specific publisher is requested. Note that it is not guaranteed that this preference will be respected. The position is 1-based, that is, 1 is most preferred, followed by 2, and so on. Sometimes it will be legal to add a publisher, but only in the last position, in which case the position argument will be ignored.

A publisher cannot be added if it is already installed.

Parameters:

publisher - the publisher to be added.

position - the preference position that the caller would like for this publisher.

Returns:

the actual preference position in which the publisher was added, or -1 if the publisher was not added because it is already installed.

See Also:

getPublisher, removePublisher

public static int addPublisher(Publisher publisher)

Adds a publisher to the next position available.

Parameters:

publisher - the publisher to be added.

Returns:

the preference position in which the publisher was added, or -1 if the publisher was not added because it is already installed.

See Also:

getPublisher, removePublisher

public static void removePublisher(String name)

Removes the publisher with the specified name. This method returns silently if the publisher is not installed.

Parameters:

name - the name of the publisher to remove.

See Also:

getPublisher, addPublisher

public static Publisher[] getPublishers()

Returns all publishers currently installed.

Returns:

an array of all publishers currently installed.

public static Publisher getPublisher(String name)

Returns the publisher installed with the specified name, if any. Returns null if no publisher with the speicified name is installed.

Parameters:

name - the name of the publisher to get.

Returns:

the publisher of the specified name.

See Also:

removePublisher, addPublisher

public static String getProperty(String key)

Gets a licenseUseManagement property.

Parameters:

key - the key of the property being retrieved.

Returns:

the value of the licenseUseManagement property corresponding to key.

public static void setProperty(String key,
                              String datum)

Sets a licenseUseManagement property.

Parameters:

key - the name of the property to be set.

datum - the value of the property to be set.

java.lang.Object
   |
   +----java.util.Dictionary
           |
           +----java.util.Hashtable
                   |
                   +----java.util.Properties
                           |
                           +----org.opengroup.xslm.Publisher

public abstract class Publisher

extends Properties This class represents a "License System Publisher", publisher for short, for the Java XSLM API. A Publisher implements the Base functional set of Java XSLM and some or all functional towers.

Each Publisher has a name and a version number, and is configured in each runtime it is installed in.

public double getVersion()

Returns the version number for this publisher.

Returns:

the version number for this publisher.

public String getInfo()

Returns a human-readable description of the publisher and its services. This may return an HTML page, with relevant links.

Returns:

a description of the publisher and its services.

public String toString()

Returns a string with the name and the version number of this publisher.

Returns:

the string with the name and the version number for this publisher.

Overrides:

toString in class Hashtable

java.lang.Object
   |
   +----org.opengroup.xslm.Session

public abstract class Session

extends Object This Session class is used to establish a reference which is used to keep track of composite licensing activities as a whole. A session may include licenses for products from one or more publishers.

Like other classes in org.opengroup.xslm, the Session class has two major components:

Session API (Application Program Interface)

This is the interface of methods called by applications needing session objects to call the AdvancedApplicationClient methods. The API consists of all public methods.

Session SPI (Service Provider Interface)

This is the interface implemented by licensing system publishers that supply specific license use management packages. It consists of all methods whose names are prefixed by engine. Each such method is called by a correspondingly-named public API method. For example, the engineEnd method is called by the end method. The SPI methods are abstract; publishers must supply a concrete implementation.

Thus, there are two ways to request a Session object: by not specifying any parameter, or by specifying a package publisher.

If no parameter is specified, the system will determine if there is an implementation of the requested session object available in the environment, and if there is more than one, if there is a preferred one.

If a package publisher is specified, the system will determine if there is an implementation of the session object in the package requested, and throw an exception if there is not.

protected static final int UNINITIALIZED

Possible state value, signifying that this session object has not yet been initialized.

protected static final int STARTED

Possible state value, signifying that this session object has been started.

protected static final int STOPPED

Possible state value, signifying that this session object has been stopped.

state

protected int state

Current state of this session object.

public static Session getInstance(String publisher) 
 throws NoSuchPublisherException, NoSuchAPILevelException

Generates a Session object as supplied from the specified publisher, if a Session subclass is available from the provider.

Parameters:

publisher - the name of the publisher.

Returns:

the new Session object.

Throws: NoSuchAPILevelException

if the Session subclass is not available in the package supplied by the requested publisher.

Throws: NoSuchPublisherException

if the publisher is not available in the environment.

See Also:

Publisher

public final void begin()

Starts a session to keep track of composite licensing activity

public final void end()

Terminates a session established by a begin method invocation

public final String getHandle()

protected abstract void engineBegin()

SPI: Starts a session to keep track of composite licensing activity

protected abstract void engineEnd()

SPI: Terminates a session established by a engineBegin method invocation

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----org.opengroup.xslm.CommunicationException

public class CommunicationException

extends Exception This exception is thrown when a communication error occurrs between the LicenseAgent and a license server.

public CommunicationException(String msg)

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----java.lang.RuntimeException
                           |
                           +----java.lang.IllegalArgumentException
                                   |
                                   +----org.opengroup.xslm.InvalidParameterException

public class InvalidParameterException

extends IllegalArgumentException This exception is thrown when an invalid parameter is passed to a method.

public InvalidParameterException()

Constructs an InvalidParameterException with no detail message. A detail message is a String that describes this particular exception.

 public InvalidParameterException(String msg)

Constructs an InvalidParameterException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

msg - the detail message.

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----org.opengroup.xslm.LicenseCertificateException

public class LicenseCertificateException

extends Exception This exception is thrown when the requested method cannot be completed on any of the license certificates available, or to a particular license certificate if the application client is already bound to one.

public LicenseCertificateException(String msg)

Constructs a LicenseCertificateException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

msg - the detail message.

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----org.opengroup.xslm.LicenseClientException

public class LicenseClientException

extends Exception This exception is thrown when a generic AdvancedApplicationClient or BasicApplicationClient error occurs, as when a releaseLicense method is called before calling a requestLicense method.

public LicenseClientException(String msg)

Constructs a LicenseClientException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

msg - the detail message.

public class NoSuchAPILevelException

extends Exception This exception is thrown when the requested API level is not available in the environment.

public NoSuchAPILevelException()

Constructs a NoSuchAPILevelException with no detail message. A detail message is a String that describes this particular exception.

public NoSuchAPILevelException(String msg)

Constructs a NoSuchAPILevelException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

msg - the detail message.

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----org.opengroup.xslm.NoSuchPublisherException

public class NoSuchPublisherException

extends Exception This exception is thrown when a particular License System Publisher is requested but is not available in the environment.

public NoSuchPublisherException(String msg)

Constructs a NoSuchPublisherException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

msg - the detail message.

java.lang.Object
   |
   +----java.lang.Throwable
           |
           +----java.lang.Exception
                   |
                   +----org.opengroup.xslm.ResourceUnavailableException

public class ResourceUnavailableException

extends Exception This exception is thrown when a resource required to execute the requestedp method is not available in the environment.

ailableException(String msg)

Constructs a ResourceUnavailableException with the specified detail message. A detail message is a String that describes this particular exception.

Parameters:

msg - the detail message.