XMLDSigner

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> hk >> hku >> cecid >> phoenix >> [ pki overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of hk.hku.cecid.phoenix.pki.XMLDSigner

SOURCE |

Download hk.hku.cecid.phoenix.pki.XMLDSigner

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

hk.hku.cecid.phoenix.pki
Interface XMLDSigner

All Known Implementing Classes:: ApacheXMLDSigner

public interface XMLDSigner

This interface defines a standard way to have the document signed. Different classes will implement the interface using different library behind.

Version:: $Revision: 1.3 $

Method Summary

void addDocument(java.lang.String uri, java.io.InputStream is, java.lang.String contentType)
          Adds a reference to a document attachment to the signature.

org.w3c.dom.Element getElement()
          Gets the DOM element of the signature generated.

void setEnvelope(org.w3c.dom.Document doc)
          Set the envelope to host the Signature element.

void setTrustAnchor(CompositeKeyStore ks)
          Sets the trust anchor for verfication of certificate path.

void sign(CompositeKeyStore ks, java.lang.String alias, char[] password)
          Signs the envelope and documents by using the specified key in the keystore.

boolean verify()
          Verifies the signature in the envelope passed in, which may reference the documents specified using the addDocument method.

Method Detail

setEnvelope

public void setEnvelope(org.w3c.dom.Document doc)
                 throws SignException

Set the envelope to host the Signature element. That is the XML document where the Signature element to be added. The digital signature here will always be an enveloped signature. The envelope will be included in the process of signing.

addDocument

public void addDocument(java.lang.String uri,
                        java.io.InputStream is,
                        java.lang.String contentType)

Adds a reference to a document attachment to the signature.

sign

public void sign(CompositeKeyStore ks,
                 java.lang.String alias,
                 char[] password)
          throws SignException

Signs the envelope and documents by using the specified key in the keystore.

setTrustAnchor

public void setTrustAnchor(CompositeKeyStore ks)

Sets the trust anchor for verfication of certificate path.

verify

public boolean verify()
               throws VerifyException

Verifies the signature in the envelope passed in, which may reference the documents specified using the addDocument method.

getElement

public org.w3c.dom.Element getElement()

Gets the DOM element of the signature generated.