Package org.apache.xml.security.signature

Class SignatureProperties

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.utils.SignatureElementProxy

org.apache.xml.security.signature.SignatureProperties

public class SignatureProperties
extends SignatureElementProxy

Handles <ds:SignatureProperties> elements This Element holds SignatureProperty that contian additional information items concerning the generation of the signature. for example, data-time stamp, serial number of cryptographic hardware.

Author:

Christian Geuer-Pollmann

Field Summary

Fields inherited from class org.apache.xml.security.utils.ElementProxy

_baseURI, _constructionElement, _doc, _state, MODE_CREATE, MODE_DECRYPT, MODE_ENCRYPT, MODE_PROCESS, MODE_SIGN, MODE_UNKNOWN, MODE_VERIFY

Constructor Summary

Constructors

Constructor	Description
SignatureProperties(Document doc)	Constructor SignatureProperties
SignatureProperties(Element element, String BaseURI)	Constructs SignatureProperties from Element

Method Summary

Modifier and Type	Method	Description
void	addSignatureProperty(SignatureProperty sp)	Method addSignatureProperty
String	getBaseLocalName()	Returns the localname of the Elements of the sub-class.
String	getId()	Returns the Id attribute
int	getLength()	Return the nonnegative number of added SignatureProperty elements.
SignatureProperty	item(int i)	Return the ith SignatureProperty.
void	setId(String Id)	Sets the Id attribute

Methods inherited from class org.apache.xml.security.utils.SignatureElementProxy

getBaseNamespace

Methods inherited from class org.apache.xml.security.utils.ElementProxy

addBase64Element, addBase64Text, addBigIntegerElement, addText, addTextElement, createElementForFamily, getBaseURI, getBigIntegerFromChildElement, getBytesFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getTextFromChildElement, getTextFromTextChild, guaranteeThatElementInCorrectSpace, length, setDefaultPrefix, setElement, setXPathNamespaceContext

Methods inherited from class java.lang.Object

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

Constructor Details

SignatureProperties

public SignatureProperties(Document doc)

Constructor SignatureProperties

Parameters:

doc -

SignatureProperties

public SignatureProperties(Element element,
 String BaseURI)
                    throws XMLSecurityException

Constructs SignatureProperties from Element

Parameters:

element - SignatureProperties elementt

BaseURI - the URI of the resource where the XML instance was stored

Throws:

XMLSecurityException

Method Details

getLength

public int getLength()

Return the nonnegative number of added SignatureProperty elements.

Returns:

the number of SignatureProperty elements

item

public SignatureProperty item(int i)
                       throws XMLSignatureException

Return the i^th SignatureProperty. Valid i values are 0 to {link@ getSize}-1.

Parameters:

i - Index of the requested SignatureProperty

Returns:

the i^th SignatureProperty

Throws:

XMLSignatureException

setId

public void setId(String Id)

Sets the Id attribute

Parameters:

Id - the Id attribute

getId

public String getId()

Returns the Id attribute

Returns:

the Id attribute

addSignatureProperty

public void addSignatureProperty(SignatureProperty sp)

Method addSignatureProperty

Parameters:

sp -

getBaseLocalName

public String getBaseLocalName()

Description copied from class: ElementProxy

Returns the localname of the Elements of the sub-class.

Specified by:

getBaseLocalName in class ElementProxy

Returns:

the localname of the Elements of the sub-class.