iaik.xml.crypto.enc

Class EncryptedTypeImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XencDOMStructure

iaik.xml.crypto.enc.EncryptedTypeImpl

All Implemented Interfaces:

EncryptedType, XMLStructure

Direct Known Subclasses:

EncryptedDataImpl, EncryptedKeyImpl

public abstract class EncryptedTypeImpl
extends XencDOMStructure
implements EncryptedType

An implementation of the EncryptedType type 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 CipherDataImpl	cipherData_ The CipherData.
protected String	encoding_ The Encoding-attribute value.
protected EncryptionMethodImpl	encryptionMethod_ The EncryptionMethod.
protected EncryptionProperties	encryptionProperties_ The EncryptionProperty.
protected String	id_ The Id-attribute value.
protected KeyInfo	keyInfo_ The KeyInfo.
protected KeySelectorResult	keySelectorResult_ The result of the key selector used for encryption and decryption.
protected String	mimeType_ The MimeType-attribute value.
protected Provider	provider_ The Providerassigned by the XMLEncryptionFactory.
protected ToBeEncrypted	tbe_ The data to be encrypted.
protected String	type_ The type-attribute value.

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

CONTENT, ELEMENT, XMLNS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EncryptedTypeImpl() Creates a new instance of this EncryptedTypeImpl.
protected	EncryptedTypeImpl(Node node) Creates a new instance of this EncryptedTypeImpl with the specified node.
protected	EncryptedTypeImpl(ToBeEncrypted toBeEncrypted, EncryptionMethodImpl encMethod, KeyInfo keyInfo, EncryptionProperties properties, String id, CipherReferenceImpl cipherRef) Creates a new instance of this EncryptedTypeImpl with the specified data to be encrypted, the encryption method, the key info, the encryption properties, the Id-attribute value and the CipherReference.

Method Summary

Modifier and Type	Method and Description
InputStream	decrypt(XMLDecryptContext context) Decrypts the CipherData in this EncryptedData.
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
CipherData	getCipherData() Returns the cipher data containing the encrypted data.
InputStream	getCipherText() Returns the encrypted data if the EncryptedType stores the encrypted data as CipherReference.
String	getEncoding() Returns a URI identifying the transfer encoding of the data that has been encrypted.
EncryptionMethod	getEncryptionMethod() Returns the encryption method applied to the cipher data.
EncryptionProperties	getEncryptionProperties() Returns the encryption properties associated with this encrypted type.
String	getId() Returns the optional ID.
KeyInfo	getKeyInfo() Returns the key info that carries information about the key used to encrypt the data.
String	getMimeType() Returns the mime type of the data that has been encrypted.
ToBeEncrypted	getToBeEncrypted() Returns the data to be encrypted if there is any.
String	getType() Returns a URI identifying the type of the plaintext form of the encrypted content.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals the XML representation of all Attributes represented by this DOMStrucuture.
protected Attr	marshalIDAttribute(DOMCryptoContext context, Element parent) Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.
protected void	putChildStructure(DOMStructure childStructure) Put an unmarshalled child structure.
protected Key	selectKey(XMLCryptoContext context, boolean encrypt) Selects a key for encryption or decryption.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshal the given attributes.

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, getLocalName, 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.EncryptedType

encrypt

Methods inherited from interface javax.xml.crypto.XMLStructure

isFeatureSupported

Field Detail

provider_

protected Provider provider_

The Providerassigned by the XMLEncryptionFactory. Will be needed by the DOMMarshalContext.

encryptionMethod_

protected EncryptionMethodImpl encryptionMethod_

The EncryptionMethod.

keyInfo_

protected KeyInfo keyInfo_

The KeyInfo.

cipherData_

protected CipherDataImpl cipherData_

The CipherData. (must not be null)

encryptionProperties_

protected EncryptionProperties encryptionProperties_

The EncryptionProperty.

id_

protected String id_

The Id-attribute value.

type_

protected String type_

The type-attribute value.

mimeType_

protected String mimeType_

The MimeType-attribute value.

encoding_

protected String encoding_

The Encoding-attribute value.

keySelectorResult_

protected KeySelectorResult keySelectorResult_

The result of the key selector used for encryption and decryption.

tbe_

protected ToBeEncrypted tbe_

The data to be encrypted.

Constructor Detail

EncryptedTypeImpl

protected EncryptedTypeImpl()

Creates a new instance of this EncryptedTypeImpl.

EncryptedTypeImpl

protected EncryptedTypeImpl(Node node)
                     throws MarshalException

Creates a new instance of this EncryptedTypeImpl with the specified node.

Parameters:

node - the node

Throws:

NullPointerException - if node is null

MarshalException - if an exception occurs during unmarshaling

EncryptedTypeImpl

protected EncryptedTypeImpl(ToBeEncrypted toBeEncrypted,
                            EncryptionMethodImpl encMethod,
                            KeyInfo keyInfo,
                            EncryptionProperties properties,
                            String id,
                            CipherReferenceImpl cipherRef)

