iaik.ixsil.core

Interface SignerSignatureProperties

All Known Implementing Classes:

SignatureProperties

public interface SignerSignatureProperties

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

See Also:

Signer.createSignatureProperties()

Method Summary

Modifier and Type	Method and Description
SignatureProperty	addSignatureProperty(SignatureProperty signatureProperty) Appends a signature property to the list maintained by this signature property container.
SignatureProperty	createSignatureProperty(org.w3c.dom.DocumentFragment content) Creates a new signature property.
SignatureProperty	createSignatureProperty(org.w3c.dom.Element content) Creates a new signature property.
SignatureProperty	createSignatureProperty(java.lang.String content) Creates a new signature property.
java.lang.String	getId() Gets the value of the Id attribute.
SignatureProperty[]	getSignatureProperties() Gets an array containing all signature properties of this container.
SignatureProperty	removeSignatureProperty(SignatureProperty signatureProperty) Removes the specified signature property from this signature property container.
void	setId(java.lang.String id) Sets the Id attribute value of the signature property container.
org.w3c.dom.Element	toElement() Gets a DOM element representation of this signature property container.

Method Detail

createSignatureProperty

SignatureProperty createSignatureProperty(java.lang.String content)

Creates a new signature property. A DOM text node will be created from the specified content String and set as child of the SignatureProperty element.

Parameters:

content - The value for the DOM Text node to be set as child of the SignatureProperty element.

Returns:

the newly created signature property.

createSignatureProperty

SignatureProperty createSignatureProperty(org.w3c.dom.Element content)

Creates a new signature property. The specified DOM element will be added as child of the SignatureProperty element.

Parameters:

content - Contains the DOM element which will become the only child node of the SignatureProperty element.

Returns:

the newly created signature property.

createSignatureProperty

SignatureProperty createSignatureProperty(org.w3c.dom.DocumentFragment content)

Creates a new signature property. The children of the specified document fragment will be added as children of the SignatureProperty element.

Parameters:

content - Contains the DOM document fragment which children will become the child nodes of the SignatureProperty element.

Returns:

the newly created signature property.

addSignatureProperty

SignatureProperty addSignatureProperty(SignatureProperty signatureProperty)

Appends a signature property to the list maintained by this signature property container. This is only possible as long as the signature property container has not been incorporated into an Object container. If the signature property is already in the signature property container, this method will have no effect. If the signature property has already been added to a signature property container, this method will also have no effect.

Parameters:

signatureProperty - The signature property to be appended. Must not be null.

Returns:

the appended signature property, or null if the specified signature property is already in the container, of if the signature property container has already been incorporated into an Object container, or if the signature property has already been added to a signature property container, or if the signature property does not have its Target attribute set.

removeSignatureProperty

SignatureProperty removeSignatureProperty(SignatureProperty signatureProperty)

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

Parameters:

signatureProperty - The signature property to be removed. Must not be null.

Returns:

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

getSignatureProperties

SignatureProperty[] getSignatureProperties()

Gets an array containing all signature properties of this container.

Returns:

an array containing all signature properties of this container, or null if there are no properties in this container.

getId

java.lang.String getId()

Gets the value of the Id attribute.

Returns:

The value of the Id attribute, or null if the attribute does not exist.

setId

void setId(java.lang.String id)

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

Parameters:

id - The Id attribute value.

toElement

org.w3c.dom.Element toElement()

Gets a DOM element representation of this signature property container. 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 signature property container.