Package com.logicaldoc.sign.webservice.soap

Interface SignService

All Known Implementing Classes:

SoapSignClient, SoapSignService

public interface SignService

WebService to allow a user to sign documents

Since:

7.1.2

Author:

Marco Meschieri - LogicalDOC

Method Summary

Modifier and Type	Method	Description
void	generateCertificate(String sid)	Generates a new certificate for the user
void	markDocumentSigned(String sid, long docId, String reason, String certificate)	Marks a document as signed(it does not apply any signature, just marks the document as signed)
List<Long>	sign(String sid, List<Long> docIds, String reason)	Signs a set of documents
void	uploadCertificate(String sid, String privateKey, jakarta.activation.DataHandler certificate)	Imports an existing certificate file for the user

Method Details

generateCertificate

void generateCertificate(String sid)
                  throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Generates a new certificate for the user

Parameters:

sid - The session identifier

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

uploadCertificate

void uploadCertificate(String sid,
 String privateKey,
 jakarta.activation.DataHandler certificate)
                throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Imports an existing certificate file for the user

Parameters:

sid - The session identifier

privateKey - The private key

certificate - The certificate file(just .crt format is supported)

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

sign

List<Long> sign(String sid,
 List<Long> docIds,
 String reason)
         throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Signs a set of documents

Parameters:

sid - The session identifier

docIds - Identifiers of the documents you wants to sign

reason - Reason for the signature

Returns:

The list of the documents that were signed

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated

markDocumentSigned

void markDocumentSigned(String sid,
 long docId,
 String reason,
 String certificate)
                 throws com.logicaldoc.core.security.authentication.AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Marks a document as signed(it does not apply any signature, just marks the document as signed)

Parameters:

sid - The session identifier

docId - Identifier of the document

reason - Reason for the signature

certificate - Description of the certificate to save in the even

Throws:

com.logicaldoc.core.PersistenceException - Error in the data layer

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.security.authentication.AuthenticationException - The user has not been authenticated