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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAfterProcessor(java.lang.Object processor)
Add this processor after the given processorvoid
addBeforeProcessor(java.lang.Object processor)
Add this processor before the given processorvoid
doFinal(OutputProcessorChain outputProcessorChain)
Will be called when the whole document is processed.java.util.Set<java.lang.Object>
getAfterProcessors()
This OutputProcessor will be added after the processors in this setjava.util.Set<java.lang.Object>
getBeforeProcessors()
This OutputProcessor will be added before the processors in this setXMLSecurityConstants.Phase
getPhase()
The Phase in which this OutputProcessor should be appliedvoid
init(OutputProcessorChain outputProcessorChain)
Method will be called after setting the propertiesvoid
processNextEvent(XMLSecEvent xmlSecEvent, OutputProcessorChain outputProcessorChain)
Will be called from the framework for every XMLEventvoid
setAction(XMLSecurityConstants.Action action)
setter for the Action after instantiation of the processorvoid
setXMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties)
setter for the XMLSecurityProperties after instantiation of the processor
-
-
-
Method Detail
-
setXMLSecurityProperties
void setXMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties)
setter for the XMLSecurityProperties after instantiation of the processor- Parameters:
xmlSecurityProperties
-
-
setAction
void setAction(XMLSecurityConstants.Action action)
setter for the Action after instantiation of the processor- Parameters:
action
-
-
init
void init(OutputProcessorChain outputProcessorChain) throws XMLSecurityException
Method will be called after setting the properties- Throws:
XMLSecurityException
-
addBeforeProcessor
void addBeforeProcessor(java.lang.Object processor)
Add this processor before the given processor- Parameters:
processor
-
-
getBeforeProcessors
java.util.Set<java.lang.Object> getBeforeProcessors()
This OutputProcessor will be added before the processors in this set- Returns:
- The set with the named OutputProcessor
-
addAfterProcessor
void addAfterProcessor(java.lang.Object processor)
Add this processor after the given processor- Parameters:
processor
-
-
getAfterProcessors
java.util.Set<java.lang.Object> 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 javax.xml.stream.XMLStreamException, XMLSecurityException
Will be called from the framework for every XMLEvent- Parameters:
xmlSecEvent
- The next XMLEvent to processoutputProcessorChain
-- Throws:
javax.xml.stream.XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
doFinal
void doFinal(OutputProcessorChain outputProcessorChain) throws javax.xml.stream.XMLStreamException, XMLSecurityException
Will be called when the whole document is processed.- Parameters:
outputProcessorChain
-- Throws:
javax.xml.stream.XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
-