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 TypeMethodDescriptionvoid
Generates a new certificate for the uservoid
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)Signs a set of documentsvoid
uploadCertificate
(String sid, String privateKey, javax.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 layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-
uploadCertificate
void uploadCertificate(String sid, String privateKey, javax.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 identifierprivateKey
- The private keycertificate
- The certificate file(just .crt format is supported)- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.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 identifierdocIds
- Identifiers of the documents you wants to signreason
- Reason for the signature- Returns:
- The list of the documents that were signed
- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.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 identifierdocId
- Identifier of the documentreason
- Reason for the signaturecertificate
- Description of the certificate to save in the even- Throws:
com.logicaldoc.core.PersistenceException
- Error in the data layercom.logicaldoc.webservice.WebserviceException
- Error in the webservicecom.logicaldoc.core.security.authentication.AuthenticationException
- The user has not been authenticated
-