Skip navigation links

oracle.security.xmlsec.util
Class NodeReaderForSubtree

java.lang.Object
oracle.security.xmlsec.util.NodeReader
oracle.security.xmlsec.util.NodeReaderForSubtree

public class NodeReaderForSubtree

extends NodeReader

FOR INTERNAL USE ONLY

Nested Class Summary

class

NodeReaderForSubtree.SimpleNamedNodeMap

Nested classes/interfaces inherited from class oracle.security.xmlsec.util.NodeReader

NodeReader.NodeListener

Field Summary

Fields inherited from class oracle.security.xmlsec.util.NodeReader

CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, PROCESSING_INSTRUCTION, START_DOCUMENT, START_ELEMENT

Constructor Summary

NodeReaderForSubtree(org.w3c.dom.Node subTree)

Method Summary

java.util.Collection	getAncestorXmlAttributes(boolean c14n11) Get a list of all the xml attributes in the ancestors of this element, whether the elements are in the nodeset or not.
java.util.Iterator	getAttributes() Returns all the namespaces and attributes on this START_ELEMENT.
int	getEventType() Returns an integer code that indicates the type of the event the cursor is pointing to START_ELEMENT END_ELEMENT PROCESSING_INSTRUCTION CHARACTERS COMMENT START_DOCUMENT END_DOCUMENT
java.lang.String	getLocalName() Returns the (local) name of the current event.
java.util.Iterator	getNamespacesForMissingAncestors() Returns those inherited namespace declaration, for which the ancestor element that declares the namespace is missing from the nodeset.
java.lang.String	getNamespaceURI() If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace
org.w3c.dom.Node	getNode() Returns the current node.
java.lang.String	getPIData() Get the data section of a processing instruction
java.lang.String	getPITarget() Get the target of a processing instruction
java.lang.String	getPrefix() Returns the prefix of the current event or null if the event does not have a prefix
char[]	getText() Returns the current value of the parse event as a character array, this returns the string value of a CHARACTERS event, returns the value of a COMMENT,
int	getTextLength()
int	getTextStart()
boolean	hasNext() Returns true if there are more parsing events and false if there are no more events.
boolean	isElementAnOrphan() Returns whether this element in an orphan (i.e the element is included but its parent is not included in the nodeset).
int	next() Get next parsing event.

Methods inherited from class oracle.security.xmlsec.util.NodeReader

addListener, fireConsumeNode, getNamespaces, getSortedAttributes, isElementIncluded, isElementInheritingNamespaces, isUnnecessaryEmptyDefaultNsRequired, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeReaderForSubtree

public NodeReaderForSubtree(org.w3c.dom.Node subTree)

Method Detail

next

public final int next()

Description copied from class: NodeReader

Get next parsing event. one of

• START_ELEMENT
• END_ELEMENT
• PROCESSING_INSTRUCTION
• CHARACTERS
• COMMENT
• START_DOCUMENT
• END_DOCUMENT

Specified by:

next in class NodeReader

Returns:

getEventType

public final int getEventType()

Description copied from class: NodeReader

Returns an integer code that indicates the type of the event the cursor is pointing to

• START_ELEMENT
• END_ELEMENT
• PROCESSING_INSTRUCTION
• CHARACTERS
• COMMENT
• START_DOCUMENT
• END_DOCUMENT

Specified by:

getEventType in class NodeReader

Returns:

getLocalName

public final java.lang.String getLocalName()

Description copied from class: NodeReader

Returns the (local) name of the current event.

Specified by:

getLocalName in class NodeReader

getNamespaceURI

public final java.lang.String getNamespaceURI()

Description copied from class: NodeReader

If the current event is a START_ELEMENT or END_ELEMENT this method returns the URI of the prefix or the default namespace

Specified by:

getNamespaceURI in class NodeReader

getPrefix

public final java.lang.String getPrefix()

Description copied from class: NodeReader

Returns the prefix of the current event or null if the event does not have a prefix

Specified by:

getPrefix in class NodeReader

getPIData

public final java.lang.String getPIData()

Description copied from class: NodeReader

Get the data section of a processing instruction

Specified by:

getPIData in class NodeReader

getPITarget

public final java.lang.String getPITarget()

Description copied from class: NodeReader

Get the target of a processing instruction

Specified by:

getPITarget in class NodeReader

getText

public final char[] getText()

Description copied from class: NodeReader

Returns the current value of the parse event as a character array, this returns the string value of a CHARACTERS event, returns the value of a COMMENT,

Specified by:

getText in class NodeReader

Returns:

getTextStart

public final int getTextStart()

Specified by:

getTextStart in class NodeReader

getTextLength

public final int getTextLength()

Specified by:

getTextLength in class NodeReader

hasNext

public final boolean hasNext()

Description copied from class: NodeReader

Returns true if there are more parsing events and false if there are no more events.

Specified by:

hasNext in class NodeReader

Returns:

getNode

public final org.w3c.dom.Node getNode()

Description copied from class: NodeReader

Returns the current node. It is ok for this method to return null, it will do that for a non DOM implementation

Overrides:

getNode in class NodeReader

getAttributes

public final java.util.Iterator getAttributes()

Description copied from class: NodeReader

Returns all the namespaces and attributes on this START_ELEMENT.

All NodeReaders must implement this. Additionally a node reader may implement the NodeReader.getNamespaces() and NodeReader.getSortedAttributes() methods to return the namespaces and attributes separately.

Specified by:

getAttributes in class NodeReader

isElementAnOrphan

public boolean isElementAnOrphan()

Description copied from class: NodeReader

Returns whether this element in an orphan (i.e the element is included but its parent is not included in the nodeset). This is used in inclusiveC14N

Overrides:

isElementAnOrphan in class NodeReader

getAncestorXmlAttributes

public java.util.Collection getAncestorXmlAttributes(boolean c14n11)
                                              throws NodeReaderException

Description copied from class: NodeReader

Get a list of all the xml attributes in the ancestors of this element, whether the elements are in the nodeset or not. This is used in inclusive C14N.

Overrides:

getAncestorXmlAttributes in class NodeReader

Parameters:

c14n11 - follow C14n 1.1 rules, i.e. for simple inheritable attributes - xml:lang and xml:space, return the nearest ancestor, and for xml:base merge the values from missing ancestors

Throws:

NodeReaderException

getNamespacesForMissingAncestors

public java.util.Iterator getNamespacesForMissingAncestors()

Description copied from class: NodeReader

Returns those inherited namespace declaration, for which the ancestor element that declares the namespace is missing from the nodeset. Note: these namespaces should also included in the namespaces returned by getAttributes and getNamespaces

E.gfor this xml <foo xmlns:n1="n1"> <bar xmlns:n2="n2"/> </foo> if foo is not included in the nodeset, but bar is included, bar inherits the n1 namespace declaration. So n1 should be returned by this function and both n1 and n2 should be returned by getAttributes

Overrides:

getNamespacesForMissingAncestors in class NodeReader

Returns:

Skip navigation links