iaik.xml.crypto.enc

Class EncryptedKeyImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XencDOMStructure

iaik.xml.crypto.enc.EncryptedTypeImpl

iaik.xml.crypto.enc.EncryptedKeyImpl

All Implemented Interfaces:

EncryptedType, EncryptedKey, XMLStructure

public class EncryptedKeyImpl
extends EncryptedTypeImpl
implements EncryptedKey

An implementation of the EncryptedKey that supports the DOM XML representation and processing mechanism.

Nested Class Summary

Nested classes/interfaces inherited from class iaik.xml.crypto.dom.DOMStructure

DOMStructure.NodeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected CarriedKeyNameImpl	carriedKeyName_ The CarriedKeyName.
protected String	keyAlgorithm_ The algorithm of the encrypted key.
protected String	recipient_ The Recipient-attribute value.
protected ReferenceListImpl	referenceList_ The ReferenceList.

Fields inherited from class iaik.xml.crypto.enc.EncryptedTypeImpl

cipherData_, encoding_, encryptionMethod_, encryptionProperties_, id_, keyInfo_, keySelectorResult_, mimeType_, provider_, tbe_, type_

Fields inherited from class iaik.xml.crypto.dom.DOMStructure

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Fields inherited from interface javax.xml.crypto.enc.keyinfo.EncryptedKey

TYPE

Fields inherited from interface javax.xml.crypto.enc.EncryptedType

CONTENT, ELEMENT, XMLNS

Constructor Summary

Constructors

Constructor and Description
EncryptedKeyImpl(DOMCryptoContext context, Node node) Creates a new instance of this EncryptedKeyImpl with the specified context and node to unmarshal from.
EncryptedKeyImpl(ToBeEncryptedKey key, EncryptionMethodImpl encMethod, KeyInfoImpl keyInfo, EncryptionProperties properties, List references, String id, String carriedKeyName, String recipient, CipherReferenceImpl cipherRef) Creates a new instance of this EncryptedKeyImpl with the specified to-be-encrypted key, encryption method, KeyInfo, encryption properties, list of DataReferenceImpls and KeyReferenceImpl s, Id-attribute value, carried key name, recipient and CipherReference.

Method Summary

Modifier and Type	Method and Description
Key	decryptKey(XMLDecryptContext context, AlgorithmMethod alg) Decrypts the CipherData in this EncryptedKey and returns the decrypted key as a Key object.
void	encrypt(XMLEncryptContext context) Encrypts the ToBeEncrypted passed to the construction of this EncryptedType and inserts it in the CipherValue or CipherReference of the CipherData of this EncryptedData.
String	getCarriedKeyName() Returns the carried key name of this EncryptedKey.
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
String	getLocalName() Returns the local name of the represented XML element.
String	getRecipient() Returns a hint as to which recipient this EncryptedKey is intended for.
List	getReferenceList() Returns an unmodifiable list of ReferenceTypes containing pointers to data and keys encrypted using this key.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals the XML representation of all Attributes represented by this DOMStrucuture.
protected void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshal the given attributes.

Methods inherited from class iaik.xml.crypto.enc.EncryptedTypeImpl

decrypt, getCipherData, getCipherText, getEncoding, getEncryptionMethod, getEncryptionProperties, getId, getKeyInfo, getMimeType, getToBeEncrypted, getType, marshalIDAttribute, selectKey

Methods inherited from class iaik.xml.crypto.dom.XencDOMStructure

getNamespace, init

Methods inherited from class iaik.xml.crypto.dom.DOMStructure

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructure, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshal, marshalElement, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, unmarshalElement, unmarshalIDAttribute, unmarshalStructures, wrapNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.crypto.enc.keyinfo.EncryptedKey

decrypt

Methods inherited from interface javax.xml.crypto.enc.EncryptedType

getCipherData, getCipherText, getEncoding, getEncryptionMethod, getEncryptionProperties, getId, getKeyInfo, getMimeType, getToBeEncrypted, getType

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

referenceList_

protected ReferenceListImpl referenceList_

The ReferenceList.

carriedKeyName_

protected CarriedKeyNameImpl carriedKeyName_

The CarriedKeyName.

recipient_

protected String recipient_

The Recipient-attribute value.

keyAlgorithm_

protected String keyAlgorithm_

The algorithm of the encrypted key.

Constructor Detail

EncryptedKeyImpl

public EncryptedKeyImpl(DOMCryptoContext context,
                        Node node)
                 throws MarshalException

Creates a new instance of this EncryptedKeyImpl with the specified context and node to unmarshal from.

Parameters:

context - the context

node - the node to unmarshal from

Throws:

MarshalException - if an exception occurs during unmarshaling

EncryptedKeyImpl

public EncryptedKeyImpl(ToBeEncryptedKey key,
                        EncryptionMethodImpl encMethod,
                        KeyInfoImpl keyInfo,
                        EncryptionProperties properties,
                        List references,
                        String id,
                        String carriedKeyName,
                        String recipient,
                        CipherReferenceImpl cipherRef)

Creates a new instance of this EncryptedKeyImpl with the specified to-be-encrypted key, encryption method, KeyInfo, encryption properties, list of DataReferenceImpls and KeyReferenceImpl s, Id-attribute value, carried key name, recipient and CipherReference.

Parameters:

key - the key to be encrypted

encMethod - the encryption method (may be null)

keyInfo - the key info (may be null)

