com.cleo.lexicom.external

Interface ILicenser

public interface ILicenser

Establishes an interface to VersaLex's Licenser. Refer to ILexiCom.getLicenser().

Methods provided allow for registration/licensing of installation.

Method Summary

Modifier and Type	Method and Description
void	addLogListener(LexiComLogListener l) Add a listener for log events
void	cancel() Cancels a active registration or licensing session NOTE: Required step if query() method successfully called but next step not taken
void	license(ILicense license) Acquire/apply permanent license from the Cleo license server
ILicense	licenseFile(java.lang.String path, boolean apply) Read the license key file
ILicense	licenseQuery(SystemInfo systemInfo) Query the Cleo license server for the available permanent license information NOTE: Required step before license()
void	register(RegistrationInfo registrationInfo) Register and acquire/apply a temporary license from the Cleo license server NOTE: Multiple registrations on the same serial number are possible and a temporary license will continue to be returned with each.
RegistrationInfo	registrationQuery(java.lang.String serialNumber) Query the Cleo license server for current registration given the serial number NOTE: Required step before register()
void	removeLogListener(LexiComLogListener l) Remove a listener for log events
void	unregister() Unregister either temporary or permanent license from the Cleo license server NOTE: Only permanent license unregister actually communicates with Cleo license server

Method Detail

licenseFile

ILicense licenseFile(java.lang.String path,
                     boolean apply)
              throws java.lang.Exception

Read the license key file

Parameters:

path - path to the license key file

apply - if true, license key file will be applied if valid

Returns:

the license contained in the file

Throws:

java.lang.Exception - if the license key file is invalid or does not match the current host ID or serial number

registrationQuery

RegistrationInfo registrationQuery(java.lang.String serialNumber)
                            throws java.lang.Exception

Query the Cleo license server for current registration given the serial number

NOTE: Required step before register()

Parameters:

serialNumber - the Cleo product serial number

Returns:

the current registration information (contact/company).

Throws:

java.lang.Exception - if the serial number is invalid or if commnunication with Cleo license server should fail

register

void register(RegistrationInfo registrationInfo)
       throws java.lang.Exception

Register and acquire/apply a temporary license from the Cleo license server

NOTE: Multiple registrations on the same serial number are possible and a temporary license will continue to be returned with each. However, once a permanent license is acquired (licenseQuery() and license), only one installation can be registered and a temporary license can no longer be acquired.

Parameters:

registrationInfo - Potentially updated registration information from registrationQuery() all but extension and address2 required

Throws:

java.lang.Exception - if required registration info missing or if communication with Cleo license server should fail

licenseQuery

ILicense licenseQuery(SystemInfo systemInfo)
               throws java.lang.Exception

Query the Cleo license server for the available permanent license information

NOTE: Required step before license()

Parameters:

systemInfo - optional additional system information; can be null

Returns:

the available license (not yet applied); null if available license matches current license

Throws:

java.lang.Exception - if not currently registered or if communication with Cleo license server should fail

license

void license(ILicense license)
      throws java.lang.Exception

Acquire/apply permanent license from the Cleo license server

Parameters:

license - the available license from licenseQuery()

Throws:

java.lang.Exception - if available license does not differ from current license or if communication with Cleo license server should fail

cancel

void cancel()
     throws java.lang.Exception

Cancels a active registration or licensing session

NOTE: Required step if query() method successfully called but next step not taken

Throws:

java.lang.Exception

unregister

void unregister()
         throws java.lang.Exception

Unregister either temporary or permanent license from the Cleo license server

NOTE: Only permanent license unregister actually communicates with Cleo license server

Throws:

java.lang.Exception - if not current licensed or if communication with Cleo license server should fail

addLogListener

void addLogListener(LexiComLogListener l)
             throws java.lang.Exception

Add a listener for log events

Parameters:

l - a LexiComLogListener that will be notified when log events have occurred

Throws:

java.lang.Exception

removeLogListener

void removeLogListener(LexiComLogListener l)
                throws java.lang.Exception

Remove a listener for log events

Parameters:

l - the LexiComLogListener to remove

Throws:

java.lang.Exception