Package eu.europa.esig.dss.ws.signature.common

Interface RemoteDocumentSignatureService

All Superinterfaces:

Serializable

All Known Implementing Classes:

RemoteDocumentSignatureServiceImpl

public interface RemoteDocumentSignatureService
extends Serializable

This interface RemoteDocumentSignatureService provides operations for the signature creation and for its extension.

Method Summary

Modifier and Type	Method	Description
RemoteDocument	counterSignSignature(RemoteDocument signatureDocument, RemoteSignatureParameters parameters, SignatureValueDTO signatureValue)	Counter signs the signatureDocument with the provided signatureValue.
RemoteDocument	extendDocument(RemoteDocument toExtendDocument, RemoteSignatureParameters parameters)	Extends the level of the signatures in the toExtendDocument
ToBeSignedDTO	getDataToBeCounterSigned(RemoteDocument signatureDocument, RemoteSignatureParameters parameters)	Retrieves the bytes of the data that need to be counter signed from signatureDocument.
ToBeSignedDTO	getDataToSign(RemoteDocument toSignDocument, RemoteSignatureParameters parameters)	Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.
RemoteDocument	signDocument(RemoteDocument toSignDocument, RemoteSignatureParameters parameters, SignatureValueDTO signatureValue)	Signs the toSignDocument with the provided signatureValue.
RemoteDocument	timestamp(RemoteDocument toTimestampDocument, RemoteTimestampParameters parameters)	Adds a timestamp to the document

Method Details

getDataToSign

ToBeSignedDTO getDataToSign(RemoteDocument toSignDocument,
 RemoteSignatureParameters parameters)
                     throws DSSException

Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters. When toSignDocument contains an already existing signature the returned bytes are related to a new parallel signature. - Enveloped signature (XML): a new signature is added and the signed data corresponds to that pointed by the first signature; - Enveloping signature: - - XML: The parallel signature is not possible - - CMS: A new parallel signature is added - Detached signature: - - XML: The parallel signature is added - - CMS: A new parallel signature is added

Parameters:

toSignDocument - document to sign or the already existing signature

parameters - set of the driving signing parameters

Returns:

the data to be signed

Throws:

DSSException - if an error occurred

signDocument

RemoteDocument signDocument(RemoteDocument toSignDocument,
 RemoteSignatureParameters parameters,
 SignatureValueDTO signatureValue)
                     throws DSSException

Signs the toSignDocument with the provided signatureValue.

Parameters:

toSignDocument - document to sign

parameters - set of the driving signing parameters

signatureValue - the signature value to incorporate

Returns:

the signed document (toSignDocument with the incorporated signature or the detached signature)

Throws:

DSSException - if an error occurred

extendDocument

RemoteDocument extendDocument(RemoteDocument toExtendDocument,
 RemoteSignatureParameters parameters)
                       throws DSSException

Extends the level of the signatures in the toExtendDocument

Parameters:

toExtendDocument - document to extend

parameters - set of the driving signing parameters

Returns:

the extended signature

Throws:

DSSException - if an error occurred

timestamp

RemoteDocument timestamp(RemoteDocument toTimestampDocument,
 RemoteTimestampParameters parameters)
                  throws DSSException

Adds a timestamp to the document

Parameters:

toTimestampDocument - RemoteDocument to timestamp

parameters - set of the driving timestamp parameters

Returns:

the timestamped RemoteDocument

Throws:

DSSException - if an error occurred

getDataToBeCounterSigned

ToBeSignedDTO getDataToBeCounterSigned(RemoteDocument signatureDocument,
 RemoteSignatureParameters parameters)

Retrieves the bytes of the data that need to be counter signed from signatureDocument. signatureDocument shall be a valid signature of the same type

Parameters:

signatureDocument - RemoteDocument representing the original signature to be counter signed

parameters - RemoteSignatureParameters set of the driving signing parameters for a counter signature

Returns:

ToBeSignedDTO to be counter signed byte array (signature value retrieved from the signatureDocument)

counterSignSignature

RemoteDocument counterSignSignature(RemoteDocument signatureDocument,
 RemoteSignatureParameters parameters,
 SignatureValueDTO signatureValue)

Counter signs the signatureDocument with the provided signatureValue.

Parameters:

signatureDocument - RemoteDocument to be counter signed

parameters - RemoteSignatureParameters set of the driving signing parameters for a counter signature

signatureValue - SignatureValueDTO the signature value to incorporate

Returns:

RemoteDocument the signature document enveloping a newly created counter signature