Interface EncryptedKey
- All Superinterfaces:
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 TypeMethodDescriptionReturns a user readable name with the key value.Returns a hint as to which recipient this encrypted key value is intended for.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 thisEncryptedKey
.void
Sets theReferenceList
to theEncryptedKey
.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 Details
-
getRecipient
String getRecipient()Returns a hint as to which recipient this encrypted key value is intended for.- Returns:
- the recipient of the
EncryptedKey
.
-
setRecipient
Sets the recipient for thisEncryptedKey
.- Parameters:
recipient
- the recipient for thisEncryptedKey
.
-
getReferenceList
ReferenceList getReferenceList()Returns pointers to data and keys encrypted using this key. The reference list may contain multiple references toEncryptedKey
andEncryptedData
elements. This is done usingKeyReference
andDataReference
elements respectively.- Returns:
- an
Iterator
over all theReferenceList
s contained in thisEncryptedKey
.
-
setReferenceList
Sets theReferenceList
to theEncryptedKey
.- 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 theds:KeyName
element withinds:KeyInfo
. The sameCarriedKeyName
label, unlike an ID type, may occur multiple times within a single document. The value of the key is to be the same in allEncryptedKey
elements identified with the sameCarriedKeyName
label within a single XML document.
Note that because whitespace is significant in the value of theds:KeyName
element, whitespace is also significant in the value of theCarriedKeyName
element.- Returns:
- over all the carried names contained in
this
EncryptedKey
.
-
setCarriedName
Sets the carried name.- Parameters:
name
- the carried name.
-