org.apache.xml.security.stax.ext

Interface OutputProcessorChain

All Superinterfaces:

ProcessorChain

All Known Implementing Classes:

OutputProcessorChainImpl

public interface OutputProcessorChain
extends ProcessorChain

The OutputProcessorChain manages the OutputProcessors and controls the XMLEvent flow

Method Summary

Modifier and Type	Method and Description
void	addProcessor(OutputProcessor outputProcessor) Adds an OutputProcessor to the chain.
OutputProcessorChain	createSubChain(OutputProcessor outputProcessor) Create a new SubChain.
OutputProcessorChain	createSubChain(OutputProcessor outputProcessor, XMLSecStartElement parentXMLSecStartElement)
DocumentContext	getDocumentContext() The actual processed document's document context
List<OutputProcessor>	getProcessors() Returns a list with the active processors.
OutboundSecurityContext	getSecurityContext() The actual processed document's security context
void	processEvent(XMLSecEvent xmlSecEvent) Forwards the XMLEvent to the next processor in the chain.
void	removeProcessor(OutputProcessor outputProcessor) Removes the specified OutputProcessor from this chain.

Methods inherited from interface org.apache.xml.security.stax.ext.ProcessorChain

doFinal, reset

Method Detail

addProcessor

void addProcessor(OutputProcessor outputProcessor)

Adds an OutputProcessor to the chain. The place where it will be applied can be controlled through the Phase, getBeforeProcessors and getAfterProcessors. @see Interface OutputProcessor

Parameters:

outputProcessor - The OutputProcessor which should be placed in the chain

removeProcessor

void removeProcessor(OutputProcessor outputProcessor)

Removes the specified OutputProcessor from this chain.

Parameters:

outputProcessor - to remove

getProcessors

List<OutputProcessor> getProcessors()

Returns a list with the active processors.

Returns:

a list with the active processors

getSecurityContext

OutboundSecurityContext getSecurityContext()

The actual processed document's security context

Returns:

The InboundSecurityContext

getDocumentContext

DocumentContext getDocumentContext()

The actual processed document's document context

Returns:

The DocumentContext

createSubChain

OutputProcessorChain createSubChain(OutputProcessor outputProcessor)
                             throws XMLStreamException,
                                    XMLSecurityException

Create a new SubChain. The XMLEvents will be only be processed from the given OutputProcessor to the end. All earlier OutputProcessors don't get these events. In other words the chain will be splitted in two parts.

Parameters:

outputProcessor - The OutputProcessor position the XMLEvents should be processed over this SubChain.

Returns:

A new OutputProcessorChain

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

createSubChain

OutputProcessorChain createSubChain(OutputProcessor outputProcessor,
                                    XMLSecStartElement parentXMLSecStartElement)
                             throws XMLStreamException,
                                    XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

processEvent

void processEvent(XMLSecEvent xmlSecEvent)
           throws XMLStreamException,
                  XMLSecurityException

Forwards the XMLEvent to the next processor in the chain.

Parameters:

xmlSecEvent - The XMLEvent which should be forwarded to the next processor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs