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.

Version:
$Revision: 1395267 $ $Date: 2012-10-07 11:02:46 +0100 (Sun, 07 Oct 2012) $
Author:
$Author: giger $

Method Summary
 void addAfterProcessor(Object processor)
          Add this processor after the given processor
 void addBeforeProcessor(Object processor)
          Add this processor before the given processor
 void doFinal(InputProcessorChain inputProcessorChain)
          Will be called when the whole document is processed.
 Set<Object> getAfterProcessors()
          This InputProcessor will be added after the processors in this set
 Set<Object> getBeforeProcessors()
          This InputProcessor will be added before the processors in this set
 XMLSecurityConstants.Phase getPhase()
          The Phase in which this InputProcessor should be applied
 XMLSecEvent processNextEvent(InputProcessorChain inputProcessorChain)
          Will be called from the framework when the next XMLEvent is requested
 XMLSecEvent processNextHeaderEvent(InputProcessorChain inputProcessorChain)
          Will be called from the framework when the next security-header XMLEvent is requested
 

Method Detail

addBeforeProcessor

void addBeforeProcessor(Object processor)
Add this processor before the given processor

Parameters:
processor -

getBeforeProcessors

Set<Object> getBeforeProcessors()
This InputProcessor will be added before the processors in this set

Returns:
The set with the named InputProcessors

addAfterProcessor

void addAfterProcessor(Object processor)
Add this processor after the given processor

Parameters:
processor -

getAfterProcessors

Set<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 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 occurs
XMLSecurityException - 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 occurs
XMLSecurityException - 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 occurs
XMLSecurityException - thrown when a Security failure occurs


Copyright © 2000–2014 The Apache Software Foundation. All rights reserved.