de.softpro.signware.SPLicenseClient Class Reference

Inheritance diagram for de.softpro.signware.SPLicenseClient:

List of all members.

---

Detailed Description

a representation of a LicenseClient

Note:

SignWare now uses license keys, usage of license files is deprecated. The following description only applies if you still use license files.

SPLicenseClient connects with a license service to load and install a license locally.

Connection parameters are typically loaded from the registry and may be overruled by the api functions, see setProperty.

Please read section sec_LicenseClient for more information about installing licenses from a Kofax license service

Deprecated:

Please use a license key.

Operating Systems:

Windows (Win32)

Public Member Functions
String	getDetailError (String strLanguage) throws SPSignwareException
	Query a readable description of the last error.
String	getDetailError (String strLanguage, int iDetail) throws SPSignwareException
	Query a readable description of the last error.
int	getLastDetail ()
	Query the detailed error code of the last request or requestGui method.
String	getProperty (String strName) throws SPSignwareException
	Query a String property.
int	getPropertyInt (String strName) throws SPSignwareException
	Query an int property.
void	guiRequest (java.awt.Window parent, String strLanguage) throws SPSignwareException
	Get a license file from the Kofax license service with GUI.
void	guiRequest (java.awt.Panel parent, String strLanguage) throws SPSignwareException
	Get a license file from the Kofax license service with GUI.
void	request (String strRegistrationCode) throws SPSignwareException
	Get a license file from the Kofax license service without GUI.
void	setProperty (String strName, int iValue) throws SPSignwareException
	Set an integer property.
void	setProperty (String strName, String strValue) throws SPSignwareException
	Set a String property.
	SPLicenseClient (SPLicenseClient clone) throws SPSignwareException
	Clone a license client object.
	SPLicenseClient () throws SPSignwareException
	Create a license client object.

---

Constructor & Destructor Documentation

de.softpro.signware.SPLicenseClient.SPLicenseClient (   )  throws SPSignwareException

Create a license client object. Exceptions: SPSignwareException  on error SP_MEMORYERR out of memory Deprecated: Please use a license key. Operating Systems: Windows (Win32) See also: SPLicenseClientCreate

de.softpro.signware.SPLicenseClient.SPLicenseClient (  SPLicenseClient  clone  )  throws SPSignwareException

Clone a license client object. Deprecated: Please use a license key. Parameters: clone  [i] a license client object that will be cloned Exceptions: SPSignwareException  on error SP_MEMORYERR out of memory Operating Systems: Windows (Win32) See also: SPLicenseClientClone

---

Member Function Documentation

String de.softpro.signware.SPLicenseClient.getDetailError (  String  strLanguage  )  throws SPSignwareException

Query a readable description of the last error. Note: this is a convenience function which passes getLastDetail() to determine the error description Deprecated: Please use a license key. Parameters: strLanguage  [i] two digit language descriptor, "de" for German, "en" for English Returns: String a readable error description Exceptions: SPSignwareException  on error See also: SPLicenseClientGetDetailError Operating Systems: Windows (Win32)

String de.softpro.signware.SPLicenseClient.getDetailError (  String  strLanguage, int  iDetail )  throws SPSignwareException

Query a readable description of the last error. Note: this is a convenience function which passes getLastDetail() to determine the error description Deprecated: Please use a license key. Parameters: strLanguage  [i] two digit language descriptor, "de" for German, "en" for English iDetail  [i] the detailed error code, see getLastDetail() Returns: String a readable error description Exceptions: SPSignwareException  on error See also: SPLicenseClientGetDetailError Operating Systems: Windows (Win32)

int de.softpro.signware.SPLicenseClient.getLastDetail (   )

Query the detailed error code of the last request or requestGui method. Deprecated: Please use a license key. Returns: int the detailed error code

String de.softpro.signware.SPLicenseClient.getProperty (  String  strName  )  throws SPSignwareException

Query a String property. Please read sec_SPLC_Properties for details on the evaluated properties Deprecated: Please use a license key. Parameters: strName  [i] name of the property Returns: String, value of the property Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32) See also: setProperty

int de.softpro.signware.SPLicenseClient.getPropertyInt (  String  strName  )  throws SPSignwareException

Query an int property. Please read sec_SPLC_Properties for details on the evaluated properties Deprecated: Please use a license key. Parameters: strName  [i] name of the property Returns: int, value of the property Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32) See also: setProperty

