|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface EncryptedKey
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 | |
|---|---|
java.lang.String |
getCarriedName()
Returns a user readable name with the key value. |
java.lang.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(java.lang.String name)
Sets the carried name. |
void |
setRecipient(java.lang.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 |
|---|
java.lang.String getRecipient()
EncryptedKey.void setRecipient(java.lang.String recipient)
EncryptedKey.
recipient - the recipient for this EncryptedKey.ReferenceList getReferenceList()
EncryptedKey and
EncryptedData elements. This is done using
KeyReference and DataReference elements
respectively.
Iterator over all the ReferenceLists
contained in this EncryptedKey.void setReferenceList(ReferenceList list)
ReferenceList to the EncryptedKey.
list - a list of pointers to data elements encrypted using this key.java.lang.String getCarriedName()
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.
ds:KeyName element, whitespace is also significant in
the value of the CarriedKeyName element.
EncryptedKey.void setCarriedName(java.lang.String name)
name - the carried name.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||