Package eu.europa.esig.dss.ws.validation.dto

Class DataToValidateDTO

java.lang.Object

eu.europa.esig.dss.ws.validation.dto.DataToValidateDTO

public class DataToValidateDTO
extends Object

Represents a validation request DTO

Constructor Summary

Constructors

Constructor	Description
DataToValidateDTO()	Empty constructor
DataToValidateDTO(RemoteDocument signedDocument, RemoteDocument originalDocument, RemoteDocument policy)	Constructor to validate a document
DataToValidateDTO(RemoteDocument signedDocument, RemoteDocument originalDocument, RemoteDocument policy, RemoteDocument cryptographicSuite)	Constructor to validate a document
DataToValidateDTO(RemoteDocument signedDocument, RemoteDocument originalDocument, RemoteDocument policy, RemoteDocument cryptographicSuite, String signatureId)	Constructor to extract original documents
DataToValidateDTO(RemoteDocument signedDocument, RemoteDocument originalDocument, RemoteDocument policy, String signatureId)	Constructor to extract original documents
DataToValidateDTO(RemoteDocument signedDocument, RemoteDocument originalDocument, Date validationTime, RemoteDocument policy)	Constructor to validate a document with validation time
DataToValidateDTO(RemoteDocument signedDocument, RemoteDocument originalDocument, Date validationTime, RemoteDocument policy, RemoteDocument cryptographicSuite)	Constructor to validate a document with validation time
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy)	Constructor to validate a document
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, RemoteDocument cryptographicSuite)	Constructor to validate a document
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, RemoteDocument cryptographicSuite, String signatureId)	Constructor to extract original documents
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, RemoteDocument cryptographicSuite, List<RemoteDocument> evidenceRecords)	Constructor to validate a document with applied evidence records
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, RemoteDocument cryptographicSuite, List<RemoteDocument> evidenceRecords, String signatureId)	Constructor to extract original documents for validation with evidence records
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, String signatureId)	Constructor to extract original documents
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, List<RemoteDocument> evidenceRecords)	Constructor to validate a document with applied evidence records
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, RemoteDocument policy, List<RemoteDocument> evidenceRecords, String signatureId)	Constructor to extract original documents for validation with evidence records
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, Date validationTime, RemoteDocument policy)	Constructor to validate a document with multiple detached files and validation time
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, Date validationTime, RemoteDocument policy, RemoteDocument cryptographicSuite)	Constructor to validate a document with multiple detached files and validation time
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, Date validationTime, RemoteDocument policy, RemoteDocument cryptographicSuite, List<RemoteDocument> evidenceRecords)	Constructor to validate a document with applied evidence records and validation time
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, Date validationTime, RemoteDocument policy, RemoteDocument cryptographicSuite, List<RemoteDocument> evidenceRecords, String signatureId)	Constructor to extract original documents for validation with evidence records with validation time
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, Date validationTime, RemoteDocument policy, List<RemoteDocument> evidenceRecords)	Constructor to validate a document with applied evidence records and validation time
DataToValidateDTO(RemoteDocument signedDocument, List<RemoteDocument> originalDocuments, Date validationTime, RemoteDocument policy, List<RemoteDocument> evidenceRecords, String signatureId)	Constructor to extract original documents for validation with evidence records with validation time

Method Summary

Modifier and Type	Method	Description
RemoteDocument	getCryptographicSuite()	Gets a cryptographic suite document (to be applied globally)
List<RemoteDocument>	getEvidenceRecords()	Gets a list of detached evidence records
List<RemoteDocument>	getOriginalDocuments()	Gets the original (detached) documents
RemoteDocument	getPolicy()	Gets the validation policy
String	getSignatureId()	Gets the signature id to get original documents for
RemoteDocument	getSignedDocument()	Gets signed document
TokenExtractionStrategy	getTokenExtractionStrategy()	Gets a token extraction strategy
Date	getValidationTime()	Gets the validation time
void	setCryptographicSuite(RemoteDocument cryptographicSuite)	Sets a cryptographic suite document (to be applied globally)
void	setEvidenceRecords(List<RemoteDocument> evidenceRecords)	Sets a list of detached evidence records applied to the signature
void	setOriginalDocuments(List<RemoteDocument> originalDocuments)	Sets the original (detached) documents
void	setPolicy(RemoteDocument policy)	Sets the validation policy
void	setSignatureId(String signatureId)	Sets the signature id to get original documents for
void	setSignedDocument(RemoteDocument signedDocument)	Sets the signed document
void	setTokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)	Sets a token extraction strategy
void	setValidationTime(Date validationTime)	Sets the validation time NOTE: if not defined, the current time is used

Methods inherited from class java.lang.Object

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

Constructor Details

DataToValidateDTO

public DataToValidateDTO()

Empty constructor

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 RemoteDocument originalDocument,
 RemoteDocument policy)

Constructor to validate a document

Parameters:

signedDocument - RemoteDocument to validate

originalDocument - RemoteDocument detached document

policy - RemoteDocument validation policy

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 RemoteDocument originalDocument,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite)

Constructor to validate a document

Parameters:

signedDocument - RemoteDocument to validate

originalDocument - RemoteDocument detached document

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 RemoteDocument originalDocument,
 Date validationTime,
 RemoteDocument policy)

Constructor to validate a document with validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocument - RemoteDocument detached document

validationTime - Date

policy - RemoteDocument validation policy

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 RemoteDocument originalDocument,
 Date validationTime,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite)

Constructor to validate a document with validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocument - RemoteDocument detached document

validationTime - Date

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy)

