J-API Documentation
J-API Version 3.2.8
This software is the confidential and proprietary information of SOFTPRO ("Confidential Information"). You shall not disclose such Confidential Information and shall use it only in accordance with the terms of the license agreement you entered into with SOFTPRO (see License Agreement).
SignWare J-API
The package de.softpro.signware implements a java wrapper to access SignWare objects from a java virtual machine. The wrapper uses jni to access the core SignWare objects. These objects are accessible from the java environment:- de.softpro.signware.SPAcquire implements a tablet acquiry without GUI
- de.softpro.signware.SPAcquire2 extends de.softpro.signware.SPAcquire and passes virtual and hardware button events as javax.swing.Action notifications, similar to class de.softpro.signware.SPGuiAcqu
- de.softpro.signware.SPBackgroundObjects represents a container for tablet background descriptors
- de.softpro.signware.SPBitmap represents the serialized bitmap (static image) object
- de.softpro.signware.SPCleanParameter represents parameters for static image cleaning
- de.softpro.signware.SPCompare represents the signature compare object
- de.softpro.signware.SPFlatFile represents a serialized reference, signature or template
- de.softpro.signware.SPGuiAcqu implements a tablet acquiry with GUI. SPGuiAcqu extends a jva.awt.Container and supports javax.swing.Action notifications
- de.softpro.signware.SPImage represents a static signature object with additional image processing capabilities
- de.softpro.signware.SPJGuiAcqu implements a tablet acquiry with GUI. SPJGuiAcqu implements native SPGuiAcqu objects without java-specific extensions
- de.softpro.signware.SPJGuiContainer implements a container of one or more Signware GUI objects
- de.softpro.signware.SPJGuiDisp displays a signature or image
- de.softpro.signware.SPJGuiDyn displays dynamic features of a signature
- de.softpro.signware.SPLicenseClient declares functions to load a license from a SOFTPRO license service using a registration code (deprecated)
- de.softpro.signware.SPPropertyMap represents a property container
- de.softpro.signware.SPReference represents a reference signature
- de.softpro.signware.SPScanner represents a scanner device
- de.softpro.signware.SPScannerEnum enumerates connected scanner devices
- de.softpro.signware.SPScannerEventListener represents a scanner device event listener
- de.softpro.signware.SPSignature represents a signature
- de.softpro.signware.SPSignware implements base initialization and static methods
- de.softpro.signware.SPSignwareException returns signware results
- de.softpro.signware.SPSignwareObject implements the baseobject to interface with the native SignWare modules
- de.softpro.signware.SPSmartcard represents a smartcard
- de.softpro.signware.SPSmartcardDriver interfaces with smartcard readers
- de.softpro.signware.SPSmartcardDriverDialog implements a simple dialog to select one smartcard reader
- de.softpro.signware.SPTablet represents a tablet device
- de.softpro.signware.SPTabletEnum represents a tablet enumeration list
- de.softpro.signware.SPTabletEventListener raw tablet data listener interface
- de.softpro.signware.SPTabletEventListener2 raw tablet data listener interface (with timestamps)
- de.softpro.signware.SPTeller interfaces with SignBase®
- de.softpro.signware.SPTellerImage converts SignBase Teller and SignWare references / signatures / images
- de.softpro.signware.SPTemplate represents a reference in compressed form
- de.softpro.signware.SPTemplateOption represents an optional data sets for templates
- de.softpro.signware.SPTicket represents a license for a specific operation (deprecated)
- de.softpro.signware.SPWeightedFrame represents a rectangle with assigned weight used in static cleaning
All classes are packed into SPSignware_32.jar.
Major differences between java and core SignWare implementation:
- the core implementation of all GUI objects is based on operating system native windows, thus the core implementation is restricted to heavyweight java components (components that will actually create a native window).
- the acquiry panel SPGuiAcqu extends the java.awt.Panel class, which may result in poor layout in combination with swing (lightweight) components.
- some functionality of the acquiry panel might return errors as long as the associated native window was not created.
- the java wrappers throw SPSignwareException on errors, while the core implementation returns an error code
Installation
- Please add SPSignware_32.jar to your classpath if you want to access the J-API package.
- You must copy (for architecture linux-i386) c-api/linux-i386/*.so and c-api/linux-i386/*.so.* to /usr/lib or (for architecture linux-x86_64) c-api/linux-x86_64/*.so and c-api/linux-x86_64/*.so.* to /usr/lib64.
- Don't forget to register the license.
FAQs Frequently asked questions
I see an exception message "SPSignwareException -5, Unsupported Function whenever a XSPGuiAcqu object is instantiated".This exception will be thrown when the java runtime modules are not accessible from the native modules. The native modules try to load jawt.dll, which must be accessible from the path variable.
Error handling and Debugging
An error stream handler is provided in class SPSignware. The method SPSignware.setLogStream allows to define a log stream. The entries SPSignware.println and SPSignware.printStackTrace both write to the stream.All SignWare classes will write errors to the stream. No output will be written as long as you do not provide for a stream.
Please also see the section SignWare C-API (Core) Error handling and Debugging.