Skip navigation links

Oracle Security Developer Tools Web Services Security Java API Reference
11g (11.1.1)

E10678-02


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

java.lang.Object
  extended by oracle.security.xmlsec.util.NodeReader
      extended by oracle.security.xmlsec.wss.transform.StreamingSTRTransform.STRNodeReader

Enclosing class:
StreamingSTRTransform

public class StreamingSTRTransform.STRNodeReader
extends oracle.security.xmlsec.util.NodeReader

Nested Class Summary

 

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

 

Field Summary

 

Fields inherited from class oracle.security.xmlsec.util.NodeReader
CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, PROCESSING_INSTRUCTION, START_DOCUMENT, START_ELEMENT

 

Constructor Summary
StreamingSTRTransform.STRNodeReader(oracle.security.xmlsec.util.NodeReader nr, java.util.Map<WSSecurityTokenReference,WSSecurityToken> STRToST)
           

 

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.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

StreamingSTRTransform.STRNodeReader

public StreamingSTRTransform.STRNodeReader(oracle.security.xmlsec.util.NodeReader nr,
                                           java.util.Map<WSSecurityTokenReference,WSSecurityToken> STRToST)
                                    throws oracle.security.xmlsec.util.NodeReaderException
Throws:
oracle.security.xmlsec.util.NodeReaderException

Method Detail

next

public int next()
         throws oracle.security.xmlsec.util.NodeReaderException
Description copied from class: oracle.security.xmlsec.util.NodeReader
Get next parsing event. one of
Specified by:
next in class oracle.security.xmlsec.util.NodeReader
Returns:
Throws:
oracle.security.xmlsec.util.NodeReaderException

getAncestorXmlAttributes

public java.util.Collection getAncestorXmlAttributes(boolean c14n11)
                                              throws oracle.security.xmlsec.util.NodeReaderException
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.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:
oracle.security.xmlsec.util.NodeReaderException

getAttributes

public java.util.Iterator getAttributes()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

getEventType

public int getEventType()
Description copied from class: oracle.security.xmlsec.util.NodeReader
Returns an integer code that indicates the type of the event the cursor is pointing to
Specified by:
getEventType in class oracle.security.xmlsec.util.NodeReader
Returns:

getLocalName

public java.lang.String getLocalName()
Description copied from class: oracle.security.xmlsec.util.NodeReader
Returns the (local) name of the current event.
Specified by:
getLocalName in class oracle.security.xmlsec.util.NodeReader

getNamespaces

public java.util.Map getNamespaces()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

getNamespaceURI

public java.lang.String getNamespaceURI()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

getNode

public org.w3c.dom.Node getNode()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

getPIData

public java.lang.String getPIData()
Description copied from class: oracle.security.xmlsec.util.NodeReader
Get the data section of a processing instruction
Specified by:
getPIData in class oracle.security.xmlsec.util.NodeReader

getPITarget

public java.lang.String getPITarget()
Description copied from class: oracle.security.xmlsec.util.NodeReader
Get the target of a processing instruction
Specified by:
getPITarget in class oracle.security.xmlsec.util.NodeReader

getPrefix

public java.lang.String getPrefix()
Description copied from class: oracle.security.xmlsec.util.NodeReader
Returns the prefix of the current event or null if the event does not have a prefix
Specified by:
getPrefix in class oracle.security.xmlsec.util.NodeReader

getSortedAttributes

public java.util.SortedMap getSortedAttributes()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

getText

public char[] getText()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader
Returns:

getTextLength

public int getTextLength()
Specified by:
getTextLength in class oracle.security.xmlsec.util.NodeReader

getTextStart

public int getTextStart()
Specified by:
getTextStart in class oracle.security.xmlsec.util.NodeReader

hasNext

public boolean hasNext()
                throws oracle.security.xmlsec.util.NodeReaderException
Description copied from class: oracle.security.xmlsec.util.NodeReader
Returns true if there are more parsing events and false if there are no more events.
Specified by:
hasNext in class oracle.security.xmlsec.util.NodeReader
Returns:
Throws:
oracle.security.xmlsec.util.NodeReaderException

isElementAnOrphan

public boolean isElementAnOrphan()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

isElementIncluded

public boolean isElementIncluded()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

isElementInheritingNamespaces

public boolean isElementInheritingNamespaces()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader

isUnnecessaryEmptyDefaultNsRequired

public boolean isUnnecessaryEmptyDefaultNsRequired()
Description copied from class: oracle.security.xmlsec.util.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 oracle.security.xmlsec.util.NodeReader
Returns:

Skip navigation links

Oracle Security Developer Tools Web Services Security Java API Reference
11g (11.1.1)

E10678-02


Copyright © 2005, 2009, Oracle. All rights reserved.