properties - the encryption properties (may be null)

references - a list of DataReferenceImpls and KeyReferenceImpls (may be null or empty)

id - the Id-attribute value (may be null)

carriedKeyName - the carried key name (may be null)

recipient - the recipient (may be null)

cipherRef - the CipherReference (may be null)

Throws:

NullPointerException - if key is null

ClassCastException - if any of the references is not of type DataReferenceImpl or KeyReferenceImpl

Method Detail

getLocalName

public String getLocalName()

Description copied from class: DOMStructure

Returns the local name of the represented XML element.

Specified by:

getLocalName in class DOMStructure

Returns:

the local name of the represented XML element

See Also:

DOMStructure.getLocalName()

getReferenceList

public List getReferenceList()

Description copied from interface: javax.xml.crypto.enc.keyinfo.EncryptedKey

Returns an unmodifiable list of ReferenceTypes containing pointers to data and keys encrypted using this key.

Specified by:

getReferenceList in interface EncryptedKey

Returns:

an unmodifiable list of ReferenceTypes (may be empty but never null)

See Also:

EncryptedKey.getReferenceList()

getCarriedKeyName

public String getCarriedKeyName()

Description copied from interface: javax.xml.crypto.enc.keyinfo.EncryptedKey

Returns the carried key name of this EncryptedKey.

Specified by:

getCarriedKeyName in interface EncryptedKey

Returns:

the carried key name or null if not specified

See Also:

EncryptedKey.getCarriedKeyName()

getRecipient

public String getRecipient()

Description copied from interface: javax.xml.crypto.enc.keyinfo.EncryptedKey

Returns a hint as to which recipient this EncryptedKey is intended for.

Specified by:

getRecipient in interface EncryptedKey

Returns:

the recipient or null if not specified

See Also:

EncryptedKey.getRecipient()

getChildStructures

protected List getChildStructures()

Description copied from class: DOMStructure

Returns the list of child structures of this DOMStructure.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

A subclass has to overwrite this method to return a list of DOMStrucutres represented by this subclass.

Overrides:

getChildStructures in class EncryptedTypeImpl

Returns:

a list of DOMStructures (may be empty, but never null)

See Also:

DOMStructure.getChildStructures()

marshalAttributes

protected void marshalAttributes(DOMCryptoContext context,
                                 Element parent)
                          throws MarshalException

Description copied from class: DOMStructure

Marshals the XML representation of all Attributes represented by this DOMStrucuture.

This method is called by DOMStructure.marshal(DOMCryptoContext, Node, Node).

If no namespace prefix is set in the context for the namespace of the Element represented by this DOMStructure an namespace declaration is marshaled and returned. Otherwise, an empty list is returned.

A subclass has to overwrite this method in order to marshal any additional attributes.

Overrides:

marshalAttributes in class EncryptedTypeImpl

Parameters:

context - the marshal context

parent - the element is the parent of the attribute node created however, an the attribute node is not a child of it's parent element. see XPath.

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.marshalAttributes(DOMCryptoContext, Element)

putChildStructure

protected void putChildStructure(DOMStructure childStructure)
                          throws MarshalException

Description copied from class: DOMStructure

Put an unmarshalled child structure.

This method is called by DOMStructure.unmarshalStructures(NodeList, DOMCryptoContext) for every unmarshalled child structure.

A subclass has to overwrite this method to store the given child structure in its the corresponding field.

Overrides:

putChildStructure in class EncryptedTypeImpl

Parameters:

childStructure - the unmarshalled child structure

Throws:

MarshalException

See Also:

DOMStructure.putChildStructure(iaik.xml.crypto.dom.DOMStructure)

unmarshalAttributes

protected void unmarshalAttributes(NamedNodeMap attributes,
                                   DOMCryptoContext context)
                            throws MarshalException

Description copied from class: DOMStructure

Unmarshal the given attributes.

This method is called by DOMStructure.unmarshal(DOMCryptoContext).

A subclass has to overwrite this method to perform any special unmarshaling required.

Overrides:

unmarshalAttributes in class EncryptedTypeImpl

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

See Also:

DOMStructure.unmarshalAttributes(org.w3c.dom.NamedNodeMap, DOMCryptoContext)

decryptKey

public Key decryptKey(XMLDecryptContext context,
                      AlgorithmMethod alg)
               throws XMLEncryptionException

Description copied from interface: javax.xml.crypto.enc.keyinfo.EncryptedKey

Decrypts the CipherData in this EncryptedKey and returns the decrypted key as a Key object.

Specified by:

decryptKey in interface EncryptedKey

Throws:

XMLEncryptionException

See Also:

EncryptedKey.decryptKey(javax.xml.crypto.enc.XMLDecryptContext, javax.xml.crypto.AlgorithmMethod)

encrypt

public void encrypt(XMLEncryptContext context)
             throws XMLEncryptionException,
                    MarshalException

Description copied from interface: javax.xml.crypto.enc.EncryptedType

Encrypts the ToBeEncrypted passed to the construction of this EncryptedType and inserts it in the CipherValue or CipherReference of the CipherData of this EncryptedData.

Specified by:

encrypt in interface EncryptedType

Parameters:

context - The encryption context.

Throws:

XMLEncryptionException - if an error occurs while encrypting.

MarshalException - if an error occurs while marshalling.

See Also:

EncryptedType.encrypt(javax.xml.crypto.enc.XMLEncryptContext)