iaik.xml.crypto.enc

Class EncryptionPropertyImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.XencDOMStructure

iaik.xml.crypto.enc.EncryptionPropertyImpl

All Implemented Interfaces:

EncryptionProperty, XMLStructure

public class EncryptionPropertyImpl
extends XencDOMStructure
implements EncryptionProperty

An implementation of the EncryptionProperty element 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 Map	attributes_ A map of attributes from the XML-Namespace.
protected List	content_ The content.
protected String	id_ The Id-attribute value.
protected String	target_ The Target-attribute value.

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Constructor and Description
EncryptionPropertyImpl(DOMCryptoContext context, Node node) Creates a new instance of this EncryptionPropertyImpl with the specified context and node to unmarshal from.
EncryptionPropertyImpl(List content, String target, String id, Map attributes) Creates a new instance of this EncryptionPropertyImpl with the specified list of XMLStructures, Id-attribute value, Target-attribute value and map of attributes.

Method Summary

Modifier and Type	Method and Description
Map	getAttributes() Returns an unmodifiable map of attributes from the XML namespace, where the keys are the name of the attributes (ex: space, lang, base).
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
List	getContent() Returns an unmodifiable list of XMLStructures.
String	getId() Returns the optional ID
String	getLocalName() Returns the local name of the represented XML element.
String	getTarget() Returns the target URI of the EncryptedType structure that this property describes.
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 void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshal the given attributes.
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals DOMStructures from the given nodes.

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

isFeatureSupported

Field Detail

content_

protected List content_

The content. (may not be null)

id_

protected String id_

The Id-attribute value.

target_

protected String target_

The Target-attribute value.

attributes_

protected Map attributes_

A map of attributes from the XML-Namespace. (may not be null)

Constructor Detail

EncryptionPropertyImpl

public EncryptionPropertyImpl(DOMCryptoContext context,
                              Node node)
                       throws MarshalException

Creates a new instance of this EncryptionPropertyImpl 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

EncryptionPropertyImpl

public EncryptionPropertyImpl(List content,
                              String target,
                              String id,
                              Map attributes)

Creates a new instance of this EncryptionPropertyImpl with the specified list of XMLStructures, Id-attribute value, Target-attribute value and map of attributes.

Parameters:

content - a list of XMLStructures

target - the Target-attribute value (may be null)

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

attributes - a map of attributes from the XML namespace (may be null or empty)

Throws:

NullPointerException - if content is null

IllegalArgumentException - if content is empty or one of the attributes is not from the XML namespace

ClassCastException - if content contains any entries that are not of type XMLStructure

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()

getAttributes

public Map getAttributes()

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

Returns an unmodifiable map of attributes from the XML namespace, where the keys are the name of the attributes (ex: space, lang, base).

Specified by:

getAttributes in interface EncryptionProperty

Returns:

an unmodifiable map of attributes (may be empty, but never null).

See Also:

EncryptionProperty.getAttributes()

getContent

public List getContent()

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

Returns an unmodifiable list of XMLStructures.

Specified by:

getContent in interface EncryptionProperty

Returns:

an unmodifiable list of XMLStructures (never null or empty)

See Also:

EncryptionProperty.getContent()

getTarget

public String getTarget()

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

Returns the target URI of the EncryptedType structure that this property describes.

Specified by:

getTarget in interface EncryptionProperty

Returns:

the target URI, or null if not specified

See Also:

EncryptionProperty.getTarget()

getId

public String getId()

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

Returns the optional ID

Specified by:

getId in interface EncryptionProperty

Returns:

the ID, or null if not specified.

See Also:

EncryptionProperty.getId()

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)

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)

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()

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)

unmarshalStructures

protected void unmarshalStructures(NodeList nodes,
                                   DOMCryptoContext context)
                            throws MarshalException

Description copied from class: DOMStructure

Unmarshals DOMStructures from the given nodes.

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

This method calls DOMStructure.getInstance(Node, DOMCryptoContext) for every Element in the list of nodes. If DOMStructure.getInstance(Node, DOMCryptoContext) returns a DOMStructure DOMStructure.putChildStructure(DOMStructure) is called with the returned DOMStructure as parameter.

Overrides:

unmarshalStructures in class DOMStructure

Parameters:

nodes - the nodes to unmarshal from

context - the marshal context

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.unmarshalStructures(org.w3c.dom.NodeList, DOMCryptoContext)