Package org.apache.xml.security.stax.ext
Class AbstractInputProcessor
java.lang.Object
org.apache.xml.security.stax.ext.AbstractInputProcessor
- All Implemented Interfaces:
InputProcessor
- Direct Known Subclasses:
AbstractDecryptInputProcessor
,AbstractDecryptInputProcessor.AbstractDecryptedEventReaderInputProcessor
,AbstractSignatureReferenceVerifyInputProcessor
,AbstractSignatureReferenceVerifyInputProcessor.InternalSignatureReferenceVerifier
,LogInputProcessor
,XMLEventReaderInputProcessor
,XMLSecurityInputProcessor
,XMLSecurityInputProcessor.InternalBufferProcessor
,XMLSecurityInputProcessor.InternalReplayProcessor
An abstract InputProcessor class for reusabilty
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate XMLSecurityConstants.Phase
private final XMLSecurityProperties
-
Constructor Summary
Constructors -
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 appliedgetReferenceIDAttribute
(XMLSecStartElement xmlSecStartElement) abstract XMLSecEvent
processNextEvent
(InputProcessorChain inputProcessorChain) Will be called from the framework when the next XMLEvent is requestedabstract XMLSecEvent
processNextHeaderEvent
(InputProcessorChain inputProcessorChain) Will be called from the framework when the next security-header XMLEvent is requestedvoid
-
Field Details
-
securityProperties
-
phase
-
beforeProcessors
-
afterProcessors
-
-
Constructor Details
-
AbstractInputProcessor
-
-
Method Details
-
getPhase
Description copied from interface:InputProcessor
The Phase in which this InputProcessor should be applied- Specified by:
getPhase
in interfaceInputProcessor
- Returns:
- The Phase
-
setPhase
-
addBeforeProcessor
Description copied from interface:InputProcessor
Add this processor before the given processor- Specified by:
addBeforeProcessor
in interfaceInputProcessor
-
getBeforeProcessors
Description copied from interface:InputProcessor
This InputProcessor will be added before the processors in this set- Specified by:
getBeforeProcessors
in interfaceInputProcessor
- Returns:
- The set with the named InputProcessors
-
addAfterProcessor
Description copied from interface:InputProcessor
Add this processor after the given processor- Specified by:
addAfterProcessor
in interfaceInputProcessor
-
getAfterProcessors
Description copied from interface:InputProcessor
This InputProcessor will be added after the processors in this set- Specified by:
getAfterProcessors
in interfaceInputProcessor
- Returns:
- The set with the named InputProcessors
-
processNextHeaderEvent
public abstract XMLSecEvent processNextHeaderEvent(InputProcessorChain inputProcessorChain) throws XMLStreamException, XMLSecurityException Description copied from interface:InputProcessor
Will be called from the framework when the next security-header XMLEvent is requested- Specified by:
processNextHeaderEvent
in interfaceInputProcessor
- Returns:
- The next XMLSecEvent
- Throws:
XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
processNextEvent
public abstract XMLSecEvent processNextEvent(InputProcessorChain inputProcessorChain) throws XMLStreamException, XMLSecurityException Description copied from interface:InputProcessor
Will be called from the framework when the next XMLEvent is requested- Specified by:
processNextEvent
in interfaceInputProcessor
- Returns:
- The next XMLSecEvent
- Throws:
XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
doFinal
public void doFinal(InputProcessorChain inputProcessorChain) throws XMLStreamException, XMLSecurityException Description copied from interface:InputProcessor
Will be called when the whole document is processed.- Specified by:
doFinal
in interfaceInputProcessor
- Throws:
XMLStreamException
- thrown when a streaming error occursXMLSecurityException
- thrown when a Security failure occurs
-
getSecurityProperties
-
getReferenceIDAttribute
-