Class XMLCipher.Factory.EncryptedKeyImpl
- java.lang.Object
-
- org.apache.xml.security.encryption.XMLCipher.Factory.EncryptedTypeImpl
-
- org.apache.xml.security.encryption.XMLCipher.Factory.EncryptedKeyImpl
-
- All Implemented Interfaces:
EncryptedKey
,EncryptedType
- Enclosing class:
- XMLCipher.Factory
private class XMLCipher.Factory.EncryptedKeyImpl extends XMLCipher.Factory.EncryptedTypeImpl implements EncryptedKey
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
carriedName
private java.lang.String
keyRecipient
private ReferenceList
referenceList
-
Constructor Summary
Constructors Constructor Description EncryptedKeyImpl(CipherData data)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 thisEncryptedKey
.void
setReferenceList(ReferenceList list)
Sets theReferenceList
to theEncryptedKey
.(package private) org.w3c.dom.Element
toElement()
-
Methods inherited from class org.apache.xml.security.encryption.XMLCipher.Factory.EncryptedTypeImpl
getCipherData, getEncoding, getEncryptionMethod, getEncryptionProperties, getId, getKeyInfo, getMimeType, getType, setEncoding, setEncryptionMethod, setEncryptionProperties, setId, setKeyInfo, setMimeType, setType
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
-
-
-
-
Field Detail
-
keyRecipient
private java.lang.String keyRecipient
-
referenceList
private ReferenceList referenceList
-
carriedName
private java.lang.String carriedName
-
-
Constructor Detail
-
EncryptedKeyImpl
public EncryptedKeyImpl(CipherData data)
- Parameters:
data
-
-
-
Method Detail
-
getRecipient
public java.lang.String getRecipient()
Returns a hint as to which recipient this encrypted key value is intended for.- Specified by:
getRecipient
in interfaceEncryptedKey
- Returns:
- the recipient of the
EncryptedKey
.
-
setRecipient
public void setRecipient(java.lang.String recipient)
Sets the recipient for thisEncryptedKey
.- Specified by:
setRecipient
in interfaceEncryptedKey
- Parameters:
recipient
- the recipient for thisEncryptedKey
.
-
getReferenceList
public 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.- Specified by:
getReferenceList
in interfaceEncryptedKey
- Returns:
- an
Iterator
over all theReferenceList
s contained in thisEncryptedKey
.
-
setReferenceList
public void setReferenceList(ReferenceList list)
Sets theReferenceList
to theEncryptedKey
.- Specified by:
setReferenceList
in interfaceEncryptedKey
- Parameters:
list
- a list of pointers to data elements encrypted using this key.
-
getCarriedName
public java.lang.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.- Specified by:
getCarriedName
in interfaceEncryptedKey
- Returns:
- over all the carried names contained in
this
EncryptedKey
.
-
setCarriedName
public void setCarriedName(java.lang.String name)
Sets the carried name.- Specified by:
setCarriedName
in interfaceEncryptedKey
- Parameters:
name
- the carried name.
-
toElement
org.w3c.dom.Element toElement()
-
-