Creates a new instance of this EncryptedTypeImpl with the specified data to be encrypted, the encryption method, the key info, the encryption properties, the Id-attribute value and the CipherReference.

Parameters:

toBeEncrypted - the data to be encrypted

encMethod - the encryption method (may be null)

keyInfo - the key info (may be null)

properties - the encryption properties (may be null or empty)

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

cipherRef - the CipherReference

Throws:

NullPointerException - if toBeEncrypted or cipherRef is null

IllegalArgumentException - if ToBeEncryptedKey is passed in as toBeEncrypted

Method Detail

getCipherData

public CipherData getCipherData()

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

Returns the cipher data containing the encrypted data.

Specified by:

getCipherData in interface EncryptedType

Returns:

the cipher data, or null if the data has not been encrypted yet.

See Also:

EncryptedType.getCipherData()

getCipherText

public InputStream getCipherText()
                          throws IllegalStateException

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

Returns the encrypted data if the EncryptedType stores the encrypted data as CipherReference.

Specified by:

getCipherText in interface EncryptedType

Returns:

the encrypted data if EncryptedType has CipherReference as CipherData.

Throws:

IllegalStateException - if a CipherData is not a CipherReference; or this method is called on an unmarshalled EncryptedType.

See Also:

EncryptedType.getCipherText()

getEncoding

public String getEncoding()

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

Returns a URI identifying the transfer encoding of the data that has been encrypted.

Specified by:

getEncoding in interface EncryptedType

Returns:

the encoding, or null if not specified.

See Also:

EncryptedType.getEncoding()

getEncryptionMethod

public EncryptionMethod getEncryptionMethod()

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

Returns the encryption method applied to the cipher data.

Specified by:

getEncryptionMethod in interface EncryptedType

Returns:

the encryption method, or null if not specified.

See Also:

EncryptedType.getEncryptionMethod()

getEncryptionProperties

public EncryptionProperties getEncryptionProperties()

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

Returns the encryption properties associated with this encrypted type.

Specified by:

getEncryptionProperties in interface EncryptedType

Returns:

the encryption properties, or null if not specified.

See Also:

EncryptedType.getEncryptionProperties()

getId

public String getId()

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

Returns the optional ID.

Specified by:

getId in interface EncryptedType

Returns:

the ID, or null if not specified.

See Also:

EncryptedType.getId()

getKeyInfo

public KeyInfo getKeyInfo()

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

Returns the key info that carries information about the key used to encrypt the data.

Specified by:

getKeyInfo in interface EncryptedType

Returns:

the key info, or null if not specified

See Also:

EncryptedType.getKeyInfo()

getMimeType

public String getMimeType()

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

Returns the mime type of the data that has been encrypted.

Specified by:

getMimeType in interface EncryptedType

Returns:

the mime type, or null if not specified.

See Also:

EncryptedType.getMimeType()

getToBeEncrypted

public ToBeEncrypted getToBeEncrypted()

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

Returns the data to be encrypted if there is any.

Specified by:

getToBeEncrypted in interface EncryptedType

Returns:

the data to be encrypted if there is any

See Also:

EncryptedType.getToBeEncrypted()

getType

public String getType()

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

Returns a URI identifying the type of the plaintext form of the encrypted content.

Specified by:

getType in interface EncryptedType

Returns:

the type, or null if not specified.

See Also:

EncryptedType.getType()

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 DOMStructure

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 DOMStructure

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)

marshalIDAttribute

protected Attr marshalIDAttribute(DOMCryptoContext context,
                                  Element parent)

Description copied from class: DOMStructure

Marshals the XML representation of an optional Id-attribute represented by this DOMStructure.

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

A subclass has to overwrite this method in order to marshal an Id-attribute.

Overrides:

marshalIDAttribute in class DOMStructure

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.

Returns:

the marshaled Id-attribute if any, otherwise null

See Also:

DOMStructure.marshalIDAttribute(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 DOMStructure

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 DOMStructure

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)

decrypt

public InputStream decrypt(XMLDecryptContext context)
                    throws XMLEncryptionException

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

Decrypts the CipherData in this EncryptedData.

Specified by:

decrypt in interface EncryptedType

Parameters:

context - The decryption context.

Returns:

the decrypted CipherData as an InputStream.

Throws:

XMLEncryptionException - if an error occurs while decrypting.

See Also:

EncryptedType.decrypt(javax.xml.crypto.enc.XMLDecryptContext)

selectKey

protected Key selectKey(XMLCryptoContext context,
                        boolean encrypt)
                 throws XMLEncryptionException

Selects a key for encryption or decryption.

Parameters:

context - the context

encrypt - true for encryption, false for decryption

Returns:

the selected key (never null)

Throws:

XMLEncryptionException - if an unexpected exception occurs selecting the key