iaik.ixsil.util

Class XPointerReferenceResolver

java.lang.Object

iaik.ixsil.util.XPointerReferenceResolver

All Implemented Interfaces:

InternalReferenceResolverInterface

public class XPointerReferenceResolver
extends java.lang.Object
implements InternalReferenceResolverInterface

This is a resolver for internal references which can evaluate a limited set of XPointers, according to XML Pointer Framework. The following subset of XPointers can be evaluated by this implementation:

1. Shorthand XPointers - formerly known as barenames (see section 3.2 of XPointer Framework).
2. XPointers with parts in the element scheme (see XPointer element() Scheme.
3. XPointers with parts in the xmlns and xpointer schemes (see XPointer xpointer() Scheme), if all parts in the xpointer scheme have expressions according to XPath 1.0.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ELEMENT_OPENER_ Opener for an XPointer part in the element scheme.
protected org.w3c.dom.NodeList	hereResult_ Contains the result for the here() function, which could be used in the XPointer.
protected InternalReferenceResolverImpl	subsidiary_ Reference resolver used for internal URIs which are not XPointers.
protected org.w3c.dom.Document	xmlDocumentOM_ The XML document for which the internal URI should be resolved.
protected static java.lang.String	XMLNS_OPENER_ Opener for an XPointer part in the xmlns scheme.
protected static java.lang.String	XPOINTER_OPENER_ Opener for an XPointer part in the xpointer scheme.

Constructor Summary

Constructors

Constructor and Description
XPointerReferenceResolver() Standard constructor.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	convertElementPart(java.lang.String element) Converts an element XPointer part into an xpointer XPointer part.
protected static java.lang.String	convertElementParts(java.lang.String fullXPointer) Converts all element scheme parts of a full XPointer into xpointer scheme parts.
protected static java.lang.String	convertShorthandXPointer(java.lang.String shorthand) Converts a shorthand XPointer into a full XPointer.
protected org.w3c.dom.NodeList	evaluateXPointer(java.lang.String xpointerString) Evaluates the URI reference XPointer.
protected static int	findClosingBrace(java.lang.String candidate, int startPos) Finds the position of the closing brace (() in the candidate string, starting at the specified start position.
protected java.lang.String	makePrefixString(java.util.Hashtable namespaces) Produces a space separated list of the namespace prefixes.
protected static java.util.Hashtable	parseXmlNSDeclarations(java.lang.String xpointerString) Evaluates the XPointer parts in the xmlns scheme, according to XPointer xmlns() Scheme.
protected static java.util.Vector	parseXPointers(java.lang.String xpointerString) Collects the XPointer parts in the xpointer scheme.
org.w3c.dom.NodeList	resolve(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult) Gets a list of DOM nodes representing a flat view on the parts of an XML document selected by the given internal URI.
protected org.w3c.dom.NodeList	resolve(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult, int resultType) Gets a list of DOM nodes representing a flat view on the parts of an XML document selected by the given internal URI.
org.w3c.dom.NodeList	resolveForest(URI uri, org.w3c.dom.Document xmlDocumentOM, org.w3c.dom.NodeList hereResult) Gets a list of DOM nodes representing a forest view on the parts of an XML document selected by the given internal URI.

Methods inherited from class java.lang.Object

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

Field Detail

XMLNS_OPENER_

protected static final java.lang.String XMLNS_OPENER_

Opener for an XPointer part in the xmlns scheme.

See Also:

Constant Field Values

XPOINTER_OPENER_

protected static final java.lang.String XPOINTER_OPENER_

Opener for an XPointer part in the xpointer scheme.

See Also:

Constant Field Values

ELEMENT_OPENER_

protected static final java.lang.String ELEMENT_OPENER_

Opener for an XPointer part in the element scheme.

See Also:

Constant Field Values

subsidiary_

protected InternalReferenceResolverImpl subsidiary_

Reference resolver used for internal URIs which are not XPointers.

xmlDocumentOM_

protected org.w3c.dom.Document xmlDocumentOM_

The XML document for which the internal URI should be resolved.

hereResult_

protected org.w3c.dom.NodeList hereResult_

Contains the result for the here() function, which could be used in the XPointer.

Constructor Detail

XPointerReferenceResolver

public XPointerReferenceResolver()

Standard constructor.

Method Detail

resolve

public org.w3c.dom.NodeList resolve(URI uri,
                                    org.w3c.dom.Document xmlDocumentOM,
                                    org.w3c.dom.NodeList hereResult)
                             throws InternalReferenceResolverException

Gets a list of DOM nodes representing a flat view on the parts of an XML document selected by the given internal URI. Please see XML Signature Syntax and Processing, section 4.3.3.3 for more information about the flat view.

Specified by:

resolve in interface InternalReferenceResolverInterface

Parameters:

uri - Specifies the internal reference. Must not be null and must either be empty ("") or reference-only (starting with #). Please see the class description for supported reference-only URIs.

xmlDocumentOM - The object model for the XML document to be processed. Must not be null .

hereResult - A org.w3c.dom.NodeList>/code> containing a single DOM node. This single DOM node should be the node containing the URI reference, according to XPointer, section 5.4.4. May be null, if the URI reference is not an XPointer, or if no call here() appears in the XPointer.

Returns:

a list of DOM nodes representing a flat view on the parts of an XML document selected by the given internal URI.

Throws:

InternalReferenceResolverException - if providing the list of DOM nodes fails for any reason.

resolveForest

public org.w3c.dom.NodeList resolveForest(URI uri,
                                          org.w3c.dom.Document xmlDocumentOM,
                                          org.w3c.dom.NodeList hereResult)
                                   throws InternalReferenceResolverException

Gets a list of DOM nodes representing a forest view on the parts of an XML document selected by the given internal URI. With "forest view" we mean exactly the same as what is described in XML Signature Syntax and Processing, section 4.3.3.3, except that step 4 will not be performed.

Parameters:

uri - Specifies the internal reference. Must not be null.

xmlDocumentOM - The object model for the XML document to be processed. Must not be null .

hereResult - A org.w3c.dom.NodeList>/code> containing a single DOM node. This single DOM node should be the node containing the URI reference, according to XPointer, section 4.5.4. May be null, if the URI reference is not an XPointer, or if no call here() appears in the XPointer.

Returns:

a list of DOM nodes representing a forest view on the parts of an XML document selected by the given internal URI.

Throws:

InternalReferenceResolverException - if providing the list of DOM nodes fails for any reason.

resolve

protected org.w3c.dom.NodeList resolve(URI uri,
                                       org.w3c.dom.Document xmlDocumentOM,
                                       org.w3c.dom.NodeList hereResult,
                                       int resultType)
                                throws InternalReferenceResolverException

Gets a list of DOM nodes representing a flat view on the parts of an XML document selected by the given internal URI. Please see XML Signature Syntax and Processing, section 4.3.3.3 for more information about the flat view.

Parameters:

uri - Specifies the internal reference. Must not be null and must either be empty ("") or reference-only (starting with #). Please see the class description for supported reference-only URIs.

xmlDocumentOM - The object model for the XML document to be processed. Must not be null .

hereResult - A org.w3c.dom.NodeList>/code> containing a single DOM node. This single DOM node should be the node containing the URI reference, according to XPointer, section 5.4.4. May be null, if the URI reference is not an XPointer, or if no call here() appears in the XPointer.

resultType - Specifies wheter element nodes in the node set resulting from evaluating the XPointer should be expanded or not. Allowed values are InternalReferenceResolverImpl.FLAT_RESULT_ and InternalReferenceResolverImpl.FOREST_RESULT_

Returns:

a list of DOM nodes representing a flat view on the parts of an XML document selected by the given internal URI.

Throws:

InternalReferenceResolverException - if providing the list of DOM nodes fails for any reason.

evaluateXPointer

protected org.w3c.dom.NodeList evaluateXPointer(java.lang.String xpointerString)
                                         throws InternalReferenceResolverException

Evaluates the URI reference XPointer. If the XPointer consists of more than one XPointer part in the xpointer scheme, the XPointer parts are evaluated from the left to the right. After the first successful evaluation the processing is stopped.

Parameters:

xpointerString - The URI reference XPointer to be evaluated.

Returns:

See resolve(iaik.ixsil.util.URI, org.w3c.dom.Document, org.w3c.dom.NodeList).

Throws:

InternalReferenceResolverException - If the evaluation fails for any reason.

makePrefixString

protected java.lang.String makePrefixString(java.util.Hashtable namespaces)

Produces a space separated list of the namespace prefixes. The namespace prefixes are derived from the keys of the specified hash table. A key in this hash table is the name of the namespace declaration attribute declaring the prefix.

Parameters:

namespaces - A hash table using namespace declaration attributes as keys.

Returns:

a space separated list of the namespace prefixes.

parseXmlNSDeclarations

protected static java.util.Hashtable parseXmlNSDeclarations(java.lang.String xpointerString)
                                                     throws InternalReferenceResolverException

Evaluates the XPointer parts in the xmlns scheme, according to XPointer xmlns() Scheme.

Parameters:

xpointerString - The XPointer string whose parts in the xmlns scheme should be evaluated.

Returns:

a hash table containing entries with the namespace declaration attribute name as the key, and the corresponding namespace URI as the value.

Throws:

InternalReferenceResolverException - if the XPointer string cannot be parsed correctly.

parseXPointers

protected static java.util.Vector parseXPointers(java.lang.String xpointerString)
                                          throws InternalReferenceResolverException

Collects the XPointer parts in the xpointer scheme.

Parameters:

xpointerString - The XPointer string whose parts in the xpointer scheme should be collected.

Returns:

a vector with the XPointer expressions of all found XPointer parts.

Throws:

InternalReferenceResolverException - if the XPointer string cannot be parsed correctly.

convertShorthandXPointer

protected static java.lang.String convertShorthandXPointer(java.lang.String shorthand)

Converts a shorthand XPointer into a full XPointer.

Parameters:

shorthand - The shorthand XPointer to be converted.

Returns:

the converted full XPointer.

convertElementPart

protected static java.lang.String convertElementPart(java.lang.String element)

Converts an element XPointer part into an xpointer XPointer part.

Parameters:

element - The element XPointer to be converted.

Returns:

the converted xpointer XPointer part.

convertElementParts

protected static java.lang.String convertElementParts(java.lang.String fullXPointer)
                                               throws InternalReferenceResolverException

Converts all element scheme parts of a full XPointer into xpointer scheme parts.

Parameters:

fullXPointer - The full XPointer to be processed.

Returns:

A full XPointer in which all element scheme parts have been converted to xpointer scheme parts.

Throws:

InternalReferenceResolverException - if the specified XPointer is malformed.

findClosingBrace

protected static int findClosingBrace(java.lang.String candidate,
                                      int startPos)
                               throws InternalReferenceResolverException

Finds the position of the closing brace (() in the candidate string, starting at the specified start position. A closing brace that is escaped with a circumflex character (^) is ignored.

Parameters:

candidate - The string to be investigated.

startPos - The position within the candidate string at which the search should start.

Returns:

the position of the first closing brace that is not escaped with a circumflex character.

Throws:

InternalReferenceResolverException - if there is no closing brace.