ISignMethodAddin

Sign Method Add-in is deprecated. Sign Method Add-in V2 should be used instead.

Add-in responsible for implementing logic to determine available signing methods.

Trigger Event(s): When a signature request is performed (example: a signature field clicked on the client-browser)

Table 1. *ISignMethodAddin* interface methods declaration and description
Method	Description
getAvailableMethods	Retrieves all available signing methods for a given artifact or artifact object
	Parameter	Type	Description
	artifactDetails	ArtifactDetails	Artifact context with read-only access privileges
	objectId	String	Unique identifier of the object to be signed

	Returns	Type	Description
	availableMethods	List<SignMethods>	List of the available signature methods for the given object (one of the following: HANDWRITTEN, TRANSCRIPTION, SMARTCARD, CLICKTOSIGN, OTP, UNKNOWN, UNSIGNED, INTERNAL, ONDEMAND)

eSign brings an out-of-the box implementation for this interface that is described below

Table 2. Available implementations for ISignMethodAddin
Implementation	Default	Description
DefaultSignMethodAddin	✓	Obtains the available signing methods over an artifact object from the local properties file (*esign.config*). Searches this configuration file for the permitted methods, fetches the requested sign methods and intersects both lists. The result of this intersection is the signing methods that are made accessible to the user

Configuration

First the add-in needs to be loaded as an extension,

"_comment" : "List all the extensions to be used",
"extensions" :
[
	...

	{
        "name": "artifact-sign",
        "class": "novabase.connect.paperless.esign.core.extensions.impl.DefaultSignMethodLoadAddin"
    },

	...
]

Optionally, set as the default add-in by establishing the class path for the type "artifact_sign_method"

"_comment" : "List all the default addins to be used",
"addins" :
[
    ...

    {
        "type": "artifact_sign_method",
        "extension": "artifact-sign"
    },

    ...
]