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

Version:

$Revision: 1395267 $ $Date: 2012-10-07 11:02:46 +0100 (Sun, 07 Oct 2012) $

Author:

$Author: giger $

Constructor Summary

XMLEventReaderInputProcessor(XMLSecurityProperties securityProperties, XMLStreamReader xmlStreamReader)

Method Summary

void	doFinal(InputProcessorChain inputProcessorChain) Will be called when the whole document is processed.
XMLSecEvent	processNextEvent(InputProcessorChain inputProcessorChain) Will be called from the framework when the next XMLEvent is requested
XMLSecEvent	processNextHeaderEvent(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

Constructor Detail

XMLEventReaderInputProcessor

public XMLEventReaderInputProcessor(XMLSecurityProperties securityProperties,
                                    XMLStreamReader xmlStreamReader)

Method Detail

processNextHeaderEvent

public XMLSecEvent processNextHeaderEvent(InputProcessorChain inputProcessorChain)
                                   throws XMLStreamException,
                                          XMLSecurityException

Description copied from interface: InputProcessor

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

Specified by:

processNextHeaderEvent in interface InputProcessor

Specified by:

processNextHeaderEvent in class AbstractInputProcessor

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processNextEvent

public XMLSecEvent processNextEvent(InputProcessorChain inputProcessorChain)
                             throws XMLStreamException,
                                    XMLSecurityException

Description copied from interface: InputProcessor

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

Specified by:

processNextEvent in interface InputProcessor

Specified by:

processNextEvent in class AbstractInputProcessor

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

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