Module org.apache.santuario.xmlsec

Package org.apache.xml.security.stax.impl.processor.input

Class XMLEventReaderInputProcessor

java.lang.Object

org.apache.xml.security.stax.ext.AbstractInputProcessor

org.apache.xml.security.stax.impl.processor.input.XMLEventReaderInputProcessor

All Implemented Interfaces:

InputProcessor

public class XMLEventReaderInputProcessor
extends AbstractInputProcessor

The XMLEventReaderInputProcessor reads requested XMLEvents from the original XMLEventReader and returns them to the requester

Field Summary

Fields

Modifier and Type	Field	Description
private int	currentXMLStructureDepth
private boolean	EOF
private static final Integer	maximumAllowedXMLStructureDepth
private XMLSecStartElement	parentXmlSecStartElement
private final XMLStreamReader	xmlStreamReader

Constructor Summary

Constructors

Constructor	Description
XMLEventReaderInputProcessor(XMLSecurityProperties securityProperties, XMLStreamReader xmlStreamReader)

Method Summary

Modifier and Type	Method	Description
void	doFinal(InputProcessorChain inputProcessorChain)	Will be called when the whole document is processed.
XMLSecEvent	processEvent(InputProcessorChain inputProcessorChain)	Will be called from the framework when the next XMLEvent is requested
private XMLSecEvent	processEventInternal()
XMLSecEvent	processHeaderEvent(InputProcessorChain inputProcessorChain)	Will be called from the framework when the next security-header XMLEvent is requested

Methods inherited from class org.apache.xml.security.stax.ext.AbstractInputProcessor

addAfterProcessor, addBeforeProcessor, getAfterProcessors, getBeforeProcessors, getPhase, getReferenceIDAttribute, getSecurityProperties, setPhase

Methods inherited from class java.lang.Object

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

Field Details

maximumAllowedXMLStructureDepth

private static final Integer maximumAllowedXMLStructureDepth

currentXMLStructureDepth

private int currentXMLStructureDepth

xmlStreamReader

private final XMLStreamReader xmlStreamReader

parentXmlSecStartElement

private XMLSecStartElement parentXmlSecStartElement

EOF

private boolean EOF

Constructor Details

XMLEventReaderInputProcessor

public XMLEventReaderInputProcessor(XMLSecurityProperties securityProperties,
 XMLStreamReader xmlStreamReader)

Method Details

processHeaderEvent

public XMLSecEvent processHeaderEvent(InputProcessorChain inputProcessorChain)
                               throws XMLStreamException,
XMLSecurityException

Description copied from interface: InputProcessor

Will be called from the framework when the next security-header XMLEvent is requested

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processEvent

public XMLSecEvent processEvent(InputProcessorChain inputProcessorChain)
                         throws XMLStreamException,
XMLSecurityException

Description copied from interface: InputProcessor

Will be called from the framework when the next XMLEvent is requested

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processEventInternal

private XMLSecEvent processEventInternal()
                                  throws XMLStreamException

Throws:

XMLStreamException

doFinal

public void doFinal(InputProcessorChain inputProcessorChain)
             throws XMLStreamException,
XMLSecurityException

Description copied from interface: InputProcessor

Will be called when the whole document is processed.

Specified by:

doFinal in interface InputProcessor

Overrides:

doFinal in class AbstractInputProcessor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs