Skip navigation links

oracle.security.xmlsec.transform
Class XPathFilter

java.lang.Object
oracle.security.xmlsec.transform.XSTransformer
oracle.security.xmlsec.transform.XPathFilter

public class XPathFilter

extends XSTransformer

Internal use only. Applies XPath filter expressions as a XML-DSIG Transform.

Field Summary

Fields inherited from class oracle.security.xmlsec.transform.XSTransformer

transform

Constructor Summary

XPathFilter(XSAlgorithmIdentifier trans)
Creates a new XPathFilter instance.

Method Summary

static java.util.Set	applyXPath(java.lang.String xpathStr, java.util.Set nodeSet, org.w3c.dom.Node nsNode, org.w3c.dom.Node xpathNode) Applies the transform's XPath expression to the given node-set and returns the resulting node-set.
java.lang.String	getAlgorithmURI() Returns the URI string identifying the Transform algorithm.
java.lang.String	getXPath() Returns the XPath expression.
XMLContainer	transform(XMLContainer source) Applies a XPath filter transformation to the given XMLContainer and returns the node list result in a new XMLContainer.

Methods inherited from class oracle.security.xmlsec.transform.XSTransformer

applyTransforms, getInstance, getInstance, getTransform

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathFilter

public XPathFilter(XSAlgorithmIdentifier trans)

Creates a new XPathFilter instance.

Parameters:

trans - A XSAlgorithmIdentifier object containing exactly one parameter named "XPath".

Throws:

java.lang.IllegalArgumentException - If the XSAlgorithmIdentifier is not a valid XPath Transform.

Method Detail

getXPath

public java.lang.String getXPath()

Returns the XPath expression.

applyXPath

public static java.util.Set applyXPath(java.lang.String xpathStr,
                                       java.util.Set nodeSet,
                                       org.w3c.dom.Node nsNode,
                                       org.w3c.dom.Node xpathNode)
                                throws XPathException

Applies the transform's XPath expression to the given node-set and returns the resulting node-set.

Parameters:

xpathStr - The XPath expression to apply to the input node-set.

nodeSet - The input node-set against which the XPath expression is to be evaluated.

nsNode - The Node, usually the XPath element, which will be used for namespace prefix resolution.

xpathNode - The Node, usually the Text node containing the XPath expression, which will be the point of reference for the here() function.

Returns:

An org.w3c.dom.NodeList containing the resulting node-set.

Throws:

TransformerException - If an error occurs while processing the XPath expression.

XPathException

getAlgorithmURI

public java.lang.String getAlgorithmURI()

Description copied from class: XSTransformer

Returns the URI string identifying the Transform algorithm.

Specified by:

getAlgorithmURI in class XSTransformer

Returns:

This Transform's URI string.

transform

public XMLContainer transform(XMLContainer source)
                       throws TransformationException

Applies a XPath filter transformation to the given XMLContainer and returns the node list result in a new XMLContainer.

Specified by:

transform in class XSTransformer

Parameters:

source - A XMLContainer on which the transform will operate.

Returns:

A XMLContainer containing the transform node list result.

Throws:

TransformationException - if an error occurs during the transformation process.

Skip navigation links