com.helger.xmldsig

Class XMLDSigCreator

java.lang.Object

com.helger.xmldsig.XMLDSigCreator

@Immutable
public class XMLDSigCreator
extends Object

Utility class for applying a signature to ebInterface documents.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NS_PREFIX

Constructor Summary

Constructors

Constructor and Description
XMLDSigCreator()

Method Summary

Modifier and Type	Method and Description
void	applyXMLDSigAsFirstChild(PrivateKey aPrivateKey, X509Certificate aCertificate, Document aDocument) Apply an XMLDSig onto the passed document.
protected CanonicalizationMethod	createCanonicalizationMethod()
protected Reference	createDefaultReference()
protected Transform	createDefaultTransform()
protected DigestMethod	createDigestMethod()
KeyInfo	createKeyInfo(X509Certificate aCertificate)
protected com.helger.commons.collection.impl.ICommonsList<Reference>	createReferenceList()
protected SignatureMethod	createSignatureMethod()
SignedInfo	createSignedInfo()
protected List<Transform>	createTransformList()
XMLSignature	createXMLSignature(X509Certificate aCertificate)
XMLSignature	createXMLSignature(X509Certificate aCertificate, List<? extends XMLObject> aObjects, String sID, String sSignatureValueID)
protected String	getCanonicalizationMethod()
protected String	getDefaultReferenceID()
protected String	getDefaultReferenceType()
protected String	getDefaultReferenceURI()
protected String	getDefaultTransform()
protected String	getDigestMethod()
XMLSignatureFactory	getSignatureFactory()
protected String	getSignatureMethod()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NS_PREFIX

public static final String DEFAULT_NS_PREFIX

See Also:

Constant Field Values

Constructor Detail

XMLDSigCreator

public XMLDSigCreator()

Method Detail

getSignatureFactory

@Nonnull
public final XMLSignatureFactory getSignatureFactory()

getDefaultReferenceURI

@Nullable
 @OverrideOnDemand
protected String getDefaultReferenceURI()

getDigestMethod

@Nonnull
 @OverrideOnDemand
protected String getDigestMethod()
                                                        throws Exception

Throws:

Exception

createDigestMethod

@Nonnull
 @OverrideOnDemand
protected DigestMethod createDigestMethod()
                                                                 throws Exception

Throws:

Exception

getDefaultTransform

@Nonnull
 @OverrideOnDemand
protected String getDefaultTransform()
                                                            throws Exception

Throws:

Exception

createDefaultTransform

@Nonnull
 @OverrideOnDemand
protected Transform createDefaultTransform()
                                                                  throws Exception

Throws:

Exception

createTransformList

@Nonnull
 @OverrideOnDemand
protected List<Transform> createTransformList()
                                                                     throws Exception

Throws:

Exception

getDefaultReferenceType

@Nullable
 @OverrideOnDemand
protected String getDefaultReferenceType()
                                                                 throws Exception

Throws:

Exception

getDefaultReferenceID

@Nullable
 @OverrideOnDemand
protected String getDefaultReferenceID()
                                                               throws Exception

Throws:

Exception

createDefaultReference

@Nonnull
 @ReturnsMutableCopy
protected Reference createDefaultReference()
                                                                    throws Exception

Throws:

Exception

createReferenceList

@Nonnull
 @ReturnsMutableCopy
protected com.helger.commons.collection.impl.ICommonsList<Reference> createReferenceList()
                                                                                                                  throws Exception

Throws:

Exception

getCanonicalizationMethod

@Nonnull
 @OverrideOnDemand
protected String getCanonicalizationMethod()
                                                                  throws Exception

Throws:

Exception

createCanonicalizationMethod

@Nonnull
 @OverrideOnDemand
protected CanonicalizationMethod createCanonicalizationMethod()
                                                                                     throws Exception

Throws:

Exception

getSignatureMethod

@Nonnull
 @OverrideOnDemand
protected String getSignatureMethod()
                                                           throws Exception

Throws:

Exception

createSignatureMethod

@Nonnull
 @OverrideOnDemand
protected SignatureMethod createSignatureMethod()
                                                                       throws Exception

Throws:

Exception

createSignedInfo

@Nonnull
public SignedInfo createSignedInfo()
                                      throws Exception

Throws:

Exception

createKeyInfo

@Nonnull
public KeyInfo createKeyInfo(@Nonnull
                                       X509Certificate aCertificate)
                                throws KeyException

Throws:

KeyException

createXMLSignature

@Nonnull
 @OverrideOnDemand
public XMLSignature createXMLSignature(@Nonnull
                                                                     X509Certificate aCertificate)
                                                              throws Exception

Throws:

Exception

createXMLSignature

@Nonnull
 @OverrideOnDemand
public XMLSignature createXMLSignature(@Nonnull
                                                                     X509Certificate aCertificate,
                                                                     @Nullable
                                                                     List<? extends XMLObject> aObjects,
                                                                     @Nullable
                                                                     String sID,
                                                                     @Nullable
                                                                     String sSignatureValueID)
                                                              throws Exception

Throws:

Exception

applyXMLDSigAsFirstChild

public void applyXMLDSigAsFirstChild(@Nonnull
                                     PrivateKey aPrivateKey,
                                     @Nonnull
                                     X509Certificate aCertificate,
                                     @Nonnull
                                     Document aDocument)
                              throws Exception

Apply an XMLDSig onto the passed document.

Parameters:

aPrivateKey - The private key used for signing. May not be null.

aCertificate - The certificate to be used. May not be null.

aDocument - The document to be signed. The signature will always be the first child element of the document element. The document may not contains any disg:Signature element. This element is inserted manually.

Throws:

Exception - In case something goes wrong

See Also:

createXMLSignature(X509Certificate)