Package eu.europa.esig.dss.diagnostic

Class TimestampWrapper

java.lang.Object

eu.europa.esig.dss.diagnostic.AbstractTokenProxy

eu.europa.esig.dss.diagnostic.AbstractSignatureWrapper

eu.europa.esig.dss.diagnostic.TimestampWrapper

All Implemented Interfaces:

TokenProxy

public class TimestampWrapper
extends AbstractSignatureWrapper

Provides a user-friendly interface for dealing with JAXB XmlTimestamp object

Constructor Summary

Constructors

Constructor	Description
TimestampWrapper(XmlTimestamp timestamp)	Default constructor

Method Summary

Modifier and Type	Method	Description
FoundCertificatesProxy	foundCertificates()	Returns FoundCertificatesProxy to access embedded certificates
FoundRevocationsProxy	foundRevocations()	Returns FoundRevocationsProxy to access embedded revocation data
List<OrphanTokenWrapper>	getAllTimestampedOrphanTokens()	Returns a list of all OrphanTokens
ArchiveTimestampType	getArchiveTimestampType()	Returns archive timestamp type, if applicable NOTE: returns null for non archive timestamps
byte[]	getBinaries()	Returns binaries of the token, when present
protected XmlBasicSignature	getCurrentBasicSignature()	Returns a basic signature validation
protected List<XmlChainItem>	getCurrentCertificateChain()	Returns the token's certificate chain
protected XmlSigningCertificate	getCurrentSigningCertificate()	Returns the signing certificate of the token
XmlDigestAlgoAndValue	getDigestAlgoAndValue()	Returns digest algorithm and value of the timestamp token binaries, when defined
List<XmlDigestMatcher>	getDigestMatchers()	Returns a list of DigestMatchers used in the validation process for a signature or timestamp
List<String>	getEvidenceRecordIdsList()	Returns a list of associated evidence record identifiers
List<EvidenceRecordWrapper>	getEvidenceRecords()	Returns a list of evidence records covering the time-stamp file (applicable for detached time-stamps only)
List<String>	getEvidenceRecordTimestampIds()	Returns identifiers of all covering evidence record time-stamps
EvidenceRecordTimestampType	getEvidenceRecordTimestampType()	Returns an evidence record archive timestamp type, if applicable NOTE: returns null for non evidence record archive timestamps
String	getFilename()	Gets name of the timestamp file, when applicable
String	getId()	Returns the unique identifier of the object
XmlDigestMatcher	getMessageImprint()	Returns message-imprint XmlDigestMatcher
PDFRevisionWrapper	getPDFRevision()	Returns a PAdES-specific PDF Revision info NOTE: applicable only for PDF Document Timestamp
Date	getProductionTime()	Returns the indicated production time of the timestamp
List<XmlSignerInfo>	getSignatureInformationStore()	Returns a list if Signer Infos (Signer Information Store) from CAdES CMS Signed Data
List<CertificateWrapper>	getTimestampedCertificates()	Returns a list of certificates covered be the current timestamp
List<EvidenceRecordWrapper>	getTimestampedEvidenceRecords()	Returns a list of evidence records covered be the current timestamp
List<XmlTimestampedObject>	getTimestampedObjects()	Returns a complete list of all XmlTimestampedObjects covered by the timestamp
List<OrphanCertificateTokenWrapper>	getTimestampedOrphanCertificates()	Returns a list of OrphanCertificateTokens
List<OrphanRevocationTokenWrapper>	getTimestampedOrphanRevocations()	Returns a list of OrphanRevocationTokens
List<RevocationWrapper>	getTimestampedRevocations()	Returns a list of revocation data covered be the current timestamp
List<SignatureWrapper>	getTimestampedSignatures()	Returns a list of SignatureWrappers covered be the current timestamp
List<SignerDataWrapper>	getTimestampedSignedData()	Returns a list of Signed data covered be the current timestamp
List<TimestampWrapper>	getTimestampedTimestamps()	Returns a list of timestamps covered be the current timestamp
List<XmlSignatureScope>	getTimestampScopes()	Returns Timestamp's Signature Scopes
String	getTSAGeneralNameValue()	Get TSA General Name value
TimestampType	getType()	Returns the type of the timestamp
boolean	isMessageImprintDataFound()	Indicates if the message-imprint is found (all the required data for message-imprint computation is present)
boolean	isMessageImprintDataIntact()	Indicates if the message-imprint is intact (matches the computed message-imprint)
boolean	isSigningCertificateIdentified()	Indicates if the signing certificate reference is present within the timestamp token and matches the actual signing certificate
boolean	isTimestampDuplicated()	Checks if the time-stamp's Id is duplicated within the validating document
boolean	isTSAGeneralNameMatch()	Checks if the content of TSTInfo.tsa field matches the timestamp's issuer distinguishing name, without taking order into account
boolean	isTSAGeneralNameOrderMatch()	Checks if the content and the order of TSTInfo.tsa field match the timestamp's issuer distinguishing name
boolean	isTSAGeneralNamePresent()	Checks if the tsa field of TSTInfo is present

