Module org.apache.santuario.xmlsec

Package org.apache.xml.security.encryption.keys

Class KeyInfoEnc

java.lang.Object

org.apache.xml.security.utils.ElementProxy

org.apache.xml.security.keys.KeyInfo

org.apache.xml.security.encryption.keys.KeyInfoEnc

Direct Known Subclasses:

OriginatorKeyInfo, RecipientKeyInfo

public class KeyInfoEnc
extends KeyInfo

This class is the extension of the KeyInfo class. The KeyInfo implements XML structures defined in XML Signature standards, and this class extends it for handling XML Element types defined by the XML encryption standards, such as AgreementMethod.

Field Summary

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

baseURI

Constructor Summary

Constructors

Constructor	Description
KeyInfoEnc(Document doc)
KeyInfoEnc(Element element, String baseURI)

Method Summary

Modifier and Type	Method	Description
void	add(AgreementMethod agreementMethod)	Method add AgreementMethod to the KeyInfo
boolean	containsAgreementMethod()	Method containsAgreementMethod returns true if the KeyInfo contains a AgreementMethod node
AgreementMethod	itemAgreementMethod(int i)	Method itemAgreementMethod
int	lengthAgreementMethod()	Method lengthAgreementMethod

Methods inherited from class org.apache.xml.security.keys.KeyInfo

add, add, add, add, add, add, add, add, add, add, add, add, add, addDEREncodedKeyValue, addKeyInfoReference, addKeyName, addKeyValue, addKeyValue, addMgmtData, addRetrievalMethod, addStorageResolver, addUnknownElement, containsDEREncodedKeyValue, containsKeyInfoReference, containsKeyName, containsKeyValue, containsMgmtData, containsPGPData, containsRetrievalMethod, containsSPKIData, containsUnknownElement, containsX509Data, getBaseLocalName, getBaseNamespace, getId, getPrivateKey, getPublicKey, getSecretKey, getX509Certificate, isEmpty, itemDEREncodedKeyValue, itemEncryptedKey, itemKeyInfoReference, itemKeyName, itemKeyValue, itemMgmtData, itemPGPData, itemRetrievalMethod, itemSPKIData, itemUnknownElement, itemX509Data, lengthDEREncodedKeyValue, lengthKeyInfoReference, lengthKeyName, lengthKeyValue, lengthMgmtData, lengthPGPData, lengthRetrievalMethod, lengthSPKIData, lengthUnknownElement, lengthX509Data, registerInternalKeyResolver, setId, setSecureValidation

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

addBase64Element, addBase64Text, addBigIntegerElement, addReturnToSelf, addText, addTextElement, appendOther, appendSelf, appendSelf, createElementForFamily, createElementForFamilyLocal, createText, getBaseURI, getBigIntegerFromChildElement, getBytesFromTextChild, getDefaultPrefix, getDocument, getElement, getElementPlusReturns, getFirstChild, getLocalAttribute, getTextFromChildElement, getTextFromTextChild, length, registerDefaultPrefixes, setDefaultPrefix, setDocument, setElement, setElement, setLocalAttribute, setLocalIdAttribute, setXPathNamespaceContext

Methods inherited from class java.lang.Object

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

Constructor Details

KeyInfoEnc

public KeyInfoEnc(Document doc)

See Also:

• KeyInfo

KeyInfoEnc

public KeyInfoEnc(Element element,
 String baseURI)
           throws XMLSecurityException

Throws:

XMLSecurityException

See Also:

• KeyInfo

Method Details

add

public void add(AgreementMethod agreementMethod)

Method add AgreementMethod to the KeyInfo

Parameters:

agreementMethod - the AgreementMethod to be added. The AgreementMethod must extend class ElementProxy

lengthAgreementMethod

public int lengthAgreementMethod()

Method lengthAgreementMethod

Returns:

the number of the AgreementMethod tags

itemAgreementMethod

public AgreementMethod itemAgreementMethod(int i)
                                    throws XMLSecurityException

Method itemAgreementMethod

Parameters:

i - index of the AgreementMethod element

Returns:

the i(th) AgreementMethod proxy element or null if the index is too big

Throws:

XMLSecurityException - if the element with AgreementMethod exists but with wrong namespace

containsAgreementMethod

public boolean containsAgreementMethod()

Method containsAgreementMethod returns true if the KeyInfo contains a AgreementMethod node

Returns:

true if the KeyInfo contains a AgreementMethod node else false