XENCEncryptedKey Class Reference
[XML Encryption Implementation]

#include <XENCEncryptedKey.hpp>

Inheritance diagram for XENCEncryptedKey:

[legend]Collaboration diagram for XENCEncryptedKey:

[legend]List of all members.

---

Detailed Description

Interface definition for the EncryptedKey object.

The <EncryptedKey> element is an abstract type which builds on the EncryptedType element for encrypted data (as opposed to encrypted data).

In general, this class should not be used directly. For most applications, callers will want to use the XENCCipher class instead.

The schema definition for EncryptedKey is as follows:

  <element name='EncryptedKey' type='xenc:EncryptedKeyType'/>
  <complexType name='EncryptedKeyType'>
    <complexContent>
      <extension base='xenc:EncryptedType'>
        <sequence>
          <element ref='xenc:ReferenceList' minOccurs='0'/>
          <element name='CarriedKeyName' type='string' minOccurs='0'/>
        </sequence>
        <attribute name='Recipient' type='string' use='optional'/>
      </extension>
    </complexContent>   
  </complexType>

Constructors and Destructors
virtual	~XENCEncryptedKey ()
	XENCEncryptedKey (const XSECEnv *env)
Public Member Functions
EncryptedKey Specific Getter Methods
virtual const XMLCh *	getCarriedKeyName (void) const =0
	Get the CarriedKeyName.
virtual const XMLCh *	getRecipient (void) const =0
	Get the Recipient name.
EncryptedKey Specific Setter Methods
virtual void	setCarriedKeyName (const XMLCh *name)=0
	Set the CarriedKeyName.
virtual void	setRecipient (const XMLCh *recipient)=0
	Set the Recipient name.

---

Constructor & Destructor Documentation

XENCEncryptedKey::XENCEncryptedKey (  const XSECEnv *  env  )  [inline, protected]

virtual XENCEncryptedKey::~XENCEncryptedKey (   )  [inline, virtual]

---

Member Function Documentation

virtual const XMLCh* XENCEncryptedKey::getCarriedKeyName (  void   )  const [pure virtual]

Get the CarriedKeyName. EncryptedKey elements MAY have a CarriedKeyName element that links the EncryptedKey to a KeyName KeyInfo element in another EncryptedKey or EncryptedData element. This method allows applications to retrieve the Carried Key Name for the particular EncryptedKey Returns: A pointer (owned by the library) to the CarriedKeyName string (or NULL if none)

virtual const XMLCh* XENCEncryptedKey::getRecipient (  void   )  const [pure virtual]

Get the Recipient name. EncryptedKey elements MAY have a Recipient Attribute on the main EncryptedKey element that provide a hint to the application as to who the recipient of the key is. This method returns this string in cases where it has been provided Returns: A pointer (owned by the library) to the Recipient string (or NULL if none provided).

virtual void XENCEncryptedKey::setCarriedKeyName (  const XMLCh *  name  )  [pure virtual]

Set the CarriedKeyName. EncryptedKey elements MAY have a CarriedKeyName element that links the EncryptedKey to a KeyName KeyInfo element in another EncryptedKey or EncryptedData element. This method allows applications to set the Carried Key Name for the particular EncryptedKey Parameters: name  String to set in the CarriedKeyName element

virtual void XENCEncryptedKey::setRecipient (  const XMLCh *  recipient  )  [pure virtual]

Set the Recipient name. EncryptedKey elements MAY have a Recipient Attribute on the main EncryptedKey element that provide a hint to the application as to who the recipient of the key is. This method sets the Recipient string Parameters: recipient  String to set in the Recipient attribute

---

The documentation for this class was generated from the following file:

• XENCEncryptedKey.hpp

---