Module org.apache.santuario.xmlsec

Package org.apache.xml.security.encryption

Interface EncryptedKey

All Superinterfaces:

EncryptedType

public interface EncryptedKey
extends EncryptedType

The EncryptedKey element is used to transport encryption keys from the originator to a known recipient(s). It may be used as a stand-alone XML document, be placed within an application document, or appear inside an EncryptedData element as a child of a ds:KeyInfo element. The key value is always encrypted to the recipient(s). When EncryptedKey is decrypted the resulting octets are made available to the EncryptionMethod algorithm without any additional processing.

Its schema definition is as follows:

Method Summary

Modifier and Type	Method	Description
String	getCarriedName()	Returns a user readable name with the key value.
String	getRecipient()	Returns a hint as to which recipient this encrypted key value is intended for.
ReferenceList	getReferenceList()	Returns pointers to data and keys encrypted using this key.
void	setCarriedName(String name)	Sets the carried name.
void	setRecipient(String recipient)	Sets the recipient for this EncryptedKey.
void	setReferenceList(ReferenceList list)	Sets the ReferenceList to the EncryptedKey.

Methods inherited from interface org.apache.xml.security.encryption.EncryptedType

getCipherData, getEncoding, getEncryptionMethod, getEncryptionProperties, getId, getKeyInfo, getMimeType, getType, setEncoding, setEncryptionMethod, setEncryptionProperties, setId, setKeyInfo, setMimeType, setType

Method Detail

getRecipient

String getRecipient()

Returns a hint as to which recipient this encrypted key value is intended for.

Returns:

the recipient of the EncryptedKey.

setRecipient

void setRecipient(String recipient)

Sets the recipient for this EncryptedKey.

Parameters:

recipient - the recipient for this EncryptedKey.

getReferenceList

ReferenceList getReferenceList()

Returns pointers to data and keys encrypted using this key. The reference list may contain multiple references to EncryptedKey and EncryptedData elements. This is done using KeyReference and DataReference elements respectively.

Returns:

an Iterator over all the ReferenceLists contained in this EncryptedKey.

setReferenceList

void setReferenceList(ReferenceList list)

Sets the ReferenceList to the EncryptedKey.

Parameters:

list - a list of pointers to data elements encrypted using this key.

getCarriedName

String getCarriedName()

Returns a user readable name with the key value. This may then be used to reference the key using the ds:KeyName element within ds:KeyInfo. The same CarriedKeyName label, unlike an ID type, may occur multiple times within a single document. The value of the key is to be the same in all EncryptedKey elements identified with the same CarriedKeyName label within a single XML document.
Note that because whitespace is significant in the value of the ds:KeyName element, whitespace is also significant in the value of the CarriedKeyName element.

Returns:

over all the carried names contained in this EncryptedKey.

setCarriedName

void setCarriedName(String name)

Sets the carried name.

Parameters:

name - the carried name.