Module jpms_dss_document
Package eu.europa.esig.dss.validation.timestamp

Interface TimestampSource

All Superinterfaces:
Serializable
All Known Implementing Classes:
SignatureTimestampSource
public interface TimestampSource extends Serializable
The interface for handling validation data extracted from timestamps

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addExternalEvidenceRecord(EvidenceRecord evidenceRecord)
    This method allows to add an external evidence record.
    void
    addExternalTimestamp(eu.europa.esig.dss.spi.x509.tsp.TimestampToken timestamp)
    This method allows to add an external timestamp.
    List<EvidenceRecord>
    getAllEvidenceRecords()
    Returns a list of all evidence records associated with the signature
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getAllTimestamps()
    Returns a list of all incorporated timestamps
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getAllTimestampsExceptLastArchiveTimestamp()
    Returns a list of all TimestampTokens except the last archive timestamp
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getArchiveTimestamps()
    Returns a list of incorporated archive timestamps
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getContentTimestamps()
    Returns a list of incorporated content timestamps
    List<EvidenceRecord>
    getDetachedEvidenceRecords()
    Returns a list of evidence records detached from a signature document
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getDetachedTimestamps()
    Returns a list of detached timestamps (used in ASiC with CAdES)
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getDocumentTimestamps()
    Returns a list of incorporated document timestamps (PAdES only)
    List<EvidenceRecord>
    getEmbeddedEvidenceRecords()
    Returns a list of evidence records embedded to a signature document
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getSignatureTimestamps()
    Returns a list of incorporated signature timestamps
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference>
    getSignerDataReferences()
    Returns a list of TimestampedReferences obtained from the signatureScopes
    eu.europa.esig.dss.spi.x509.ListCertificateSource
    getTimestampCertificateSources()
    Returns a merged ListCertificateSource of all embedded timestamp certificate sources
    eu.europa.esig.dss.spi.x509.ListCertificateSource
    getTimestampCertificateSourcesExceptLastArchiveTimestamp()
    Returns a merged ListCertificateSource of all embedded timestamp certificate sources except the latest Archive Timestamp
    eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.crl.CRL>
    getTimestampCRLSources()
    Returns a merged ListRevocationSource of all embedded timestamp CRL sources
    eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP>
    getTimestampOCSPSources()
    Returns a merged ListRevocationSource of all embedded timestamp OCSP sources
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getTimestampsX1()
    Returns a list of incorporated SigAndRefs timestamps
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getTimestampsX2()
    Returns a list of incorporated RefsOnly timestamps
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference>
    getUnsignedPropertiesReferences()
    Returns a list of TimestampedReferences for all tokens embedded into unsigned properties of the signature
    boolean
    isTimestamped(String tokenId, eu.europa.esig.dss.enumerations.TimestampedObjectType objectType)
    Checks if a tokenId with the given Id is covered by the timestamp source

  • Method Details

    • getContentTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getContentTimestamps()
      Returns a list of incorporated content timestamps
      Returns:
      a list of TimestampTokens

    • getSignatureTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getSignatureTimestamps()
      Returns a list of incorporated signature timestamps
      Returns:
      a list of TimestampTokens

    • getTimestampsX1

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getTimestampsX1()
      Returns a list of incorporated SigAndRefs timestamps
      Returns:
      a list of TimestampTokens

    • getTimestampsX2

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getTimestampsX2()
      Returns a list of incorporated RefsOnly timestamps
      Returns:
      a list of TimestampTokens

    • getArchiveTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getArchiveTimestamps()
      Returns a list of incorporated archive timestamps
      Returns:
      a list of TimestampTokens

    • getDocumentTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getDocumentTimestamps()
      Returns a list of incorporated document timestamps (PAdES only)
      Returns:
      a list of TimestampTokens

    • getDetachedTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getDetachedTimestamps()
      Returns a list of detached timestamps (used in ASiC with CAdES)
      Returns:
      a list of TimestampTokens

    • getAllTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getAllTimestamps()
      Returns a list of all incorporated timestamps
      Returns:
      a list of TimestampTokens

    • addExternalTimestamp

      void addExternalTimestamp(eu.europa.esig.dss.spi.x509.tsp.TimestampToken timestamp)
      This method allows to add an external timestamp. The given timestamp must be processed before.
      Parameters:
      timestamp - TimestampToken the timestamp token

    • getEmbeddedEvidenceRecords

      List<EvidenceRecord> getEmbeddedEvidenceRecords()
      Returns a list of evidence records embedded to a signature document
      Returns:
      a list of EvidenceRecords

    • getDetachedEvidenceRecords

      List<EvidenceRecord> getDetachedEvidenceRecords()
      Returns a list of evidence records detached from a signature document
      Returns:
      a list of EvidenceRecords

    • getAllEvidenceRecords

      List<EvidenceRecord> getAllEvidenceRecords()
      Returns a list of all evidence records associated with the signature
      Returns:
      a list of EvidenceRecords

    • addExternalEvidenceRecord

      void addExternalEvidenceRecord(EvidenceRecord evidenceRecord)
      This method allows to add an external evidence record. The given evidence record must be processed before.
      Parameters:
      evidenceRecord - EvidenceRecord the evidence record covering the signature file

    • getTimestampCertificateSources

      eu.europa.esig.dss.spi.x509.ListCertificateSource getTimestampCertificateSources()
      Returns a merged ListCertificateSource of all embedded timestamp certificate sources
      Returns:
      ListCertificateSource

    • getTimestampCertificateSourcesExceptLastArchiveTimestamp

      eu.europa.esig.dss.spi.x509.ListCertificateSource getTimestampCertificateSourcesExceptLastArchiveTimestamp()
      Returns a merged ListCertificateSource of all embedded timestamp certificate sources except the latest Archive Timestamp
      Returns:
      ListCertificateSource

    • getAllTimestampsExceptLastArchiveTimestamp

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getAllTimestampsExceptLastArchiveTimestamp()
      Returns a list of all TimestampTokens except the last archive timestamp
      Returns:
      a list of TimestampTokens

    • getTimestampCRLSources

      eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.crl.CRL> getTimestampCRLSources()
      Returns a merged ListRevocationSource of all embedded timestamp CRL sources
      Returns:
      ListRevocationSource

    • getTimestampOCSPSources

      eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP> getTimestampOCSPSources()
      Returns a merged ListRevocationSource of all embedded timestamp OCSP sources
      Returns:
      ListRevocationSource

    • getUnsignedPropertiesReferences

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference> getUnsignedPropertiesReferences()
      Returns a list of TimestampedReferences for all tokens embedded into unsigned properties of the signature
      Returns:
      a list of TimestampedReferences

    • getSignerDataReferences

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference> getSignerDataReferences()
      Returns a list of TimestampedReferences obtained from the signatureScopes
      Returns:
      list of TimestampedReferences

    • isTimestamped

      boolean isTimestamped(String tokenId, eu.europa.esig.dss.enumerations.TimestampedObjectType objectType)
      Checks if a tokenId with the given Id is covered by the timestamp source
      Parameters:
      tokenId - String Id of the token to check
      objectType - TimestampedObjectType defining the type of the token
      Returns:
      TRUE if the token if covered by the timestamp source, FALSE otherwise