iaik.ixsil.core

Interface SignerSignature

public interface SignerSignature

This interface provides a specialized view on a Signature. This view is used by the application in the signature creation use case.

See Also:

Signer.getSignature()

Method Summary

Methods

Modifier and Type	Method and Description
Object	addObject(Object object) Adds the specified object container to the list of object containers in this signature.
void	computeDigestInputs() Computed the digest inputs for all references of this signature.
Object	createObject(org.w3c.dom.DocumentFragment content) Creates an object container with the specified DOM document fragment as its content.
Object	createObject(org.w3c.dom.Element content) Creates an object container with the specified DOM element as its content.
Object	createObject(SignerManifest manifest) Creates an object container with the specified manifest as its content.
Object	createObject(SignerSignatureProperties signatureProperties) Creates an object container with the specified signature properties container as its content.
Object	createObject(java.lang.String content) Creates an object container with the specified string as its content.
java.lang.String	getId() Gets the Id attribute value of the Signature element.
Object[]	getObjects() Gets all object containers which are part of this signature.
org.w3c.dom.Element	getSignatureDOMElement() Returns the DOM element of this XML signature structure; i.e.
SignerSignedInfo	getSignerSignedInfo() Gets an interface to the signed information object for the signing use case.
Object	removeObject(Object object) Removes an object container from the list of object containers in this signature.
void	setId(java.lang.String id) Sets the Id attribute value of the Signature element.
void	setKeyManager(SignerKeyManager keyManager) Can be used by the application to set the key manager for the signing use case.
void	sign() Computes the signature value for this signature.

Method Detail

setId

void setId(java.lang.String id)

Sets the Id attribute value of the Signature element. If the attribute has already been set, it will be overwritten. If the id parameter equals null, the possibly existing Id attribute will be removed.

Parameters:

id - The value for the Id attribute of the Signature element.

getId

java.lang.String getId()

Gets the Id attribute value of the Signature element.

Returns:

the attribute value or null if the Id attribute is not available.

getSignerSignedInfo

SignerSignedInfo getSignerSignedInfo()

Gets an interface to the signed information object for the signing use case.

Returns:

an interface to the signed information object for the signing use case.

setKeyManager

void setKeyManager(SignerKeyManager keyManager)
                   throws SignatureException

Can be used by the application to set the key manager for the signing use case. This key manager is used to get the DOM representation for the KeyInfo element. If no key manager will be set, no KeyInfo element is incorporated into the XML signature.

Parameters:

keyManager - The key manager to be used in the signing use case.

Throws:

SignatureException - if usage of the keyManager argument leads to an exception.

createObject

Object createObject(java.lang.String content)

Creates an object container with the specified string as its content. A DOM text is created from the string value. The text node will be set as the only child of the Object DOM element.

Parameters:

content - The string value for the DOM text node. Must not be null.

Returns:

the created object container.

createObject

Object createObject(org.w3c.dom.DocumentFragment content)

Creates an object container with the specified DOM document fragment as its content. All children of the DOM document fragment will be set as children of the Object DOM element.

Parameters:

content - The DOM document fragment whose children will be set as the Object DOM element's children. Must not be null.

Returns:

the created object container.

createObject

Object createObject(org.w3c.dom.Element content)

Creates an object container with the specified DOM element as its content. The specified DOM element will be set as the only child of the Object DOM element.

Parameters:

content - The DOM element which will be set as the only child of the Object DOM element. Must not be null.

Returns:

the created object container.

createObject

Object createObject(SignerSignatureProperties signatureProperties)

Creates an object container with the specified signature properties container as its content.

Parameters:

signatureProperties - The signature property container which is set as the content of this object container. Must not be null.

Returns:

the created object container.

createObject

Object createObject(SignerManifest manifest)

Creates an object container with the specified manifest as its content.

Parameters:

manifest - The manifest which is set as the content of this object container. Must not be null.

Returns:

the created object container.

addObject

Object addObject(Object object)

Adds the specified object container to the list of object containers in this signature. If the object has already been added to a signature, this method will have no effect.

Parameters:

object - The object container to be added to the list. Must not be null.

Returns:

the added object container, or null if the object container has already been added to a signature.

getObjects

Object[] getObjects()

Gets all object containers which are part of this signature.

Returns:

An Object array or null if there are no object containers available.

removeObject

Object removeObject(Object object)

Removes an object container from the list of object containers in this signature. If the specified object container is not in the list, this method will have no effect.

Parameters:

object - The object container to be removed from the list. Must not be null.

Returns:

the removed object container, or null, if the container does not exist in the list.

computeDigestInputs

void computeDigestInputs()
                         throws SignatureException

Computed the digest inputs for all references of this signature. This method can be invoked by the application when the signature has been configured completely, if the application needs access to the digest input of a reference of this signature.

The following example shows the necessary steps after the signature has been configured completely:

 SignerSignature mySignature;
 ...
 mySignature.computeDigestInputs();
 SignerSignedInfo mySignedInfo = mySignature.getSignerSignedInfo();
 SignerReference[] myReferences = mySignedInfo.getSignerReferences();
 for (int i = 0; i < myReferences.length; i++)
 {
   java.io.InputStream explicitData =
     myReferences[i].getExplicitData(SignerReference.EXPLICITDATATYPE_DIGESTINPUT_);
 }
 ...
 mySignature.sign();
 

Throws:

SignatureException - if computing the digest input for one of the signature's references fails.

sign

void sign()
          throws SignatureException

Computes the signature value for this signature. This method must be invoked by the application when the signature has been configured completely.

Throws:

SignatureException - if no canonicalization algorithm has been specified, or if no signature algorithm has been specified, or if computing the digest value for one of the signature's references failed, or if computing the signature fails for any other reason.

getSignatureDOMElement

org.w3c.dom.Element getSignatureDOMElement()

Returns the DOM element of this XML signature structure; i.e. the element with the name dsgi:Signature.

Returns:

The DOM element of this XML signature structure.