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
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(InputProcessorChain inputProcessorChain)
Will be called when the whole document is processed.java.util.Set<java.lang.Object>
getAfterProcessors()
This InputProcessor will be added after the processors in this setjava.util.Set<java.lang.Object>
getBeforeProcessors()
This InputProcessor will be added before the processors in this setXMLSecurityConstants.Phase
getPhase()
The Phase in which this InputProcessor should be appliedXMLSecEvent
processNextEvent(InputProcessorChain inputProcessorChain)
Will be called from the framework when the next XMLEvent is requestedXMLSecEvent
processNextHeaderEvent(InputProcessorChain inputProcessorChain)
Will be called from the framework when the next security-header XMLEvent is requested
-
-
-
Method Detail
-
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 InputProcessor will be added before the processors in this set- Returns:
- The set with the named InputProcessors
-
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 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 javax.xml.stream.XMLStreamException, XMLSecurityException
Will be called from the framework when the next security-header XMLEvent is requested- Parameters:
inputProcessorChain
-- Returns:
- The next XMLSecEvent
- Throws:
javax.xml.stream.XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
processNextEvent
XMLSecEvent processNextEvent(InputProcessorChain inputProcessorChain) throws javax.xml.stream.XMLStreamException, XMLSecurityException
Will be called from the framework when the next XMLEvent is requested- Parameters:
inputProcessorChain
-- Returns:
- The next XMLSecEvent
- Throws:
javax.xml.stream.XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
doFinal
void doFinal(InputProcessorChain inputProcessorChain) throws javax.xml.stream.XMLStreamException, XMLSecurityException
Will be called when the whole document is processed.- Parameters:
inputProcessorChain
-- Throws:
javax.xml.stream.XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
-