Methods inherited from class eu.europa.esig.dss.diagnostic.AbstractSignatureWrapper

arePdfModificationsDetected, arePdfObjectModificationsDetected, getContactInfo, getDocMDPPermissions, getFieldMDP, getFilter, getFirstFieldName, getLocation, getModifiedFieldNames, getPdfAnnotationChanges, getPdfAnnotationsOverlapConcernedPages, getPdfExtensionChanges, getPdfPageDifferenceConcernedPages, getPdfSignatureOrFormFillChanges, getPdfUndefinedChanges, getPdfVisualDifferenceConcernedPages, getReason, getSigFieldLock, getSignatureByteRange, getSignatureDictionaryType, getSignatureFieldNames, getSignerName, getSubFilter, isPdfSignatureDictionaryConsistent, isSignatureByteRangeValid

Methods inherited from class eu.europa.esig.dss.diagnostic.AbstractTokenProxy

equals, getCertificateChain, getDigestAlgorithm, getEncryptionAlgorithm, getKeyLengthUsedToSignThisToken, getMaskGenerationFunction, getSignatureAlgorithm, getSigningCertificate, getSigningCertificatePublicKey, getSigningCertificateReference, getSigningCertificateReferences, hashCode, isCertificateChainFromTrustedStore, isSignatureIntact, isSignatureValid, isSigningCertificateReferencePresent, isSigningCertificateReferenceUnique, isTrustedChain, toString

Methods inherited from class java.lang.Object

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

Constructor Details

TimestampWrapper

public TimestampWrapper(XmlTimestamp timestamp)

Default constructor

Parameters:

timestamp - XmlTimestamp

Method Details

getId

public String getId()

Description copied from interface: TokenProxy

Returns the unique identifier of the object

Returns:

String id

isTimestampDuplicated

public boolean isTimestampDuplicated()

Checks if the time-stamp's Id is duplicated within the validating document

Returns:

TRUE if there is a duplicated time-stamp Id, FALSE otherwise

getCurrentBasicSignature

protected XmlBasicSignature getCurrentBasicSignature()

Description copied from class: AbstractTokenProxy

Returns a basic signature validation

Specified by:

getCurrentBasicSignature in class AbstractTokenProxy

Returns:

XmlBasicSignature

getCurrentCertificateChain

protected List<XmlChainItem> getCurrentCertificateChain()

Description copied from class: AbstractTokenProxy

Returns the token's certificate chain

Specified by:

getCurrentCertificateChain in class AbstractTokenProxy

Returns:

a list of XmlChainItems

getCurrentSigningCertificate

protected XmlSigningCertificate getCurrentSigningCertificate()

Description copied from class: AbstractTokenProxy

Returns the signing certificate of the token

Specified by:

getCurrentSigningCertificate in class AbstractTokenProxy

Returns:

XmlSigningCertificate

foundCertificates

public FoundCertificatesProxy foundCertificates()

Description copied from interface: TokenProxy

Returns FoundCertificatesProxy to access embedded certificates

Specified by:

foundCertificates in interface TokenProxy

Overrides:

foundCertificates in class AbstractTokenProxy

Returns:

FoundCertificatesProxy

foundRevocations

public FoundRevocationsProxy foundRevocations()

Description copied from interface: TokenProxy

Returns FoundRevocationsProxy to access embedded revocation data

Specified by:

foundRevocations in interface TokenProxy

Overrides:

foundRevocations in class AbstractTokenProxy

Returns:

FoundRevocationsProxy

getEvidenceRecords

public List<EvidenceRecordWrapper> getEvidenceRecords()

Returns a list of evidence records covering the time-stamp file (applicable for detached time-stamps only)

Returns:

a list of EvidenceRecordWrappers

getEvidenceRecordIdsList

public List<String> getEvidenceRecordIdsList()

Returns a list of associated evidence record identifiers

Returns:

a list of String

getEvidenceRecordTimestampIds

public List<String> getEvidenceRecordTimestampIds()

Returns identifiers of all covering evidence record time-stamps

Returns:

a list of String time-stamp identifiers

getType

public TimestampType getType()

Returns the type of the timestamp

Returns:

TimestampType

getArchiveTimestampType

public ArchiveTimestampType getArchiveTimestampType()

Returns archive timestamp type, if applicable NOTE: returns null for non archive timestamps

Returns:

ArchiveTimestampType

getEvidenceRecordTimestampType

public EvidenceRecordTimestampType getEvidenceRecordTimestampType()

Returns an evidence record archive timestamp type, if applicable NOTE: returns null for non evidence record archive timestamps

Returns:

EvidenceRecordTimestampType

getProductionTime

public Date getProductionTime()

Returns the indicated production time of the timestamp

Returns:

Date

getMessageImprint

public XmlDigestMatcher getMessageImprint()

Returns message-imprint XmlDigestMatcher

Returns:

XmlDigestMatcher

isMessageImprintDataFound

public boolean isMessageImprintDataFound()

Indicates if the message-imprint is found (all the required data for message-imprint computation is present)

Returns:

