iaik.xml.crypto.dsig.keyinfo

Class KeyInfoImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.keyinfo.KeyInfoImpl

All Implemented Interfaces:

KeyInfo, XMLStructure

public class KeyInfoImpl
extends DOMStructure
implements KeyInfo

An implementation of the KeyInfo 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 List	content_ The content.
protected String	id_ The Id-attribute value.
protected String	localname The localname of the marshaled element.
protected String	namsepace The namespace of the marshaled element.

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

implMap_, state_, STATE_CREATED, STATE_MARSHALED, STATE_UNINITIALIZED, STATE_UNMARSHALED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	KeyInfoImpl() Creates a new instance of this KeyInfoImpl.
	KeyInfoImpl(DOMCryptoContext context, Node node) Creates a new instance of this KeyInfoImpl with the specified context and node to unmarshal from.
	KeyInfoImpl(List content, String id) Creates a new instance of this KeyInfoImpl with the specified list of XMLStructures and Id-attribute value.
protected	KeyInfoImpl(Node node) Creates a new instance of this KeyInfoImpl with the specified node.

Method Summary

Modifier and Type	Method and Description
protected List	getChildStructures() Returns the list of child structures of this DOMStructure.
List	getContent() Returns an unmodifiable list containing the key information.
String	getId() Return the optional Id attribute of this KeyInfo, which may be useful for referencing this KeyInfo from other XML structures.
String	getLocalName() Returns the local name of the represented XML element.
String	getNamespace() Returns the namespace URI of the represented XML element.
DOMStructure	getParentStructure()
void	marshal(XMLStructure parent, XMLCryptoContext context) Marshals the key info to XML.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals an namespace-declaration for the XMLDSig name-space.
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.
void	setLocalname(String localname) Sets the localname of the marshaled node.
void	setNamsepace(String namsepace) Sets the namespace of the marshaled node.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) Unmarshals the Id-attribute.
protected void	unmarshalElement(DOMCryptoContext context, Element element) Unmarshals the given element.
protected void	unmarshalStructures(NodeList nodes, DOMCryptoContext context) Unmarshals DOMStructures from the given nodes.

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

addBytesToElement, addBytesToElement, clearMarshalling, clearMarshalling, getBytesFromElement, getBytesFromElementStream, getChildStructureVersion, getHere, getImplClass, getInstance, getInstance, getNode, getParentStructureOf, getQualifiedName, getQualifiedName, hasNSDeclAttrInScope, isFeatureSupported, isNSDeclInScope, marshal, marshalElement, newIDforLookUp, putImplClass, setBackToCompatibilityPrior1_14, setNode, setParentStructure, toString, unmarshal, 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.

localname

protected String localname

The localname of the marshaled element.

namsepace

protected String namsepace

The namespace of the marshaled element.

Constructor Detail

KeyInfoImpl

protected KeyInfoImpl()

Creates a new instance of this KeyInfoImpl.

KeyInfoImpl

protected KeyInfoImpl(Node node)
               throws MarshalException

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

Parameters:

node - the node

Throws:

MarshalException

KeyInfoImpl

public KeyInfoImpl(DOMCryptoContext context,
                   Node node)
            throws MarshalException

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

KeyInfoImpl

public KeyInfoImpl(List content,
                   String id)

Creates a new instance of this KeyInfoImpl with the specified list of XMLStructures and Id-attribute value.

Parameters:

content - a list of XMLStructures

id - the Id-attribute value

Throws:

NullPointerException - if config or content is null

IllegalArgumentException - if content is empty

ClassCastException - if content contains any elements 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()

setLocalname

public void setLocalname(String localname)

Sets the localname of the marshaled node.

Parameters:

localname - the localname of the marshaled node.

getNamespace

public String getNamespace()

Description copied from class: DOMStructure

Returns the namespace URI of the represented XML element.

Specified by:

getNamespace in class DOMStructure

Returns:

the namespace URI of the represented XML element

See Also:

DOMStructure.getNamespace()

setNamsepace

public void setNamsepace(String namsepace)

Sets the namespace of the marshaled node.

Parameters:

namsepace - the namespace of the marshaled node.

getContent

public List getContent()

Description copied from interface: javax.xml.crypto.dsig.keyinfo.KeyInfo

Returns an unmodifiable list containing the key information. Each entry of the list is an XMLStructure.

If there is a public subclass representing the type of XMLStructure, it is returned as an instance of that class (ex: an X509Data element would be returned as an instance of X509Data).

Specified by:

getContent in interface KeyInfo

Returns:

an unmodifiable list of one or more XMLStructure s in this KeyInfo. Never returns null or an empty list.

See Also:

KeyInfo.getContent()

getId

public String getId()

Description copied from interface: javax.xml.crypto.dsig.keyinfo.KeyInfo

Return the optional Id attribute of this KeyInfo, which may be useful for referencing this KeyInfo from other XML structures.

Specified by:

getId in interface KeyInfo

Returns:

the Id attribute of this KeyInfo (may be null if not specified)

See Also:

KeyInfo.getId()

marshalAttributes

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

Marshals an namespace-declaration for the XMLDSig name-space.

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

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

Unmarshals the Id-attribute.

Overrides:

unmarshalAttributes in class DOMStructure

Parameters:

attributes - the Attributes to unmarshal

context - the marshal context

Throws:

MarshalException - if an exception occurs during unmarshaling

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)

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

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)

unmarshalElement

protected void unmarshalElement(DOMCryptoContext context,
                                Element element)
                         throws MarshalException

Description copied from class: DOMStructure

Unmarshals the given element.

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

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

Overrides:

unmarshalElement in class DOMStructure

Parameters:

context - the marshal context

element - the element to be unmarshal

Throws:

MarshalException - if an exception occurs during unmarshaling

See Also:

DOMStructure.unmarshalElement(DOMCryptoContext, org.w3c.dom.Element)

marshal

public void marshal(XMLStructure parent,
                    XMLCryptoContext context)
             throws MarshalException

Description copied from interface: javax.xml.crypto.dsig.keyinfo.KeyInfo

Marshals the key info to XML.

Specified by:

marshal in interface KeyInfo

Parameters:

parent - a mechanism-specific structure containing the parent node that the marshalled key info will be appended to

context - the XMLCryptoContext containing additional context (may be null if not applicable)

Throws:

MarshalException - if the key info cannot be marshalled

See Also:

KeyInfo.marshal(javax.xml.crypto.XMLStructure, javax.xml.crypto.XMLCryptoContext)

getParentStructure

public DOMStructure getParentStructure()

Overrides:

getParentStructure in class DOMStructure

Returns:

the parent DOMStructure.

See Also:

DOMStructure.getParentStructure()