oracle.security.xmlsec.wss.transform

Class StreamingSTRTransform.STRNodeReader

java.lang.Object

oracle.security.xmlsec.util.NodeReader

oracle.security.xmlsec.wss.transform.StreamingSTRTransform.STRNodeReader

Enclosing class:

StreamingSTRTransform

public class StreamingSTRTransform.STRNodeReader
extends NodeReader

Nested Class Summary

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

Constructors

Constructor and Description
STRNodeReader(NodeReader nr, java.util.Map<WSSecurityTokenReference,WSSecurityToken> STRToST)

Method Summary

Modifier and Type	Method and Description
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.Map	getNamespaces() Returns all the namespaces on this START_ELEMENT.
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
java.util.SortedMap	getSortedAttributes() Returns all the attributes (not namespaces) on this START_ELEMENT.
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).
boolean	isElementIncluded() For special case when some of an element's attributes are in the node set but the element itself is not
boolean	isElementInheritingNamespaces() Whether the element inherits all the namespaces of its parents.
boolean	isUnnecessaryEmptyDefaultNsRequired() This is only used for STR-Transform and Decrpyt Transform where apex nodes in replacement nodesets should have xmlns="" if the apex node doesn't define the default namespace.
int	next() Get next parsing event.

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

addListener, fireConsumeNode, getNamespacesForMissingAncestors, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

STRNodeReader

public STRNodeReader(NodeReader nr,
                     java.util.Map<WSSecurityTokenReference,WSSecurityToken> STRToST)
              throws NodeReaderException

Throws:

NodeReaderException

Method Detail

next

public int next()
         throws NodeReaderException

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:

Throws:

NodeReaderException

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

getAttributes

public 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

getEventType

public 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 java.lang.String getLocalName()

Description copied from class: NodeReader

Returns the (local) name of the current event.

Specified by:

getLocalName in class NodeReader

getNamespaces

public java.util.Map getNamespaces()

Description copied from class: NodeReader

Returns all the namespaces on this START_ELEMENT. This method only exists for performance. If this method returns null then the getAttributes() method is used The map should contain Prefix->NamespaceNode

Overrides:

getNamespaces in class NodeReader

getNamespaceURI

public 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

getNode

public 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

getPIData

public 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 java.lang.String getPITarget()

Description copied from class: NodeReader

Get the target of a processing instruction

Specified by:

getPITarget in class NodeReader

getPrefix

public 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

getSortedAttributes

public java.util.SortedMap getSortedAttributes()

Description copied from class: NodeReader

Returns all the attributes (not namespaces) on this START_ELEMENT. This method only exists for performance. If this method returns null then the getAttributes() method is used, The map should contain Attr->DUMMY. the map should use StreamC14nImpl.AttrComparator as its comparator to sort the attributes

Overrides:

getSortedAttributes in class NodeReader

getText

public 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:

getTextLength

public int getTextLength()

Specified by:

getTextLength in class NodeReader

getTextStart

public int getTextStart()

Specified by:

getTextStart in class NodeReader

hasNext

public boolean hasNext()
                throws NodeReaderException

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:

Throws:

NodeReaderException

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

isElementIncluded

public boolean isElementIncluded()

Description copied from class: NodeReader

For special case when some of an element's attributes are in the node set but the element itself is not

Overrides:

isElementIncluded in class NodeReader

isElementInheritingNamespaces

public boolean isElementInheritingNamespaces()

Description copied from class: NodeReader

Whether the element inherits all the namespaces of its parents. Normally it does, but only in case of an XPath nodeset, each element has its own list of namespace nodes and this is false

Overrides:

isElementInheritingNamespaces in class NodeReader

isUnnecessaryEmptyDefaultNsRequired

public boolean isUnnecessaryEmptyDefaultNsRequired()

Description copied from class: NodeReader

This is only used for STR-Transform and Decrpyt Transform where apex nodes in replacement nodesets should have xmlns="" if the apex node doesn't define the default namespace. Note xmlns="" is required to be output even if that been output before and even if it not used

Overrides:

isUnnecessaryEmptyDefaultNsRequired in class NodeReader

Returns: