com.so.net

Class SignApi

java.lang.Object

com.so.net.SignApi

public final class SignApi
extends Object

Can sign PDF documents in combination with signature devices.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignApi.Behaviour The behaviour of a signing process.
static class	SignApi.Crypto Has cryptography related functions.
static class	SignApi.Dialog Can present a dialog of the loaded document on the device.
static class	SignApi.Pdf Has PDF-related functions.
static class	SignApi.SigningUpdateEvent

Method Summary

Modifier and Type	Method and Description
static boolean	checkLicenseOfParentSoftware(String SoftwareName, String LicExtn, boolean isNextGenDevice, String CustomLicPath)
static Optional<String>	GetEventQueue() Gets the events and errors
static byte[]	GetPdfFromSignedXml()
static byte[]	GetSignedXml() Downloads the xml document.
static void	load(String searchPath) Loads the shared library for whose name starts with "SigSignAPI.WrapperNE".
static void	Sclose()
static boolean	setCustomtLicensePath(String path) Sets thepath where corpcode.lic is located.
static boolean	setLicense(String verifiedString) Sets the verified string.
static boolean	sign(SignApi.Pdf.SignatureField signatureField, SignApi.Pdf.SignatureInfo signatureInfo, SignApi.Behaviour behaviour) Performs a signing process with the chosen signature field.
static boolean	StartXmlSigning(String xmlDocumentPath) Signs a xmldocument which contains pdf and other info
static boolean	viewDocument(int pageNumber, SignApi.Behaviour.Zoom.Level zoomLevel, boolean startSignatureButtonEnabled) Displays the loaded document on the device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

load

public static void load(String searchPath)

Loads the shared library for whose name starts with "SigSignAPI.WrapperNE". Throws in case of error.

Sclose

public static void Sclose()

sign

public static boolean sign(SignApi.Pdf.SignatureField signatureField,
                           SignApi.Pdf.SignatureInfo signatureInfo,
                           SignApi.Behaviour behaviour)

Performs a signing process with the chosen signature field.

Parameters:

signatureField - The signature field to sign.

signatureInfo - Signature information such as the name of the signer.

behaviour - How to perform the signature.

Returns:

True in case of success. Documents can be loaded with SignApi.Pdf.loadPdf(byte[]). Devices can be searched and selected with DeviceApi.enumerateDevices() and DeviceApi.setDevice(com.so.net.DeviceApi.Device.Name). Use SignApi.Pdf.downloadPdf() to get the signed document.

viewDocument

public static boolean viewDocument(int pageNumber,
                                   SignApi.Behaviour.Zoom.Level zoomLevel,
                                   boolean startSignatureButtonEnabled)

Displays the loaded document on the device.

Parameters:

pageNumber - The page number.

zoomLevel - The zoom level.

startSignatureButtonEnabled - Whether the start signature button shall be enabled or disabled.

Returns:

True in case of success. Documents can be loaded with SignApi.Pdf.loadPdf(byte[]). Devices can be searched and selected with DeviceApi.enumerateDevices() and DeviceApi.setDevice(com.so.net.DeviceApi.Device.Name).

StartXmlSigning

public static boolean StartXmlSigning(String xmlDocumentPath)

Signs a xmldocument which contains pdf and other info

Parameters:

xmlDocumentPath - The path where the xmlDocument which contains pdf and other info is stored.

Returns:

True in case of success.

GetSignedXml

public static byte[] GetSignedXml()

Downloads the xml document.

Returns:

An empty array in case of error.

GetPdfFromSignedXml

public static byte[] GetPdfFromSignedXml()

setLicense

public static boolean setLicense(String verifiedString)

Sets the verified string. May run the license app.

Parameters:

verifiedString - The verified string.

Returns:

True in case of success.

setCustomtLicensePath

public static boolean setCustomtLicensePath(String path)

Sets thepath where corpcode.lic is located.

Parameters:

path - path of the corpcode.lic file.

Returns:

True in case of success.

checkLicenseOfParentSoftware

public static boolean checkLicenseOfParentSoftware(String SoftwareName,
                                                   String LicExtn,
                                                   boolean isNextGenDevice,
                                                   String CustomLicPath)

GetEventQueue

public static Optional<String> GetEventQueue()

Gets the events and errors

Returns:

a comma seperated string of events