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

public abstract class AbstractInputProcessor
extends Object
implements InputProcessor

An abstract InputProcessor class for reusabilty

Version:

$Revision: 1399606 $ $Date: 2012-10-18 13:17:41 +0100 (Thu, 18 Oct 2012) $

Author:

$Author: giger $

Constructor Summary

AbstractInputProcessor(XMLSecurityProperties securityProperties)

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
Attribute	getReferenceIDAttribute(XMLSecStartElement xmlSecStartElement)
XMLSecurityProperties	getSecurityProperties()
abstract XMLSecEvent	processNextEvent(InputProcessorChain inputProcessorChain) Will be called from the framework when the next XMLEvent is requested
abstract XMLSecEvent	processNextHeaderEvent(InputProcessorChain inputProcessorChain) Will be called from the framework when the next security-header XMLEvent is requested
void	setPhase(XMLSecurityConstants.Phase phase)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractInputProcessor

public AbstractInputProcessor(XMLSecurityProperties securityProperties)

Method Detail

getPhase

public XMLSecurityConstants.Phase getPhase()

Description copied from interface: InputProcessor

The Phase in which this InputProcessor should be applied

Specified by:

getPhase in interface InputProcessor

Returns:

The Phase

setPhase

public void setPhase(XMLSecurityConstants.Phase phase)

addBeforeProcessor

public void addBeforeProcessor(Object processor)

Description copied from interface: InputProcessor

Add this processor before the given processor

Specified by:

addBeforeProcessor in interface InputProcessor

getBeforeProcessors

public Set<Object> getBeforeProcessors()

Description copied from interface: InputProcessor

This InputProcessor will be added before the processors in this set

Specified by:

getBeforeProcessors in interface InputProcessor

Returns:

The set with the named InputProcessors

addAfterProcessor

public void addAfterProcessor(Object processor)

Description copied from interface: InputProcessor

Add this processor after the given processor

Specified by:

addAfterProcessor in interface InputProcessor

getAfterProcessors

public Set<Object> getAfterProcessors()

Description copied from interface: InputProcessor

This InputProcessor will be added after the processors in this set

Specified by:

getAfterProcessors in interface InputProcessor

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 interface InputProcessor

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - 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 interface InputProcessor

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - 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 interface InputProcessor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

getSecurityProperties

public XMLSecurityProperties getSecurityProperties()

getReferenceIDAttribute

public Attribute getReferenceIDAttribute(XMLSecStartElement xmlSecStartElement)