Package com.stepover.opensignatureapi.bridge

Interface LibraryBridgeInterface

All Known Implementing Classes:

AppletBridge, NativeBridge, WindowsBridge

public interface LibraryBridgeInterface

the libray bridge interface that defines all functionality needed to communicate with the signature pads

Method Summary

Modifier and Type	Method	Description
void	activateEmulationMode()
int	addCertificateSignature(Rectangle signatureRectangle, java.lang.String name, java.lang.String reason, java.lang.String location, int page, boolean showNameAndDate, java.awt.image.BufferedImage signatureImage, SoDeviceConfiguration deviceConfiguration)
int	addSignature(Rectangle signatureRectangle, java.lang.String name, java.lang.String reason, int page, boolean showNameAndDate)
void	closeDoc()
void	finalizeLibraries()
com.stepover.opensignatureapi.jna.signapi.SignapiLibrary.TSignApi4Dll_OnGetAesKey	getAesKeyCallback()
com.stepover.opensignatureapi.jna.sopad.BioData	getBioData()
java.lang.String	getDeviceName()
byte[]	getDevicePublicKey()
java.awt.Dimension	getDisplayPixelSize()
Dimension	getDisplaySize()
byte[]	getEncryptedAesKey()
java.lang.String	getFirmwareVersion()
int	getNextSignatureFrame()
byte	getPressedLcdButtonCode(SoSigningDevice signingDevice)
java.lang.String	getSerialNumber()
java.awt.image.BufferedImage	getSignatureBitmap()
SoDeviceConfiguration.SignatureButtonsListener	getSignatureButtonsListener()
java.awt.image.BufferedImage	getSignImage()
java.lang.String[]	getSigningDevices()
boolean	initDevice()
boolean	initialize(boolean withSignApi)
boolean	loadDoc(java.io.File file)
boolean	readCert(java.io.InputStream inputStream)
boolean	readLicense(java.io.InputStream inputStream)
void	resetDevice()
boolean	saveDoc(java.io.File file)
void	setButtonsDuringSignatureVisible(boolean visible, boolean signInDocMode)
void	setCallbacks()
void	setCertStr(java.lang.String certStr)
void	setDisplayRotation(int displayRotation)
void	setDocViewSignatureImage(java.awt.image.BufferedImage image, int page, int pageCount, SignatureRectangle rectangle)
void	setLcdButtonState(int buttonCode, boolean buttonState)
void	setPad(SigningDevice signingDevice)
void	setPreliminaryDocHash(byte[] hash)
void	setSignatureButtonsListener(SoDeviceConfiguration.SignatureButtonsListener signatureButtonsListener)
void	setSignatureCancelCallback(SoDeviceConfiguration.SignatureCancelCallback signatureCancelCallback)
void	setSignatureColor(Color color)
void	setSignatureHashCallback(SoDeviceConfiguration.SignatureHashCallback signatureHashCallback)
void	setSignatureImage(java.awt.image.BufferedImage image)
void	setSignatureRectangle(int x1, int y1, int x2, int y2, int color)
void	setSignatureRepeatCallback(SoDeviceConfiguration.SignatureRepeatCallback signatureRepeatCallback)
boolean	setSignDocMode(Rectangle signatureRectangle, int page)
int	setSignImage(java.awt.image.BufferedImage bufferedImage, boolean delta)
void	setSignImageBW(java.awt.image.BufferedImage bufferedImage)
boolean	showImageInDocViewMode(java.awt.image.BufferedImage image, int currentPage, int pageCount, boolean showStartSIgnButton)
boolean	startCapture(boolean bCheckPad, boolean bAutostartSearching, boolean bShowConnectionWinIfAutostart, boolean bReadAndSaveInRegistry, java.lang.String signingDeviceIdentifier)
boolean	startCapture(boolean bCheckPad, boolean bAutostartSearching, boolean bShowConnectionWinIfAutostart, boolean bReadAndSaveInRegistry, SigningDevice signingDevice)
boolean	startCapture(SoSigningDevice signingDevice, SignatureContext context, MetaInfoField[] metaInfoFields)
boolean	stopCapture(boolean switchToManufacturerLogo)
void	stopDocViewMode(SoSigningDevice signingDevice)

Method Detail

initialize

boolean initialize(boolean withSignApi)

setSignatureColor

void setSignatureColor(Color color)

setLcdButtonState

void setLcdButtonState(int buttonCode,
                       boolean buttonState)

showImageInDocViewMode

boolean showImageInDocViewMode(java.awt.image.BufferedImage image,
                               int currentPage,
                               int pageCount,
                               boolean showStartSIgnButton)

getPressedLcdButtonCode

byte getPressedLcdButtonCode(SoSigningDevice signingDevice)

stopDocViewMode

