org.apache.xml.security.encryption
Class CarriedKeyName

java.lang.Object
  |
  +--org.apache.xml.security.utils.ElementProxy
        |
        +--org.apache.xml.security.utils.EncryptionElementProxy
              |
              +--org.apache.xml.security.encryption.CarriedKeyName

public class CarriedKeyName
extends EncryptionElementProxy

This class maps to the xenc:CarriedKeyName element.

Author:
$Author: vdkoogh $

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
CarriedKeyName(org.w3c.dom.Document doc, java.lang.String carriedKeyName)
          Constructor CarriedKeyName
CarriedKeyName(org.w3c.dom.Element element, java.lang.String BaseURI)
          Constructor CarriedKeyName
 
Method Summary
 java.lang.String getBaseLocalName()
          Returns the localname of the Elements of the sub-class.
 java.lang.String getCarriedKeyName()
          Method getCarriedKeyName
 boolean matchesAgainstKeyInfo(KeyInfo ki)
          Return true if the CarriedKeyName carries a key which os references by the KeyInfo.
 void setCarriedKeyName(java.lang.String carriedKeyName)
          Method setCarriedKeyName
 
Methods inherited from class org.apache.xml.security.utils.EncryptionElementProxy
getBaseNamespace
 
Methods inherited from class org.apache.xml.security.utils.ElementProxy
addBase64Element, addBase64Text, addBigIntegerElement, addText, addTextElement, createElementForFamily, getBaseURI, getBigIntegerFromChildElement, getBytesFromChildElement, getBytesFromTextChild, getChildElementLocalName, 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 Detail

CarriedKeyName

public CarriedKeyName(org.w3c.dom.Document doc,
                      java.lang.String carriedKeyName)
Constructor CarriedKeyName

Parameters:
doc -
carriedKeyName -

CarriedKeyName

public CarriedKeyName(org.w3c.dom.Element element,
                      java.lang.String BaseURI)
               throws XMLSecurityException
Constructor CarriedKeyName

Parameters:
element -
BaseURI -
Throws:
XMLSecurityException
Method Detail

getCarriedKeyName

public java.lang.String getCarriedKeyName()
Method getCarriedKeyName


setCarriedKeyName

public void setCarriedKeyName(java.lang.String carriedKeyName)
Method setCarriedKeyName

Parameters:
carriedKeyName -

matchesAgainstKeyInfo

public boolean matchesAgainstKeyInfo(KeyInfo ki)
                              throws XMLSecurityException
Return true if the CarriedKeyName carries a key which os references by the KeyInfo.

Parameters:
ki -
Returns:
true if the CarriedKeyName carries a key which os references by the KeyInfo
Throws:
XMLSecurityException

getBaseLocalName

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