TRUE if the message-imprint data is found, FALSE otherwise

isMessageImprintDataIntact

public boolean isMessageImprintDataIntact()

Indicates if the message-imprint is intact (matches the computed message-imprint)

Returns:

TRUE if the message-imprint data is intact, FALSE otherwise

getFilename

public String getFilename()

Gets name of the timestamp file, when applicable

Returns:

String file name

getDigestMatchers

public List<XmlDigestMatcher> getDigestMatchers()

Description copied from interface: TokenProxy

Returns a list of DigestMatchers used in the validation process for a signature or timestamp

Specified by:

getDigestMatchers in interface TokenProxy

Overrides:

getDigestMatchers in class AbstractTokenProxy

Returns:

a list of XmlDigestMatchers

getTimestampedObjects

public List<XmlTimestampedObject> getTimestampedObjects()

Returns a complete list of all XmlTimestampedObjects covered by the timestamp

Returns:

list of XmlTimestampedObjects

getTimestampedSignatures

public List<SignatureWrapper> getTimestampedSignatures()

Returns a list of SignatureWrappers covered be the current timestamp

Returns:

list of SignatureWrappers

getTimestampedCertificates

public List<CertificateWrapper> getTimestampedCertificates()

Returns a list of certificates covered be the current timestamp

Returns:

list of CertificateWrappers

getTimestampedRevocations

public List<RevocationWrapper> getTimestampedRevocations()

Returns a list of revocation data covered be the current timestamp

Returns:

list of RevocationWrappers

getTimestampedTimestamps

public List<TimestampWrapper> getTimestampedTimestamps()

Returns a list of timestamps covered be the current timestamp

Returns:

list of TimestampWrappers

getTimestampedEvidenceRecords

public List<EvidenceRecordWrapper> getTimestampedEvidenceRecords()

Returns a list of evidence records covered be the current timestamp

Returns:

list of EvidenceRecordWrappers

getTimestampedSignedData

public List<SignerDataWrapper> getTimestampedSignedData()

Returns a list of Signed data covered be the current timestamp

Returns:

list of SignerDataWrappers

isSigningCertificateIdentified

public boolean isSigningCertificateIdentified()

Indicates if the signing certificate reference is present within the timestamp token and matches the actual signing certificate

Returns:

TRUE if the signing certificate is unambiguously identified, FALSE otherwise

getAllTimestampedOrphanTokens

public List<OrphanTokenWrapper> getAllTimestampedOrphanTokens()

Returns a list of all OrphanTokens

Returns:

list of OrphanTokenWrappers

getTimestampedOrphanCertificates

public List<OrphanCertificateTokenWrapper> getTimestampedOrphanCertificates()

Returns a list of OrphanCertificateTokens

Returns:

list of orphan certificates

getTimestampedOrphanRevocations

public List<OrphanRevocationTokenWrapper> getTimestampedOrphanRevocations()

Returns a list of OrphanRevocationTokens

Returns:

list of orphan revocations

getBinaries

public byte[] getBinaries()

Description copied from class: AbstractTokenProxy

Returns binaries of the token, when present

Specified by:

getBinaries in class AbstractTokenProxy

Returns:

a byte array

getDigestAlgoAndValue

public XmlDigestAlgoAndValue getDigestAlgoAndValue()

Returns digest algorithm and value of the timestamp token binaries, when defined

Returns:

XmlDigestAlgoAndValue

getPDFRevision

public PDFRevisionWrapper getPDFRevision()

Returns a PAdES-specific PDF Revision info NOTE: applicable only for PDF Document Timestamp

Specified by:

getPDFRevision in class AbstractSignatureWrapper

Returns:

PDFRevisionWrapper

getSignatureInformationStore

public List<XmlSignerInfo> getSignatureInformationStore()

Returns a list if Signer Infos (Signer Information Store) from CAdES CMS Signed Data

Returns:

list of XmlSignerInfos

isTSAGeneralNamePresent

public boolean isTSAGeneralNamePresent()

Checks if the tsa field of TSTInfo is present

Returns:

TRUE if the TSTInfo.tsa is present, FALSE otherwise

getTSAGeneralNameValue

public String getTSAGeneralNameValue()

Get TSA General Name value

Returns:

String representing a TSTInfo.tsa field when present, null otherwise

isTSAGeneralNameMatch

public boolean isTSAGeneralNameMatch()

Checks if the content of TSTInfo.tsa field matches the timestamp's issuer distinguishing name, without taking order into account

Returns:

TRUE if the TSTInfo.tsa field value matches the timestamp's issuer name, FALSE otherwise

isTSAGeneralNameOrderMatch

public boolean isTSAGeneralNameOrderMatch()

Checks if the content and the order of TSTInfo.tsa field match the timestamp's issuer distinguishing name

Returns:

TRUE if the TSTInfo.tsa field value and order match the timestamp's issuer name, FALSE otherwise

getTimestampScopes

public List<XmlSignatureScope> getTimestampScopes()

Returns Timestamp's Signature Scopes

Returns:

a list of XmlSignatureScopes