void stopDocViewMode(SoSigningDevice signingDevice)

setCallbacks

void setCallbacks()

setSignatureHashCallback

void setSignatureHashCallback(SoDeviceConfiguration.SignatureHashCallback signatureHashCallback)

setSignatureRepeatCallback

void setSignatureRepeatCallback(SoDeviceConfiguration.SignatureRepeatCallback signatureRepeatCallback)

setSignatureCancelCallback

void setSignatureCancelCallback(SoDeviceConfiguration.SignatureCancelCallback signatureCancelCallback)

setSignatureButtonsListener

void setSignatureButtonsListener(SoDeviceConfiguration.SignatureButtonsListener signatureButtonsListener)

getSignatureButtonsListener

SoDeviceConfiguration.SignatureButtonsListener getSignatureButtonsListener()

setButtonsDuringSignatureVisible

void setButtonsDuringSignatureVisible(boolean visible,
                                      boolean signInDocMode)

closeDoc

void closeDoc()

loadDoc

boolean loadDoc(java.io.File file)

setSignDocMode

boolean setSignDocMode(Rectangle signatureRectangle,
                       int page)

setSignatureImage

void setSignatureImage(java.awt.image.BufferedImage image)
                throws OpenSignatureException

Throws:

OpenSignatureException

addSignature

int addSignature(Rectangle signatureRectangle,
                 java.lang.String name,
                 java.lang.String reason,
                 int page,
                 boolean showNameAndDate)

addCertificateSignature

int addCertificateSignature(Rectangle signatureRectangle,
                            java.lang.String name,
                            java.lang.String reason,
                            java.lang.String location,
                            int page,
                            boolean showNameAndDate,
                            java.awt.image.BufferedImage signatureImage,
                            SoDeviceConfiguration deviceConfiguration)
                     throws OpenSignatureException

Throws:

OpenSignatureException

saveDoc

boolean saveDoc(java.io.File file)

getSigningDevices

java.lang.String[] getSigningDevices()

getDisplayPixelSize

java.awt.Dimension getDisplayPixelSize()

getDisplaySize

Dimension getDisplaySize()

getFirmwareVersion

java.lang.String getFirmwareVersion()

getDeviceName

java.lang.String getDeviceName()

getSerialNumber

java.lang.String getSerialNumber()

finalizeLibraries

void finalizeLibraries()

getSignatureBitmap

java.awt.image.BufferedImage getSignatureBitmap()

readCert

boolean readCert(java.io.InputStream inputStream)

readLicense

boolean readLicense(java.io.InputStream inputStream)

activateEmulationMode

void activateEmulationMode()

startCapture

boolean startCapture(boolean bCheckPad,
                     boolean bAutostartSearching,
                     boolean bShowConnectionWinIfAutostart,
                     boolean bReadAndSaveInRegistry,
                     SigningDevice signingDevice)

startCapture

boolean startCapture(SoSigningDevice signingDevice,
                     SignatureContext context,
                     MetaInfoField[] metaInfoFields)

startCapture

boolean startCapture(boolean bCheckPad,
                     boolean bAutostartSearching,
                     boolean bShowConnectionWinIfAutostart,
                     boolean bReadAndSaveInRegistry,
                     java.lang.String signingDeviceIdentifier)

stopCapture

boolean stopCapture(boolean switchToManufacturerLogo)

getNextSignatureFrame

int getNextSignatureFrame()

setDocViewSignatureImage

void setDocViewSignatureImage(java.awt.image.BufferedImage image,
                              int page,
                              int pageCount,
                              SignatureRectangle rectangle)

setPad

void setPad(SigningDevice signingDevice)

initDevice

boolean initDevice()

resetDevice

void resetDevice()

setDisplayRotation

void setDisplayRotation(int displayRotation)

getSignImage

java.awt.image.BufferedImage getSignImage()
                                   throws OpenSignatureException

Throws:

OpenSignatureException

setSignImage

int setSignImage(java.awt.image.BufferedImage bufferedImage,
                 boolean delta)

setSignImageBW

void setSignImageBW(java.awt.image.BufferedImage bufferedImage)

setSignatureRectangle

void setSignatureRectangle(int x1,
                           int y1,
                           int x2,
                           int y2,
                           int color)

getBioData

com.stepover.opensignatureapi.jna.sopad.BioData getBioData()

setCertStr

void setCertStr(java.lang.String certStr)

getAesKeyCallback

com.stepover.opensignatureapi.jna.signapi.SignapiLibrary.TSignApi4Dll_OnGetAesKey getAesKeyCallback()

getEncryptedAesKey

byte[] getEncryptedAesKey()

setPreliminaryDocHash

void setPreliminaryDocHash(byte[] hash)

getDevicePublicKey

byte[] getDevicePublicKey()