eu.europa.esig.dss.validation

Class TimestampToken

java.lang.Object

eu.europa.esig.dss.x509.Token

eu.europa.esig.dss.validation.TimestampToken

All Implemented Interfaces:

Serializable

public class TimestampToken
extends Token

SignedToken containing a TimeStamp.

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.europa.esig.dss.x509.Token

extraInfo, issuerToken, issuerX500Principal, signatureAlgorithm, signatureInvalidityReason, signatureValid

Constructor Summary

Constructors

Constructor and Description
TimestampToken(byte[] binaries, TimestampType type, CertificatePool certPool)
TimestampToken(org.bouncycastle.cms.CMSSignedData cms, TimestampType type, CertificatePool certPool)
TimestampToken(org.bouncycastle.tsp.TimeStampToken timeStamp, TimestampType type, CertificatePool certPool) Constructor with an indication of the timestamp type.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAbbreviation()
ArchiveTimestampType	getArchiveTimestampType()
String	getCanonicalizationMethod() Applies only fro XAdES timestamps
List<CertificateToken>	getCertificates() Returns the list of wrapped certificates.
byte[]	getEncoded()
String	getEncodedSignedDataDigestValue() Retrieves the encoded signed data digest value.
Date	getGenerationTime() Retrieves the timestamp generation time.
int	getHashCode() Used only with XAdES timestamps.
DigestAlgorithm	getSignedDataDigestAlgo() Retrieves the DigestAlgorithm used to generate the digest value to timestamp.
List<TimestampReference>	getTimestampedReferences()
List<TimestampInclude>	getTimestampIncludes()
TimestampType	getTimeStampType() Retrieves the type of the timestamp token.
org.bouncycastle.asn1.cms.AttributeTable	getUnsignedAttributes()
Boolean	isMessageImprintDataFound()
Boolean	isMessageImprintDataIntact() The method matchData must be invoked previously.
boolean	isProcessed()
boolean	isSignedBy(CertificateToken issuerToken)
boolean	matchData(byte[] data) Checks if the TimeStampToken matches the signed data.
void	setArchiveTimestampType(ArchiveTimestampType archiveTimestampType) Archive timestamps can be of different sub type.
void	setCanonicalizationMethod(String canonicalizationMethod) Allows to set the canonicalization method used by the timestamp.
void	setHashCode(int hashCode) Used only with XAdES timestamps.
void	setTimestampedReferences(List<TimestampReference> timestampedReferences) This method is used to set the timestamped references.
void	setTimestampIncludes(List<TimestampInclude> timestampIncludes)
String	toString(String indentStr)

Methods inherited from class eu.europa.esig.dss.x509.Token

equals, extraInfo, getDigest, getDSSId, getDSSIdAsString, getIssuerToken, getIssuerX500Principal, getSignatureAlgorithm, getValidationInfo, hashCode, isSelfSigned, isSignatureValid, isTrusted, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TimestampToken

public TimestampToken(byte[] binaries,
              TimestampType type,
              CertificatePool certPool)
               throws org.bouncycastle.tsp.TSPException,
                      IOException,
                      org.bouncycastle.cms.CMSException

Throws:

org.bouncycastle.tsp.TSPException

IOException

org.bouncycastle.cms.CMSException

TimestampToken

public TimestampToken(org.bouncycastle.cms.CMSSignedData cms,
              TimestampType type,
              CertificatePool certPool)
               throws org.bouncycastle.tsp.TSPException,
                      IOException

Throws:

org.bouncycastle.tsp.TSPException

IOException

TimestampToken

public TimestampToken(org.bouncycastle.tsp.TimeStampToken timeStamp,
              TimestampType type,
              CertificatePool certPool)

Constructor with an indication of the timestamp type. The default constructor for TimestampToken.

Parameters:

timeStamp - TimeStampToken

type - TimestampType

certPool - CertificatePool which is used to identify the signing certificate of the timestamp

Method Detail

getAbbreviation

public String getAbbreviation()

Overrides:

getAbbreviation in class Token

isSignedBy

public final boolean isSignedBy(CertificateToken issuerToken)

Specified by:

isSignedBy in class Token

matchData

public boolean matchData(byte[] data)

Checks if the TimeStampToken matches the signed data.

Parameters:

data - the array of byte representing the timestamped data

Returns:

true if the data is verified by the TimeStampToken

isProcessed

public boolean isProcessed()

getTimeStampType

public TimestampType getTimeStampType()

Retrieves the type of the timestamp token.

Returns:

TimestampType

getGenerationTime

public Date getGenerationTime()

Retrieves the timestamp generation time.

Returns:

Date

getSignedDataDigestAlgo

public DigestAlgorithm getSignedDataDigestAlgo()

Retrieves the DigestAlgorithm used to generate the digest value to timestamp.

Returns:

DigestAlgorithm

getEncodedSignedDataDigestValue

public String getEncodedSignedDataDigestValue()

Retrieves the encoded signed data digest value.

Returns:

base 64 encoded String

isMessageImprintDataFound

public Boolean isMessageImprintDataFound()

Returns:

true if the message imprint data was found, false otherwise

isMessageImprintDataIntact

public Boolean isMessageImprintDataIntact()

The method matchData must be invoked previously.

Returns:

true if the message imprint data is intact, false otherwise

getTimestampedReferences

public List<TimestampReference> getTimestampedReferences()

Returns:

List of TimestampReferences

setTimestampedReferences

public void setTimestampedReferences(List<TimestampReference> timestampedReferences)

This method is used to set the timestamped references. The reference can be the digest value of the certificate or of the revocation data. The same references can be timestamped by different timestamps.

Parameters:

timestampedReferences - List of TimestampReference

getArchiveTimestampType

public ArchiveTimestampType getArchiveTimestampType()

Returns:

ArchiveTimestampType in the case of an archive timestamp, null otherwise

setArchiveTimestampType

public void setArchiveTimestampType(ArchiveTimestampType archiveTimestampType)

Archive timestamps can be of different sub type.

Parameters:

archiveTimestampType - ArchiveTimestampType

getCanonicalizationMethod

public String getCanonicalizationMethod()

Applies only fro XAdES timestamps

Returns:

String representing the canonicalization method used by the timestamp

setCanonicalizationMethod

public void setCanonicalizationMethod(String canonicalizationMethod)

Allows to set the canonicalization method used by the timestamp. Applies only with XAdES timestamps.

Parameters:

canonicalizationMethod - String representing the canonicalization method

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in class Token

getTimestampIncludes

public List<TimestampInclude> getTimestampIncludes()

setTimestampIncludes

public void setTimestampIncludes(List<TimestampInclude> timestampIncludes)

getCertificates

public List<CertificateToken> getCertificates()

Returns the list of wrapped certificates.

Returns:

List of CertificateToken

getUnsignedAttributes

public org.bouncycastle.asn1.cms.AttributeTable getUnsignedAttributes()

setHashCode

public void setHashCode(int hashCode)

Used only with XAdES timestamps.

Parameters:

hashCode - the hash code of the DOM element containing the timestamp

getHashCode

public int getHashCode()

Used only with XAdES timestamps.

Returns:

the hash code of the DOM element containing the timestamp

toString

public String toString(String indentStr)

Specified by:

toString in class Token