Package org.apache.xml.security.stax.ext
Interface OutputProcessor
- All Known Implementing Classes:
AbstractBufferingOutputProcessor,AbstractEncryptEndingOutputProcessor,AbstractEncryptOutputProcessor,AbstractEncryptOutputProcessor.AbstractInternalEncryptionOutputProcessor,AbstractOutputProcessor,AbstractSignatureEndingOutputProcessor,AbstractSignatureEndingOutputProcessor.SignedInfoProcessor,AbstractSignatureOutputProcessor,AbstractSignatureOutputProcessor.InternalSignatureOutputProcessor,FinalOutputProcessor,XMLEncryptOutputProcessor,XMLSignatureEndingOutputProcessor,XMLSignatureOutputProcessor
public interface OutputProcessor
This is the Interface which every OutputProcessor must implement.
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddAfterProcessor(Object processor) Add this processor after the given processorvoidaddBeforeProcessor(Object processor) Add this processor before the given processorvoiddoFinal(OutputProcessorChain outputProcessorChain) Will be called when the whole document is processed.This OutputProcessor will be added after the processors in this setThis OutputProcessor will be added before the processors in this setgetPhase()The Phase in which this OutputProcessor should be appliedvoidinit(OutputProcessorChain outputProcessorChain) Method will be called after setting the propertiesvoidprocessNextEvent(XMLSecEvent xmlSecEvent, OutputProcessorChain outputProcessorChain) Will be called from the framework for every XMLEventvoidsetAction(XMLSecurityConstants.Action action) setter for the Action after instantiation of the processorvoidsetXMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties) setter for the XMLSecurityProperties after instantiation of the processor
-
Method Details
-
setXMLSecurityProperties
setter for the XMLSecurityProperties after instantiation of the processor- Parameters:
xmlSecurityProperties-
-
setAction
setter for the Action after instantiation of the processor- Parameters:
action-
-
init
Method will be called after setting the properties- Throws:
XMLSecurityException
-
addBeforeProcessor
Add this processor before the given processor- Parameters:
processor-
-
getBeforeProcessors
This OutputProcessor will be added before the processors in this set- Returns:
- The set with the named OutputProcessor
-
addAfterProcessor
Add this processor after the given processor- Parameters:
processor-
-
getAfterProcessors
This OutputProcessor will be added after the processors in this set- Returns:
- The set with the named OutputProcessor
-
getPhase
XMLSecurityConstants.Phase getPhase()The Phase in which this OutputProcessor should be applied- Returns:
- The Phase
-
processNextEvent
void processNextEvent(XMLSecEvent xmlSecEvent, OutputProcessorChain outputProcessorChain) throws XMLStreamException, XMLSecurityException Will be called from the framework for every XMLEvent- Parameters:
xmlSecEvent- The next XMLEvent to processoutputProcessorChain-- Throws:
XMLStreamException- thrown when a streaming error occursXMLSecurityException- thrown when a Security failure occurs
-
doFinal
void doFinal(OutputProcessorChain outputProcessorChain) throws XMLStreamException, XMLSecurityException Will be called when the whole document is processed.- Parameters:
outputProcessorChain-- Throws:
XMLStreamException- thrown when a streaming error occursXMLSecurityException- thrown when a Security failure occurs
-