iaik.xml.crypto.dsig.spec

Class XPathParameterImpl

java.lang.Object

javax.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dom.DOMStructure

iaik.xml.crypto.dsig.spec.AlgorithmParameterImpl

iaik.xml.crypto.dsig.spec.XPathParameterImpl

All Implemented Interfaces:

XMLStructure

public class XPathParameterImpl
extends AlgorithmParameterImpl

An implementation of XPath element that supports the DOM XML representation and marshaling 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	namespaceMap_ The mapping of namespace prefix (String) to namespace URI ( String).
protected String	xpath_ The XPath expression.

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
XPathParameterImpl(DOMCryptoContext context, Node node) Creates a new instance of this XPathParameterImpl with the specified provider config, context and node to unmarshal from.
XPathParameterImpl(String xpath, Map namespaceMap) Creates a new instance of this XPathParameterImpl with the specified provider config, XPath expression, namespace prefix to URI mapping and mapping of the XPath expression to specific nodes of the XPath element.

Method Summary

Modifier and Type	Method and Description
String	getLocalName() Returns the local name of the represented XML element.
String	getNamespace() Returns the namespace URI of the represented XML element.
String	getXpath() Returns the XPath expression.
protected void	marshalAttributes(DOMCryptoContext context, Element parent) Marshals the XML representation of all Attributes represented by this DOMStrucuture.
protected Element	marshalElement(DOMCryptoContext context, Node parent, Node nextSibling) Marshals the XML representation of the Element represented by this DOMStructure and returns it.
protected void	unmarshalAttributes(NamedNodeMap attributes, DOMCryptoContext context) This method is used to unmarshal the namespace declarations of this element and to add it to add it to the namespaceMap_
protected void	unmarshalElement(DOMCryptoContext context, Element element) Unmarshals the given element.

Methods inherited from class iaik.xml.crypto.dsig.spec.AlgorithmParameterImpl

setParentStructure

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

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

Methods inherited from class java.lang.Object

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

Field Detail

xpath_

protected String xpath_

The XPath expression. (may not be null)

namespaceMap_

protected Map namespaceMap_

The mapping of namespace prefix (String) to namespace URI ( String). (may not be null)

Constructor Detail

XPathParameterImpl

public XPathParameterImpl(DOMCryptoContext context,
                          Node node)
                   throws MarshalException

Creates a new instance of this XPathParameterImpl with the specified provider config, context and node to unmarshal from.

Parameters:

context - the context

node - the node to unmarshal from

Throws:

MarshalException - if an exception occurs during unmarshaling

XPathParameterImpl

public XPathParameterImpl(String xpath,
                          Map namespaceMap)

Creates a new instance of this XPathParameterImpl with the specified provider config, XPath expression, namespace prefix to URI mapping and mapping of the XPath expression to specific nodes of the XPath element.

Parameters:

xpath - the XPath expression

namespaceMap - the mapping of namespace prefixes (String) to namespace URIs (String)

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

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

getXpath

public String getXpath()

Returns the XPath expression.

Returns:

the XPath expression

marshalElement

protected Element marshalElement(DOMCryptoContext context,
                                 Node parent,
                                 Node nextSibling)
                          throws MarshalException

Description copied from class: DOMStructure

Marshals the XML representation of the Element represented by this DOMStructure and returns it.

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

Overrides:

marshalElement in class DOMStructure

Parameters:

context - the marshal context

parent - where to place the marshalled element

nextSibling - before which to place the marshalled node

Returns:

the marshaled Element

Throws:

MarshalException - if an exception occurs during marshaling

See Also:

DOMStructure.marshalElement(javax.xml.crypto.dom.DOMCryptoContext, Node, Node)

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)

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(javax.xml.crypto.dom.DOMCryptoContext, org.w3c.dom.Element)

unmarshalAttributes

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

This method is used to unmarshal the namespace declarations of this element and to add it to add it to the namespaceMap_

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, javax.xml.crypto.dom.DOMCryptoContext)