Constructor to validate a document

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite)

Constructor to validate a document

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 Date validationTime,
 RemoteDocument policy)

Constructor to validate a document with multiple detached files and validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

validationTime - Date

policy - RemoteDocument validation policy

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 Date validationTime,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite)

Constructor to validate a document with multiple detached files and validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

validationTime - Date

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 List<RemoteDocument> evidenceRecords)

Constructor to validate a document with applied evidence records

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

evidenceRecords - list of RemoteDocument detached evidence records

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite,
 List<RemoteDocument> evidenceRecords)

Constructor to validate a document with applied evidence records

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

evidenceRecords - list of RemoteDocument detached evidence records

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 Date validationTime,
 RemoteDocument policy,
 List<RemoteDocument> evidenceRecords)

Constructor to validate a document with applied evidence records and validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

validationTime - Date time to validate the document at

policy - RemoteDocument validation policy

evidenceRecords - list of RemoteDocument detached evidence records

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 Date validationTime,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite,
 List<RemoteDocument> evidenceRecords)

Constructor to validate a document with applied evidence records and validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

validationTime - Date time to validate the document at

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

evidenceRecords - list of RemoteDocument detached evidence records

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 RemoteDocument originalDocument,
 RemoteDocument policy,
 String signatureId)

Constructor to extract original documents

Parameters:

signedDocument - RemoteDocument to validate

originalDocument - RemoteDocument detached document

policy - RemoteDocument validation policy

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 RemoteDocument originalDocument,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite,
 String signatureId)

Constructor to extract original documents

Parameters:

signedDocument - RemoteDocument to validate

originalDocument - RemoteDocument detached document

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 String signatureId)

Constructor to extract original documents

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite,
 String signatureId)

Constructor to extract original documents

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 List<RemoteDocument> evidenceRecords,
 String signatureId)

Constructor to extract original documents for validation with evidence records

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

evidenceRecords - list of RemoteDocument detached evidence records

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite,
 List<RemoteDocument> evidenceRecords,
 String signatureId)

Constructor to extract original documents for validation with evidence records

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

evidenceRecords - list of RemoteDocument detached evidence records

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 Date validationTime,
 RemoteDocument policy,
 List<RemoteDocument> evidenceRecords,
 String signatureId)

Constructor to extract original documents for validation with evidence records with validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

validationTime - Date validation time

policy - RemoteDocument validation policy

evidenceRecords - list of RemoteDocument detached evidence records

signatureId - String to extract original documents for

DataToValidateDTO

public DataToValidateDTO(RemoteDocument signedDocument,
 List<RemoteDocument> originalDocuments,
 Date validationTime,
 RemoteDocument policy,
 RemoteDocument cryptographicSuite,
 List<RemoteDocument> evidenceRecords,
 String signatureId)

Constructor to extract original documents for validation with evidence records with validation time

Parameters:

signedDocument - RemoteDocument to validate

originalDocuments - list of RemoteDocument detached documents

validationTime - Date validation time

policy - RemoteDocument validation policy

cryptographicSuite - RemoteDocument cryptographic suite

evidenceRecords - list of RemoteDocument detached evidence records

signatureId - String to extract original documents for

Method Details

getSignedDocument

public RemoteDocument getSignedDocument()

Gets signed document

Returns:

RemoteDocument

setSignedDocument

public void setSignedDocument(RemoteDocument signedDocument)

Sets the signed document

Parameters:

signedDocument - RemoteDocument

getOriginalDocuments

public List<RemoteDocument> getOriginalDocuments()

Gets the original (detached) documents

Returns:

a list of RemoteDocuments

setOriginalDocuments

public void setOriginalDocuments(List<RemoteDocument> originalDocuments)

Sets the original (detached) documents

Parameters:

originalDocuments - a list of RemoteDocuments

getPolicy

public RemoteDocument getPolicy()

Gets the validation policy

Returns:

RemoteDocument

setPolicy

public void setPolicy(RemoteDocument policy)

Sets the validation policy

Parameters:

policy - RemoteDocument

getCryptographicSuite

public RemoteDocument getCryptographicSuite()

Gets a cryptographic suite document (to be applied globally)

Returns:

RemoteDocument

setCryptographicSuite

public void setCryptographicSuite(RemoteDocument cryptographicSuite)

Sets a cryptographic suite document (to be applied globally)

Parameters:

cryptographicSuite - RemoteDocument

getValidationTime

public Date getValidationTime()

Gets the validation time

Returns:

Date

setValidationTime

public void setValidationTime(Date validationTime)

Sets the validation time NOTE: if not defined, the current time is used

Parameters:

validationTime - Date

getEvidenceRecords

public List<RemoteDocument> getEvidenceRecords()

Gets a list of detached evidence records

Returns:

a list of RemoteDocuments

setEvidenceRecords

public void setEvidenceRecords(List<RemoteDocument> evidenceRecords)

Sets a list of detached evidence records applied to the signature

Parameters:

evidenceRecords - a list of RemoteDocuments

getTokenExtractionStrategy

public TokenExtractionStrategy getTokenExtractionStrategy()

Gets a token extraction strategy

Returns:

TokenExtractionStrategy

setTokenExtractionStrategy

public void setTokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)

Sets a token extraction strategy

Parameters:

tokenExtractionStrategy - TokenExtractionStrategy

getSignatureId

public String getSignatureId()

Gets the signature id to get original documents for

Returns:

String

setSignatureId

public void setSignatureId(String signatureId)

Sets the signature id to get original documents for

Parameters:

signatureId - String