iaik.ixsil.core

Class SignatureProperties

java.lang.Object

iaik.ixsil.core.SignatureProperties

All Implemented Interfaces:

SignerSignatureProperties, VerifierSignatureProperties

public class SignatureProperties
extends java.lang.Object
implements SignerSignatureProperties, VerifierSignatureProperties

Internal implementation of a XML Signature signature property container (XML element SignatureProperites). Such an element contains an arbitrary number of (at least one) SignatureProperty elements. Therefore this class provides methods to add and remove such signature properties. A single attribute may be specified for the SignatureProperties element, namely "Id".

The application will not work with this implementation class, but with one of two interfaces, depending on the actual use case. The interfaces provide specialized views on this class: SignerSignatureProperties is used for the signing use case, VerifierSignatureProperties is used for the verification use case.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addedToContainer_ Signals if this signature property container has already been incorporated into a Object container.
protected java.lang.String	id_ Value for the "Id" attribute of the XML SignatureProperties element.
protected java.util.List	signatureProperties_ A list of all signature properties stored in this signature property container.
protected org.w3c.dom.Element	signaturePropertiesDOMElem_ DOM Element representation of the signature properties container.
protected java.util.Set	signaturePropertyElemsWithID_ A set of all signature properties stored in this container which have its Id attribute set.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SignatureProperties(org.w3c.dom.Document owningDoc, java.lang.String id) Creates a new, empty signature property container.
protected	SignatureProperties(org.w3c.dom.Element propertiesDOMElem, org.w3c.dom.Document owningDoc) Creates a new signature property container from the specified DOM element representation.

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.

Methods inherited from class java.lang.Object

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

Field Detail

id_

protected java.lang.String id_

Value for the "Id" attribute of the XML SignatureProperties element.

signaturePropertiesDOMElem_

protected org.w3c.dom.Element signaturePropertiesDOMElem_

DOM Element representation of the signature properties container.

signatureProperties_

protected java.util.List signatureProperties_

A list of all signature properties stored in this signature property container.

signaturePropertyElemsWithID_

protected java.util.Set signaturePropertyElemsWithID_

A set of all signature properties stored in this container which have its Id attribute set.

addedToContainer_

protected boolean addedToContainer_

Signals if this signature property container has already been incorporated into a Object container.

Constructor Detail

SignatureProperties

protected SignatureProperties(org.w3c.dom.Element propertiesDOMElem,
                              org.w3c.dom.Document owningDoc)

Creates a new signature property container from the specified DOM element representation.

Parameters:

propertiesDOMElem - A DOM element representation of the signature property container.

owningDoc - The DOM Document which should be used to create necessary DOM nodes.

SignatureProperties

protected SignatureProperties(org.w3c.dom.Document owningDoc,
                              java.lang.String id)

Creates a new, empty signature property container.

Parameters:

owningDoc - The DOM Document which should be used to create necessary DOM nodes.

id - The value for the Id attribute. If it equals null

Method Detail

createSignatureProperty

public 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.

Specified by:

createSignatureProperty in interface SignerSignatureProperties

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

public 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.

Specified by:

createSignatureProperty in interface SignerSignatureProperties

Parameters:

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

Returns:

the newly created signature property.

createSignatureProperty

public 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.

Specified by:

createSignatureProperty in interface SignerSignatureProperties

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

public 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.

Specified by:

addSignatureProperty in interface SignerSignatureProperties

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

public 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.

Specified by:

removeSignatureProperty in interface SignerSignatureProperties

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

public SignatureProperty[] getSignatureProperties()

Gets an array containing all signature properties of this container.

Specified by:

getSignatureProperties in interface SignerSignatureProperties

Specified by:

getSignatureProperties in interface VerifierSignatureProperties

Returns:

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

getId

public java.lang.String getId()

Gets the value of the Id attribute.

Specified by:

getId in interface SignerSignatureProperties

Specified by:

getId in interface VerifierSignatureProperties

Returns:

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

setId

public 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.

Specified by:

setId in interface SignerSignatureProperties

Parameters:

id - The Id attribute value.

toElement

public 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.

Specified by:

toElement in interface SignerSignatureProperties

Specified by:

toElement in interface VerifierSignatureProperties

Returns:

a DOM element representation of this signature property container.