org.apache.xml.security.stax.impl.processor.input
Class XMLSecurityInputProcessor

java.lang.Object
  org.apache.xml.security.stax.ext.AbstractInputProcessor
      org.apache.xml.security.stax.impl.processor.input.XMLSecurityInputProcessor

All Implemented Interfaces:

InputProcessor

public class XMLSecurityInputProcessor
extends AbstractInputProcessor

Processor for XML Security.

Version:

$Revision: 1354898 $ $Date: 2012-06-28 11:19:02 +0100 (Thu, 28 Jun 2012) $

Author:

$Author: coheigea $

Nested Class Summary

class	XMLSecurityInputProcessor.InternalBufferProcessor Temporary Processor to buffer all events until the end of the required actions
class	XMLSecurityInputProcessor.InternalReplayProcessor Temporary processor to replay the buffered events

Constructor Summary

XMLSecurityInputProcessor(XMLSecurityProperties securityProperties)

Method Summary

void	doFinal(InputProcessorChain inputProcessorChain) Will be called when the whole document is processed.
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

Methods inherited from class org.apache.xml.security.stax.ext.AbstractInputProcessor

addAfterProcessor, addBeforeProcessor, getAfterProcessors, getBeforeProcessors, getPhase, getReferenceIDAttribute, getSecurityProperties, setPhase

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLSecurityInputProcessor

public XMLSecurityInputProcessor(XMLSecurityProperties securityProperties)

Method Detail

processNextHeaderEvent

public 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

Specified by:

processNextHeaderEvent in class AbstractInputProcessor

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

processNextEvent

public 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

Specified by:

processNextEvent in class AbstractInputProcessor

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

Overrides:

doFinal in class AbstractInputProcessor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs