iaik.xml.crypto.xades

Interface XAdESTimeStamp

All Superinterfaces:

XMLStructure

All Known Subinterfaces:

AllDataObjectsTimeStamp, ArchiveTimeStamp, ArchiveTimeStamp132, ArchiveTimeStamp141, IndividualDataObjectsTimeStamp, RefsOnlyTimeStamp, RefsOnlyTimeStampV2, SigAndRefsTimeStamp, SigAndRefsTimeStampV2, SignatureTimeStamp

All Known Implementing Classes:

AllDataObjectsTimeStampImpl, ArchiveTimeStamp132Impl, ArchiveTimeStamp141Impl, ArchiveTimeStampImpl, IndividualDataObjectsTimeStampImpl, RefsOnlyTimeStampImpl, RefsOnlyTimeStampV2Impl, SigAndRefsTimeStampImpl, SigAndRefsTimeStampV2Impl, SignatureTimeStampImpl, XAdESTimeStampImpl

public interface XAdESTimeStamp
extends XMLStructure

A common interface for all XAdESTimeStamp types defined in ETSI TS 101 933 v1.3.2.
The XML Schema Definition is defined as:

    <xsd:element name="XAdESTimeStamp" type="XAdESTimeStampType"/>
    <xsd:complexType name="XAdESTimeStampType">
      <xsd:complexContent>
        <xsd:restriction base="GenericTimeStampType">
          <xsd:sequence>
            <xsd:element ref="Include" minOccurs="0" maxOccurs="unbounded"/>
            <xsd:element ref="ds:CanonicalizationMethod" minOccurs="0"/>
            <xsd:choice maxOccurs="unbounded">
              <xsd:element name="EncapsulatedTimeStamp" type="EncapsulatedPKIDataType"/>
              <xsd:element name="XMLTimeStamp" type="AnyType"/>
            </xsd:choice>
          </xsd:sequence>
          <xsd:attribute name="Id" type="xsd:ID" use="optional"/>
        </xsd:restriction>
      </xsd:complexContent>
    </xsd:complexType>
 
   <xsd:complexType name="GenericTimeStampType" abstract="true">
     <xsd:sequence>
       <xsd:choice minOccurs="0">
         <xsd:element ref="Include" maxOccurs="unbounded"/>
         <xsd:element ref="ReferenceInfo" maxOccurs="unbounded"/>
       </xsd:choice>
       <xsd:element ref="ds:CanonicalizationMethod" minOccurs="0"/>
       <xsd:choice maxOccurs="unbounded">
         <xsd:element name="EncapsulatedTimeStamp" type="EncapsulatedPKIDataType"/>
         <xsd:element name="XMLTimeStamp" type="AnyType"/>
       </xsd:choice>
     </xsd:sequence>
     <xsd:attribute name="Id" type="xsd:ID" use="optional"/>
   </xsd:complexType>
 
  <xsd:element name="ReferenceInfo" type="ReferenceInfoType"/>
  <xsd:complexType name="ReferenceInfoType">
    <xsd:sequence>
      <xsd:element ref="ds:DigestMethod"/>
      <xsd:element ref="ds:DigestValue"/>
    </xsd:sequence>
    <xsd:attribute name="Id" type="xsd:ID" use="optional"/>
    <xsd:attribute name="URI" type="xsd:anyURI" use="optional"/>
  </xsd:complexType>
 
 

OtherTimeStamp, ReferenceInfo are not yet supported.

See Also:

Include

Method Summary

Modifier and Type	Method and Description
CanonicalizationMethod	getCanonicalizationMethod() Returns the canonicalization method.
String	getId() Returns the id-attribute value
List	getIncludes() Returns the list Includes
InputStream	getTimeStampInputStream() Returns the time-stamp input stream, if time-stamp caching is enabled.
TimeStampToken	getTimeStampToken() Returns the time stamp token.
String	getTokenId() Returns the id-attribute value of the timestamp token.
boolean	validate(XMLCryptoContext context) Validates this time-stamp.

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Method Detail

getIncludes

List getIncludes()

Returns the list Includes

Returns:

the list of Includes

getTimeStampToken

TimeStampToken getTimeStampToken()

Returns the time stamp token.

Returns:

the time stamp token

getCanonicalizationMethod

CanonicalizationMethod getCanonicalizationMethod()
                                          throws NoSuchAlgorithmException

Returns the canonicalization method.

Returns:

the CanonicalizationMethod

Throws:

NoSuchAlgorithmException - is thrown if the implementation for CanonicalizationMethod cannot be found.

getId

String getId()

Returns the id-attribute value

Returns:

the id-attribute value

getTokenId

String getTokenId()

Returns the id-attribute value of the timestamp token.

Returns:

the id-attribute value of the timestamp token.

getTimeStampInputStream

InputStream getTimeStampInputStream()

Returns the time-stamp input stream, if time-stamp caching is enabled. This is the input to the digest operation during a time-stamp creation or validation.

Returns:

an input stream containing the time-stamp input, or null if time-stamp caching is not enabled or this time-stamp has not been digested or validated.

validate

boolean validate(XMLCryptoContext context)
          throws XMLSignatureException

Validates this time-stamp. This method verifies the digest of the time-stamp input and the signature of the time-stamp token.

This method only validates the time-stamp the first time it is invoked. On subsequent invocations, it returns a cached result.

Please Note that Data dereferenced using the explicit mechanism Include are resolved by using XML's xs:ID mechanism. It is up to an application developer to check whether the dereferenced data is that intended by an application. Use getTimeStampInputStream() to do so. However the use of the explicit mechanism is not recommended.

Parameters:

context - the validating context

Returns:

true if this time-stamp was validated successfully; false otherwise

Throws:

NullPointerException - if context is null

XMLSignatureException - if an unexpected exception occurs while validating the time-stamp