Package org.apache.xml.security.encryption

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

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 this EncryptedKey.
void	setReferenceList(ReferenceList list)	Sets the ReferenceList to the EncryptedKey.
(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 interface EncryptedKey

Returns:

the recipient of the EncryptedKey.

setRecipient

public void setRecipient(java.lang.String recipient)

Sets the recipient for this EncryptedKey.

Specified by:

setRecipient in interface EncryptedKey

Parameters:

recipient - the recipient for this EncryptedKey.

getReferenceList

public 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.

Specified by:

getReferenceList in interface EncryptedKey

Returns:

an Iterator over all the ReferenceLists contained in this EncryptedKey.

setReferenceList

public void setReferenceList(ReferenceList list)

Sets the ReferenceList to the EncryptedKey.

Specified by:

setReferenceList in interface EncryptedKey

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 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.

Specified by:

getCarriedName in interface EncryptedKey

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 interface EncryptedKey

Parameters:

name - the carried name.

toElement

org.w3c.dom.Element toElement()