Class ExtendDocumentDTO

java.lang.Object

eu.europa.esig.dss.ws.signature.dto.ExtendDocumentDTO

All Implemented Interfaces:

Serializable

public class ExtendDocumentDTO
extends Object
implements Serializable

This class is a DTO to transfer required objects to execute extendDocument method It's only possible to transfer an object by POST and REST. It's impossible to transfer big objects by GET (url size limitation).

NOTE: In addition to toExtendDocument (mandatory), at least one of signatureProfile or parameters shall be provided.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExtendDocumentDTO()	Empty document
ExtendDocumentDTO(RemoteDocument toExtendDocument, SignatureProfile signatureProfile)	Simplified constructor with a target signature augmentation profile definition
ExtendDocumentDTO(RemoteDocument toExtendDocument, SignatureProfile signatureProfile, RemoteSignatureParameters parameters)	Constructor with a target signature augmentation profile and signature parameters definitions
ExtendDocumentDTO(RemoteDocument toExtendDocument, RemoteSignatureParameters parameters)	Constructor with signature parameters definition

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
RemoteSignatureParameters	getParameters()	Gets the extension parameters
SignatureProfile	getSignatureProfile()	Gets the target signature augmentation profile
RemoteDocument	getToExtendDocument()	Gets the document to be extended
int	hashCode()
void	setParameters(RemoteSignatureParameters parameters)	Sets the extension parameters
void	setSignatureProfile(SignatureProfile signatureProfile)	Sets the target signature augmentation profile
void	setToExtendDocument(RemoteDocument toExtendDocument)	Sets the document to be extended
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExtendDocumentDTO

public ExtendDocumentDTO()

Empty document

ExtendDocumentDTO

public ExtendDocumentDTO(RemoteDocument toExtendDocument,
 SignatureProfile signatureProfile)

Simplified constructor with a target signature augmentation profile definition

Parameters:

toExtendDocument - RemoteDocument

signatureProfile - SignatureProfile

ExtendDocumentDTO

public ExtendDocumentDTO(RemoteDocument toExtendDocument,
 RemoteSignatureParameters parameters)

Constructor with signature parameters definition

Parameters:

toExtendDocument - RemoteDocument

parameters - RemoteSignatureParameters

ExtendDocumentDTO

public ExtendDocumentDTO(RemoteDocument toExtendDocument,
 SignatureProfile signatureProfile,
 RemoteSignatureParameters parameters)

Constructor with a target signature augmentation profile and signature parameters definitions

Parameters:

toExtendDocument - RemoteDocument

signatureProfile - SignatureProfile

parameters - RemoteSignatureParameters

Method Details

getToExtendDocument

public RemoteDocument getToExtendDocument()

Gets the document to be extended

Returns:

RemoteDocument

setToExtendDocument

public void setToExtendDocument(RemoteDocument toExtendDocument)

Sets the document to be extended

Parameters:

toExtendDocument - RemoteDocument

getSignatureProfile

public SignatureProfile getSignatureProfile()

Gets the target signature augmentation profile

Returns:

SignatureProfile

setSignatureProfile

public void setSignatureProfile(SignatureProfile signatureProfile)

Sets the target signature augmentation profile

Parameters:

signatureProfile - SignatureProfile

getParameters

public RemoteSignatureParameters getParameters()

Gets the extension parameters

Returns:

RemoteSignatureParameters

setParameters

public void setParameters(RemoteSignatureParameters parameters)

Sets the extension parameters

Parameters:

parameters - RemoteSignatureParameters

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object