Package org.apache.xml.security.stax.ext
Interface InputProcessor
- All Known Implementing Classes:
AbstractDecryptInputProcessor
,AbstractDecryptInputProcessor.AbstractDecryptedEventReaderInputProcessor
,AbstractInputProcessor
,AbstractSignatureReferenceVerifyInputProcessor
,AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier
,LogInputProcessor
,XMLDecryptInputProcessor
,XMLDecryptInputProcessor.DecryptedEventReaderInputProcessor
,XMLEventReaderInputProcessor
,XMLSecurityInputProcessor
,XMLSecurityInputProcessor.InternalBufferProcessor
,XMLSecurityInputProcessor.InternalReplayProcessor
,XMLSignatureReferenceVerifyInputProcessor
public interface InputProcessor
This is the Interface which every InputProcessor must implement.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAfterProcessor
(Object processor) Add this processor after the given processorvoid
addBeforeProcessor
(Object processor) Add this processor before the given processorvoid
doFinal
(InputProcessorChain inputProcessorChain) Will be called when the whole document is processed.This InputProcessor will be added after the processors in this setThis InputProcessor will be added before the processors in this setgetPhase()
The Phase in which this InputProcessor should be appliedprocessNextEvent
(InputProcessorChain inputProcessorChain) Will be called from the framework when the next XMLEvent is requestedprocessNextHeaderEvent
(InputProcessorChain inputProcessorChain) Will be called from the framework when the next security-header XMLEvent is requested
-
Method Details
-
addBeforeProcessor
Add this processor before the given processor- Parameters:
processor
-
-
getBeforeProcessors
This InputProcessor will be added before the processors in this set- Returns:
- The set with the named InputProcessors
-
addAfterProcessor
Add this processor after the given processor- Parameters:
processor
-
-
getAfterProcessors
This InputProcessor will be added after the processors in this set- Returns:
- The set with the named InputProcessors
-
getPhase
XMLSecurityConstants.Phase getPhase()The Phase in which this InputProcessor should be applied- Returns:
- The Phase
-
processNextHeaderEvent
XMLSecEvent processNextHeaderEvent(InputProcessorChain inputProcessorChain) throws XMLStreamException, XMLSecurityException Will be called from the framework when the next security-header XMLEvent is requested- Parameters:
inputProcessorChain
-- Returns:
- The next XMLSecEvent
- Throws:
XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
processNextEvent
XMLSecEvent processNextEvent(InputProcessorChain inputProcessorChain) throws XMLStreamException, XMLSecurityException Will be called from the framework when the next XMLEvent is requested- Parameters:
inputProcessorChain
-- Returns:
- The next XMLSecEvent
- Throws:
XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
doFinal
void doFinal(InputProcessorChain inputProcessorChain) throws XMLStreamException, XMLSecurityException Will be called when the whole document is processed.- Parameters:
inputProcessorChain
-- Throws:
XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-