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

public abstract class AbstractInputProcessor
extends java.lang.Object
implements InputProcessor

An abstract InputProcessor class for reusabilty

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Set<java.lang.Object>	afterProcessors
private java.util.Set<java.lang.Object>	beforeProcessors
private XMLSecurityConstants.Phase	phase
private XMLSecurityProperties	securityProperties

Constructor Summary

Constructors

Constructor	Description
AbstractInputProcessor(XMLSecurityProperties securityProperties)

Method Summary

Modifier and Type	Method	Description
void	addAfterProcessor(java.lang.Object processor)	Add this processor after the given processor
void	addBeforeProcessor(java.lang.Object processor)	Add this processor before the given processor
void	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 set
java.util.Set<java.lang.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
javax.xml.stream.events.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

Field Detail

securityProperties

private final XMLSecurityProperties securityProperties

phase

private XMLSecurityConstants.Phase phase

beforeProcessors

private java.util.Set<java.lang.Object> beforeProcessors

afterProcessors

private java.util.Set<java.lang.Object> afterProcessors

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(java.lang.Object processor)

Description copied from interface: InputProcessor

Add this processor before the given processor

Specified by:

addBeforeProcessor in interface InputProcessor

getBeforeProcessors

public java.util.Set<java.lang.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(java.lang.Object processor)

Description copied from interface: InputProcessor

Add this processor after the given processor

Specified by:

addAfterProcessor in interface InputProcessor

getAfterProcessors

public java.util.Set<java.lang.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 javax.xml.stream.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:

javax.xml.stream.XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processNextEvent

public abstract XMLSecEvent processNextEvent(InputProcessorChain inputProcessorChain)
                                      throws javax.xml.stream.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:

javax.xml.stream.XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

doFinal

public void doFinal(InputProcessorChain inputProcessorChain)
             throws javax.xml.stream.XMLStreamException,
                    XMLSecurityException

Description copied from interface: InputProcessor

Will be called when the whole document is processed.

Specified by:

doFinal in interface InputProcessor

Throws:

javax.xml.stream.XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

getSecurityProperties

public XMLSecurityProperties getSecurityProperties()

getReferenceIDAttribute

public javax.xml.stream.events.Attribute getReferenceIDAttribute(XMLSecStartElement xmlSecStartElement)