Package eu.europa.esig.dss.ws.signature.soap.client

Interface SoapDocumentSignatureService

All Superinterfaces:

Serializable

All Known Implementing Classes:

SoapDocumentSignatureServiceImpl

public interface SoapDocumentSignatureService
extends Serializable

Interface for the Contract of the Signature Web Service. The signing web service allows to create a new signature or to extend existing one. Different forms of signature: XAdES, CAdES, PAdES, JAdES (as well as ASiC containers) are accepted.

The digital signature of a document in a web environment is performed in three steps: 1. Creating a byte stream representing the data to be signed. 2. Hashing of the data previously obtained and its encryption. 3. The creation of the envelope containing all the elements of a digital signature.

The process is controlled by a set of parameters.

Method Summary

Modifier and Type	Method	Description
RemoteDocument	counterSignSignature(CounterSignSignatureDTO counterSignSignature)	Counter signs the defined signature
RemoteDocument	extendDocument(ExtendDocumentDTO extendDocument)	This web service operation extends the signature of a given document to the level of the signature provided.
ToBeSignedDTO	getDataToBeCounterSigned(DataToBeCounterSignedDTO dataToBeCounterSigned)	Retrieves the data to be signed for counter signature creation
ToBeSignedDTO	getDataToSign(DataToSignOneDocumentDTO dataToSign)	This method computes the digest to be signed
RemoteDocument	signDocument(SignOneDocumentDTO signDocument)	This web service operation signs a document according to a previously signed digest, a level of signature, some signature properties and keyInfo.
RemoteDocument	timestampDocument(TimestampOneDocumentDTO timestampDocument)	This web service operation timestamps a document according to the provided timestamp parameters.

Method Details

getDataToSign

ToBeSignedDTO getDataToSign(DataToSignOneDocumentDTO dataToSign)

This method computes the digest to be signed

Parameters:

dataToSign - DataToSignOneDocumentDTOa DTO which contains the document to sign and parameters

Returns:

ToBeSignedDTO the data to be signed

signDocument

RemoteDocument signDocument(SignOneDocumentDTO signDocument)

This web service operation signs a document according to a previously signed digest, a level of signature, some signature properties and keyInfo.

Parameters:

signDocument - SignOneDocumentDTO a DTO which contains the document to be signed, the parameters and the signature value

Returns:

RemoteDocument the signed document

extendDocument

RemoteDocument extendDocument(ExtendDocumentDTO extendDocument)

This web service operation extends the signature of a given document to the level of the signature provided. The document is only changed, if the given signature level is 'higher' than the signature level of the document.

Parameters:

extendDocument - ExtendDocumentDTO a DTO which contains the document to be extented and the parameters

Returns:

RemoteDocument the document with an extended signature

timestampDocument

RemoteDocument timestampDocument(TimestampOneDocumentDTO timestampDocument)

This web service operation timestamps a document according to the provided timestamp parameters.

Parameters:

timestampDocument - TimestampOneDocumentDTO a DTO which contains the document to be timestamped and timestamp parameters

Returns:

RemoteDocument a timestamped document

getDataToBeCounterSigned

ToBeSignedDTO getDataToBeCounterSigned(DataToBeCounterSignedDTO dataToBeCounterSigned)

Retrieves the data to be signed for counter signature creation

Parameters:

dataToBeCounterSigned - DataToBeCounterSignedDTO a DTO with the required information (signatureDocument, parameters) to get data to be counter signed

Returns:

DataToBeCounterSignedDTO the data to be counter signed

counterSignSignature

RemoteDocument counterSignSignature(CounterSignSignatureDTO counterSignSignature)

Counter signs the defined signature

Parameters:

counterSignSignature - CounterSignSignatureDTO a DTO with the required information (dataToBeCounterSigned, parameters, signatureValue) to counter sign a signature

Returns:

RemoteDocument representing a signatureDocument containing the created counter signature