iaik.ixsil.core

Interface SignerManifest

public interface SignerManifest

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

See Also:

Signer.createManifest()

Method Summary

Methods

Modifier and Type	Method and Description
SignerReference	addReference(SignerReference reference) Adds a reference object to the manifest.
void	computeDigestValues() Computes the digest value for each reference of the manifest.
SignerReference	createReference() Used by the application to create an empty reference object.
java.lang.String	getId() Gets the Id attribute value of the Manifest element.
SignerReference[]	getSignerReferences() Gets an array containing all reference objects registered in the context of this manifest.
SignerReference	removeReference(SignerReference reference) Removes the specified reference from this signature property container.
void	setId(java.lang.String id) Sets the Id attribute value of the Manifest element.
org.w3c.dom.Element	toElement() Gets a DOM element representation of this manifest.

Method Detail

setId

void setId(java.lang.String id)

Sets the Id attribute value of the Manifest 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. If the manifest has already been added to a Object container, this method will have no effect.

Parameters:

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

getId

java.lang.String getId()

Gets the Id attribute value of the Manifest element.

Returns:

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

getSignerReferences

SignerReference[] getSignerReferences()

Gets an array containing all reference objects registered in the context of this manifest.

Returns:

an array of interfaces to the registered reference objects, fitting for the signing use case, or null if there are no references available.

createReference

SignerReference createReference()
                                throws ManifestException

Used by the application to create an empty reference object. This method does not return the implementation class, but an interface which reflects a view of the reference class fitting for the signing use case.

Returns:

an interface to the newly created reference object, fitting for the signing use case.

Throws:

ManifestException - if creating the reference object fails for any reason.

addReference

SignerReference addReference(SignerReference reference)
                             throws ManifestException

Adds a reference object to the manifest. If the reference has already been added to another container ((@link SignerManifest} or SignerSignedInfo), this method will have no effect. If the manifest has already been added to an Object container, this method has also no effect.

Parameters:

reference - The reference to be added. Must not be null.

Returns:

the added reference, or null if adding the reference is impossible (see above).

Throws:

ManifestException - if a Reference without its URI attribute set is to be added.

computeDigestValues

void computeDigestValues()
                         throws ManifestException

Computes the digest value for each reference of the manifest. This method must be invoked when the manifest has been configured completely, i. e. when all intended references have been added to the manifest.

Throws:

ManifestException - if computing the digest value for one of the manifest's references fails for any reason.

removeReference

SignerReference removeReference(SignerReference reference)

Removes the specified reference from this signature property container. This is only possible as long as the manifest has not been incorporated into an Object container. If the reference is not in the manifest, nothing will happen.

Parameters:

reference - The reference to be removed. Must not be null.

Returns:

the removed reference, or null if the specified reference is not in this manifest or if the manifest has already been incorporated into an Object container.

toElement

org.w3c.dom.Element toElement()

Gets a DOM element representation of this manifest. Please note, that the generation of the resulting DOM element does not preserve DOM implementation internals such as mechanisms to keep track of ID attributes.

Returns:

a DOM element representation of this manifest.