void de.softpro.signware.SPLicenseClient.guiRequest (  java.awt.Window  parent, String  strLanguage )  throws SPSignwareException

Get a license file from the Kofax license service with GUI. Popup a multipage dialog to enter registration key and optional proxy settings The dialog will be translated to the according language if the translation file SPRegLic_{language}.xml can be loaded in the path variable. Note: URL of the license service and proxy settings are read from the registry and may be overruled by setPropertyInt and setPropertyString A detailed error result will be saved in getLastDetail, use getDetailError to query a readable form of the error. Deprecated: Please use a license key. Parameters: parent  [i] the parent GUI object strLanguage  [i] a two character language code, "de" for German, "en" for English or a two-character language code, which will be used to read the translation file SPRegLic_{pszLanguage}.xml. The language defaults to "en" if the translation file cannot be found or read. Exceptions: SPSignwareException  on error SP_CANCELERR the operation was cancelled by the user SP_PARAMERR an invalid parameter was passed SP_OPENERR the service could not be accessed, check piResult for details SP_LICENSEERR the license could not be loaded, check piResult for details SP_LINKLIBRARYERR ssome modules could not be loaded or are missing See also: SPLicenseClientGuiRequest, sec_LicenseClient Operating Systems: Windows (Win32)

void de.softpro.signware.SPLicenseClient.guiRequest (  java.awt.Panel  parent, String  strLanguage )  throws SPSignwareException

Get a license file from the Kofax license service with GUI. Popup a multipage dialog to enter registration key and optional proxy settings The dialog will be translated to the according language if the translation file SPRegLic_{language}.xml can be loaded in the path variable. Note: URL of the license service and proxy settings are read from the registry and may be overruled by setPropertyInt and setPropertyString A detailed error result will be saved in getLastDetail, use getDetailError to query a readable form of the error. Deprecated: Please use a license key. Parameters: parent  [i] the parent GUI object strLanguage  [i] a two character language code, "de" for German, "en" for English or a two-character language code, which will be used to read the translation file SPRegLic_{pszLanguage}.xml. The language defaults to "en" if the translation file cannot be found or read. Exceptions: SPSignwareException  on error SP_CANCELERR the operation was cancelled by the user SP_PARAMERR an invalid parameter was passed SP_OPENERR the service could not be accessed, check piResult for details SP_LICENSEERR the license could not be loaded, check piResult for details SP_LINKLIBRARYERR ssome modules could not be loaded or are missing See also: SPLicenseClientGuiRequest, sec_LicenseClient Operating Systems: Windows (Win32)

void de.softpro.signware.SPLicenseClient.request (  String  strRegistrationCode  )  throws SPSignwareException

Get a license file from the Kofax license service without GUI. Note: URL of the license service and proxy settings are read from the registry and may be overruled by setPropertyInt and setPropertyString A detailed error result will be saved in getLastDetail, use getDetailError to query a readable form of the error. Deprecated: Please use a license key. Parameters: strRegistrationCode  [i] the registration code Exceptions: SPSignwareException  on error SP_CANCELERR the operation was cancelled by the user SP_PARAMERR an invalid parameter was passed SP_OPENERR the service could not be accessed, check piResult for details SP_LICENSEERR the license could not be loaded, check piResult for details SP_LINKLIBRARYERR ssome modules could not be loaded or are missing See also: SPLicenseClientRequest, sec_LicenseClient Operating Systems: Windows (Win32)

void de.softpro.signware.SPLicenseClient.setProperty (  String  strName, int  iValue )  throws SPSignwareException

Set an integer property. Please read sec_SPLC_Properties for details on the evaluated properties Deprecated: Please use a license key. Parameters: strName  [i] name of the property iValue  [i] value of the property Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32) See also: getPropertyInt

void de.softpro.signware.SPLicenseClient.setProperty (  String  strName, String  strValue )  throws SPSignwareException

Set a String property. Please read sec_SPLC_Properties for details on the evaluated properties Deprecated: Please use a license key. Parameters: strName  [i] name of the property strValue  [i] value of the property Exceptions: SPSignwareException  on error Operating Systems: Windows (Win32) See also: getProperty

---

The documentation for this class was generated from the following file:

• SPLicenseClient.java