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

Interface RestDocumentSignatureService

All Superinterfaces:

Serializable

All Known Implementing Classes:

RestDocumentSignatureServiceImpl

@Path("/")
@Produces("application/json")
@Consumes("application/json")
public interface RestDocumentSignatureService
extends Serializable

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

Method Summary

Modifier and Type	Method	Description
RemoteDocument	counterSignSignature(CounterSignSignatureDTO counterSignSignature)	Counter signs the defined signature
RemoteDocument	extendDocument(ExtendDocumentDTO extendDocument)	Extends the level of the signatures in the toExtendDocument
ToBeSignedDTO	getDataToBeCounterSigned(DataToBeCounterSignedDTO dataToBeCounterSigned)	Retrieves the data to be signed for counter signature creation
ToBeSignedDTO	getDataToSign(DataToSignOneDocumentDTO dataToSign)	Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.
RemoteDocument	signDocument(SignOneDocumentDTO signDocument)	Signs the toSignDocument with the provided signatureValue.
RemoteDocument	timestampDocument(TimestampOneDocumentDTO timestampDocument)	Timestamps a toTimestampDocument with the provided parameters.

Method Details

getDataToSign

@POST
@Path("getDataToSign")
ToBeSignedDTO getDataToSign(DataToSignOneDocumentDTO dataToSign)

Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.

Parameters:

dataToSign - DataToSignOneDocumentDTO a DTO with the needed information (document and parameters) to compute the data to be signed

Returns:

ToBeSignedDTO the data to be signed

signDocument

@POST
@Path("signDocument")
RemoteDocument signDocument(SignOneDocumentDTO signDocument)

Signs the toSignDocument with the provided signatureValue.

Parameters:

signDocument - SignOneDocumentDTO a DTO with the needed information (document, parameter and signature value) to generate the signed document

Returns:

RemoteDocument the signed document

extendDocument

@POST
@Path("extendDocument")
RemoteDocument extendDocument(ExtendDocumentDTO extendDocument)

Extends the level of the signatures in the toExtendDocument

Parameters:

extendDocument - ExtendDocumentDTO a DTO with the needed information (the signed document and extension parameters) to generate the extended document

Returns:

RemoteDocument the extended document

timestampDocument

@POST
@Path("timestampDocument")
RemoteDocument timestampDocument(TimestampOneDocumentDTO timestampDocument)

Timestamps a toTimestampDocument with the provided parameters.

Parameters:

timestampDocument - TimestampOneDocumentDTO a DTO with the needed information (document, timestamp parameters) to timestamp a document

Returns:

RemoteDocument a timestamped document

getDataToBeCounterSigned

@POST
@Path("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

@POST
@Path("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