org.apache.xml.security.stax.ext

Class AbstractBufferingOutputProcessor

java.lang.Object

org.apache.xml.security.stax.ext.AbstractOutputProcessor

org.apache.xml.security.stax.ext.AbstractBufferingOutputProcessor

All Implemented Interfaces:

OutputProcessor

Direct Known Subclasses:

AbstractEncryptEndingOutputProcessor, AbstractSignatureEndingOutputProcessor

public abstract class AbstractBufferingOutputProcessor
extends AbstractOutputProcessor

An abstract OutputProcessor class for reusabilty

Field Summary

Fields inherited from class org.apache.xml.security.stax.ext.AbstractOutputProcessor

action, securityProperties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBufferingOutputProcessor()

Method Summary

Modifier and Type	Method and Description
void	doFinal(OutputProcessorChain outputProcessorChain) Will be called when the whole document is processed.
protected void	flushBufferAndCallbackAfterHeader(OutputProcessorChain outputProcessorChain, Deque<XMLSecEvent> xmlSecEventDeque)
protected Deque<XMLSecEvent>	getXmlSecEventBuffer()
void	processEvent(XMLSecEvent xmlSecEvent, OutputProcessorChain outputProcessorChain) Will be called from the framework for every XMLEvent
protected abstract void	processHeaderEvent(OutputProcessorChain outputProcessorChain)

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

addAfterProcessor, addAttributes, addBeforeProcessor, createAttribute, createCharacters, createCharacters, createCharactersAndOutputAsEvent, createCharactersAndOutputAsEvent, createEndElement, createEndElementAndOutputAsEvent, createNamespace, createStartElementAndOutputAsEvent, createStartElementAndOutputAsEvent, getAction, getAfterProcessors, getBeforeProcessors, getPhase, getSecurityProperties, init, outputAsEvent, outputDOMElement, securePartMatches, securePartMatches, setAction, setPhase, setXMLSecurityProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBufferingOutputProcessor

protected AbstractBufferingOutputProcessor()
                                    throws XMLSecurityException

Throws:

XMLSecurityException

Method Detail

getXmlSecEventBuffer

protected Deque<XMLSecEvent> getXmlSecEventBuffer()

processEvent

public void processEvent(XMLSecEvent xmlSecEvent,
                         OutputProcessorChain outputProcessorChain)
                  throws XMLStreamException,
                         XMLSecurityException

Description copied from interface: OutputProcessor

Will be called from the framework for every XMLEvent

Parameters:

xmlSecEvent - The next XMLEvent to process

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

doFinal

public void doFinal(OutputProcessorChain outputProcessorChain)
             throws XMLStreamException,
                    XMLSecurityException

Description copied from interface: OutputProcessor

Will be called when the whole document is processed.

Specified by:

doFinal in interface OutputProcessor

Overrides:

doFinal in class AbstractOutputProcessor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processHeaderEvent

protected abstract void processHeaderEvent(OutputProcessorChain outputProcessorChain)
                                    throws XMLStreamException,
                                           XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

flushBufferAndCallbackAfterHeader

protected void flushBufferAndCallbackAfterHeader(OutputProcessorChain outputProcessorChain,
                                                 Deque<XMLSecEvent> xmlSecEventDeque)
                                          throws XMLStreamException,
                                                 XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException