Module org.apache.santuario.xmlsec

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

Class FinalOutputProcessor

java.lang.Object

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

org.apache.xml.security.stax.impl.processor.output.FinalOutputProcessor

All Implemented Interfaces:

OutputProcessor

public class FinalOutputProcessor
extends AbstractOutputProcessor

Processor which outputs the XMLEvents to an outputStream This Processor can be extended to allow to write to a StAX writer instead of directly to an output stream

Field Summary

Fields

Modifier and Type	Field	Description
private XMLEventWriter	xmlEventWriter

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

action, actionOrder, securityProperties

Constructor Summary

Constructors

Constructor	Description
FinalOutputProcessor(OutputStream outputStream, String encoding)
FinalOutputProcessor(XMLStreamWriter xmlStreamWriter)

Method Summary

Modifier and Type	Method	Description
void	doFinal(OutputProcessorChain outputProcessorChain)	Will be called when the whole document is processed.
void	processEvent(XMLSecEvent xmlSecEvent, OutputProcessorChain outputProcessorChain)	Will be called from the framework for every XMLEvent

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, getActionOrder, 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

Field Details

xmlEventWriter

private XMLEventWriter xmlEventWriter

Constructor Details

FinalOutputProcessor

public FinalOutputProcessor(OutputStream outputStream,
 String encoding)
                     throws XMLSecurityException

Throws:

XMLSecurityException

FinalOutputProcessor

public FinalOutputProcessor(XMLStreamWriter xmlStreamWriter)
                     throws XMLSecurityException

Throws:

XMLSecurityException

Method Details

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

XMLSecurityException - thrown when a Security failure occurs