com.ibm.xml.dsig
Class TemplateGenerator

java.lang.Object
  |
  +--com.ibm.xml.dsig.TemplateGenerator

public class TemplateGenerator

extends java.lang.Object

Utility class to generate signature templates. This class does not support SignatureMethod with parameters.

Version:

$Id: TemplateGenerator.java,v 1.7 2002/04/10 07:14:08 kent Exp $

Author:

TAMURA Kent <kent@trl.ibm.co.jp>

Constructor Summary

TemplateGenerator()
Creates new TemplateGenerator instance.

TemplateGenerator(org.w3c.dom.Document factory, java.lang.String defaultDigestMethod, java.lang.String c14nURI, java.lang.String signatureMethod)
Creates new TemplateGenerator instance.

TemplateGenerator(org.w3c.dom.Document factory, java.lang.String defaultDigestMethod, java.lang.String c14nURI, java.lang.String signatureMethod, KeyInfoGenerator keyGen)
Deprecated.

Method Summary

void	addReference(Reference obj)
Reference	createReference(org.w3c.dom.Element objectElement) for enveloped resource (enveloping signature).
Reference	createReference(org.w3c.dom.Element objectElement, java.lang.String idname) for enveloped resource (enveloping signature).
Reference	createReference(java.lang.String uri) for detached resource, or for enveloping resource (enveloped signature).
org.w3c.dom.Document	getDocument()
org.w3c.dom.Element	getManifestElement() Creates Manifest structure without digest values.
java.lang.String	getPrefix()
org.w3c.dom.Element	getSignatureElement() Creates Signature structure without digest values and a signature value.
org.w3c.dom.Element	getSignedInfoElement() Creates SignedInfo structure without the signature value and digest values.
void	removeAllReferences()
void	setCanonicalizer(java.lang.String algorithmURI)
void	setDefaultDigestMethod(java.lang.String algorithmURI)
void	setDocument(org.w3c.dom.Document factory)
void	setKeyInfoGenerator(KeyInfoGenerator keyGen) Deprecated. Use KeyInfo#insertTo
void	setPrefix(java.lang.String pre)
void	setSignatureMethod(java.lang.String algorithmURI)
org.w3c.dom.Element	wrapWithObject(org.w3c.dom.Node resource, java.lang.String idname) Creates Object element that wraps resource and has idname as the Id attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateGenerator

public TemplateGenerator()

Creates new TemplateGenerator instance.

TemplateGenerator

public TemplateGenerator(org.w3c.dom.Document factory,
                         java.lang.String defaultDigestMethod,
                         java.lang.String c14nURI,
                         java.lang.String signatureMethod)

Creates new TemplateGenerator instance. The following two code fragments are equivalent:

sig = new TemplateGenerator(factory, digest, c14n, sigmethod);

 sig = new TemplateGenerator();
 sig.setDocument(factory);
 sig.setDefaultDigestMethod(digest);
 sig.setCanonicalizer(c14n);
 sig.setSignatureMethod(sigmethod);
 

Parameters:

factory - A factory instance to create elements.

TemplateGenerator

public TemplateGenerator(org.w3c.dom.Document factory,
                         java.lang.String defaultDigestMethod,
                         java.lang.String c14nURI,
                         java.lang.String signatureMethod,
                         KeyInfoGenerator keyGen)

Deprecated.

Creates new TemplateGenerator instance. The following two code fragments are equivalent:

sig = new TemplateGenerator(factory, digest, c14n, sigmethod, keygen);

 sig = new TemplateGenerator();
 sig.setDocument(factory);
 sig.setDefaultDigestMethod(digest);
 sig.setCanonicalizer(c14n);
 sig.setSignatureMethod(sigmethod);
 sig.setKeyInfoGenerator(keygen);
 

Parameters:

factory - A factory instance to create elements.

Method Detail

setDefaultDigestMethod

public void setDefaultDigestMethod(java.lang.String algorithmURI)

See Also:

Reference.setDigestMethod(java.lang.String), Reference.getDigestMethod()

createReference

public Reference createReference(java.lang.String uri)

for detached resource, or for enveloping resource (enveloped signature).

createReference

public Reference createReference(org.w3c.dom.Element objectElement)

for enveloped resource (enveloping signature).

Parameters:

objectElement - An Object element. It must have an Id attribute.

createReference

public Reference createReference(org.w3c.dom.Element objectElement,
                                 java.lang.String idname)

for enveloped resource (enveloping signature).

Parameters:

objectElement - An Object element. It may have no Id attribute and idname points another element in objectElement.

wrapWithObject

public org.w3c.dom.Element wrapWithObject(org.w3c.dom.Node resource,
                                          java.lang.String idname)

Creates Object element that wraps resource and has idname as the Id attribute.

addReference

public void addReference(Reference obj)

removeAllReferences

public void removeAllReferences()

setCanonicalizer

public void setCanonicalizer(java.lang.String algorithmURI)

setSignatureMethod

public void setSignatureMethod(java.lang.String algorithmURI)

setKeyInfoGenerator

public void setKeyInfoGenerator(KeyInfoGenerator keyGen)

Deprecated. Use KeyInfo#insertTo

setDocument

public void setDocument(org.w3c.dom.Document factory)

getDocument

public org.w3c.dom.Document getDocument()

setPrefix

public void setPrefix(java.lang.String pre)

getPrefix

public java.lang.String getPrefix()

getSignedInfoElement

public org.w3c.dom.Element getSignedInfoElement()

Creates SignedInfo structure without the signature value and digest values.

getManifestElement

public org.w3c.dom.Element getManifestElement()

Creates Manifest structure without digest values.

getSignatureElement

public org.w3c.dom.Element getSignatureElement()

Creates Signature structure without digest values and a signature value. After calling this method, any other operations against this instance have no effects to the resultant element.