Package com.logicaldoc.sign.webservice.soap.client

Class SoapSignClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<SignService>

com.logicaldoc.sign.webservice.soap.client.SoapSignClient

All Implemented Interfaces:

SignService

public class SoapSignClient
extends com.logicaldoc.webservice.soap.client.SoapClient<SignService>
implements SignService

Constructor Summary

Constructors

Constructor	Description
SoapSignClient(String endpoint)
SoapSignClient(String endpoint, int gzipThreshold, boolean log, int timeout)

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

Methods inherited from class java.lang.Object

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

Constructor Details

SoapSignClient

public SoapSignClient(String endpoint,
 int gzipThreshold,
 boolean log,
 int timeout)

SoapSignClient

public SoapSignClient(String endpoint)

Method Details

generateCertificate

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

Description copied from interface: SignService

Generates a new certificate for the user

Specified by:

generateCertificate in interface SignService

Parameters:

sid - The session identifier

Throws:

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

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

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

sign

public 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

Description copied from interface: SignService

Signs a set of documents

Specified by:

sign in interface SignService

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.security.authentication.AuthenticationException - The user has not been authenticated

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

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

markDocumentSigned

public 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

Description copied from interface: SignService

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

Specified by:

markDocumentSigned in interface SignService

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.security.authentication.AuthenticationException - The user has not been authenticated

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

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

uploadCertificate

public 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

Description copied from interface: SignService

Imports an existing certificate file for the user

Specified by:

uploadCertificate in interface SignService

Parameters:

sid - The session identifier

privateKey - The private key

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

Throws:

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

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

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