de.softpro.signware.SPSignware Class Reference
List of all members.Detailed Description
Signware base class.This class will load the SignWare native code and provide for version and error handling.
- Note:
- SignWare requires a jvm version 1.5 or higher. To query the jvm version: open a command prompt and enter java -fullversion to see the jvm version)
The Java SDK does not create a log file or write any messages. Please use the SignWare logging feature for debugging purposes.
- Operating Systems:
- Windows (Win32), Linux (i386), Linux (x86_64), Android (ARMv7a), Darwin (x86_64)
Static Public Member Functions | |
static synchronized void | addLibraryPath (String strPath) throws SPSignwareException |
static void | closeSession (int iUsage, String strSession) throws SPSignwareException |
Inform license manager to close a session. | |
static int | daysLM () throws SPSignwareException |
Query how many days the license will be valid. | |
static byte[] | decodeBase64 (String strBase64) throws SPSignwareException |
Decode a Base64 String. | |
static String | encodeBase64 (byte[] bData) throws SPSignwareException |
Encode data to a Base64 String. | |
static long | getActualTime () throws SPSignwareException |
static String | getBrowserTicket (String strRequestUrl, SPTicket pTicket) throws SPSignwareException |
Create a Browser ticket. | |
static int | getBuild (int iVersion) |
Query the build version from a SignWare version number. | |
static long | getCurrentTime () throws SPSignwareException |
static String | getErrorString (int iError) |
Return an error code to a String. | |
static String | getInstallationCode () throws SPSignwareException |
Query the installation code. | |
static int | getMajor (int iVersion) |
Query the major version from a SignWare version number. | |
static int | getMinor (int iVersion) |
Query the minor version from a SignWare version number. | |
static String | getVersion (int iModule) throws SPSignwareException |
Query the version of Signware modules. | |
static boolean | isLoaded () |
Query if the native Signware modules could be loaded successfully. | |
static int | loadedModules () throws SPSignwareException |
Query which modules have been loaded. | |
static int | makeVersion (int iMajor, int iMinor, int iBuild) |
Convert minor, major and built to a SignWare version integer. | |
static int | moduleCount () |
Query the total number of modules that may be loaded. | |
static boolean | needTicket () throws SPSignwareException |
Query if the installed license requires Tickets. | |
static void | openSession (int iUsage, String strSession) throws SPSignwareException |
Inform license manager to open a new session. | |
static void | println (String strMessage) |
Debug output ... | |
static void | printStackTrace (Throwable th) |
Debug output ... | |
static void | setLicenseKey (byte[] bKey, String sProduct, String sVersion, byte[] bToken) throws SPSignwareException |
Initialize the license manager with a license key. | |
static void | setLM2 (int uiLmId1, int uiLmId2) throws SPSignwareException |
Initialize the license manager for using a license file. | |
static void | setLogStream (java.io.PrintStream str) |
Set the debug output stream. | |
static void | setTicket (SPTicket spTicket) throws SPSignwareException |
Pass a license ticket. | |
static void | viewLM (java.awt.Component c, String strOptions) throws SPSignwareException |
display license information | |
static void | viewLM (java.awt.Component c) throws SPSignwareException |
display license information | |
Static Public Attributes | |
static final int | JSDK = 1 |
Flag Signware native module is loaded. | |
static final int | JSPLM2 = 2 |
Flag Signware license manager module is loaded. | |
static final int | SP_AWT_LOADED = 0x40 |
Loaded external library jawt (java awt access). | |
static final int | SP_GRAPHICLIB_LOADED = 0x10 |
Loaded external image processing library. | |
static final int | SP_SDK_LOADED = 1 |
Loaded (myself) Library SDK. | |
Static Protected Member Functions | |
static synchronized int | isInitialized () throws SPSignwareException |
Static Protected Attributes | |
static int | iJSpLmVersion = 0x0 |
Static Package Functions | |
static void | lprintf (int iLvl, String aMsg) |
static void | lprintf1 (String aMsg) |
static void | lprintf2 (String aMsg) |
static void | lprintf3 (String aMsg) |
static void | lprintf4 (String aMsg) |
static void | lprintf5 (String aMsg) |
Static Package Attributes | |
static java.io.PrintStream | logger = null |
debug output stream |
Member Function Documentation
|
Append a path to the list of paths to load the native libraries
|
|
Inform license manager to close a session. This function is reserved for Kofax internal use.
|
|
Query how many days the license will be valid.
|
|
Decode a Base64 String.
|
|
Encode data to a Base64 String.
|
|
Query the current time as a long
|
|
Create a Browser ticket. The Kofax capture plugin will request a local license if the parameter Auth is omitted. The plugins will return an error if the parameter Auth is passed but does not contain a valid ticket. The created ticket is valid for the specified request URL only.
|
|
Query the build version from a SignWare version number.
|
|
Query the current time as a long The timestamp is included in a signature.
|
|
Return an error code to a String.
|
|
Query the installation code.
|
|
Query the major version from a SignWare version number.
|
|
Query the minor version from a SignWare version number.
|
|
Query the version of Signware modules.
|
|
|
|
Query if the native Signware modules could be loaded successfully. A return value true does not imply that additional modules such as compare engines were loaded successfully.
|
|
Query which modules have been loaded. There is no flag to indicate if SignWare is loaded. loadedModules() will throw an exception with error code SP_LINKLIBRARYERR if SignWare could not be loaded.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Convert minor, major and built to a SignWare version integer.
|
|
Query the total number of modules that may be loaded.
|
|
Query if the installed license requires Tickets. You must call setLM (if applicable) before you can query the license type.
|
|
Inform license manager to open a new session. This function is reserved for Kofax internal use.
|
|
Debug output ...
|
|
Debug output ...
|
|
Initialize the license manager with a license key. This must be the very first function called in SignWare, else the call will be ignored. A license key tells the License Manager which actions are allowed. You can use either a license key for SignWare or a license key for SignDoc SDK. Please contact your Kofax sales representative.
|
|
Initialize the license manager for using a license file.
This must be the very first function called in SignWare, else the call will be ignored.
|
|
Set the debug output stream.
|
|
Pass a license ticket. When using network license: you must pass the ticket before you can create any SignWare object (except for SPTicket). Usage of the ticket:
|
|
display license information The information displayed should be used when requesting a SignWare license.
|
|
display license information The information displayed should be used when requesting a SignWare license.
|
Member Data Documentation
|
|
|
Flag Signware native module is loaded.
|
|
Flag Signware license manager module is loaded.
|
|
debug output stream
|
|
Loaded external library jawt (java awt access).
|
|
Loaded external image processing library.
|
|
Loaded (myself) Library SDK.
|
The documentation for this class was generated from the following file: