org.apache.xml.security.stax.ext

Class AbstractOutputProcessor

java.lang.Object

org.apache.xml.security.stax.ext.AbstractOutputProcessor

All Implemented Interfaces:

OutputProcessor

Direct Known Subclasses:

AbstractBufferingOutputProcessor, AbstractEncryptOutputProcessor, AbstractEncryptOutputProcessor.AbstractInternalEncryptionOutputProcessor, AbstractSignatureEndingOutputProcessor.SignedInfoProcessor, AbstractSignatureOutputProcessor, AbstractSignatureOutputProcessor.InternalSignatureOutputProcessor, FinalOutputProcessor

public abstract class AbstractOutputProcessor
extends Object
implements OutputProcessor

An abstract OutputProcessor class for reusabilty

Field Summary

Fields

Modifier and Type	Field and Description
protected XMLSecurityConstants.Action	action
protected int	actionOrder
protected XMLSecurityProperties	securityProperties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractOutputProcessor()

Method Summary

Modifier and Type	Method and Description
void	addAfterProcessor(Class<? extends OutputProcessor> processor) Add this processor after the given processor
XMLSecStartElement	addAttributes(XMLSecStartElement xmlSecStartElement, List<XMLSecAttribute> attributeList)
void	addBeforeProcessor(Class<? extends OutputProcessor> processor) Add this processor before the given processor
XMLSecAttribute	createAttribute(QName attribute, String attributeValue)
XMLSecCharacters	createCharacters(char[] text)
XMLSecCharacters	createCharacters(String characters)
void	createCharactersAndOutputAsEvent(OutputProcessorChain outputProcessorChain, char[] text)
void	createCharactersAndOutputAsEvent(OutputProcessorChain outputProcessorChain, String characters)
XMLSecEndElement	createEndElement(QName element)
void	createEndElementAndOutputAsEvent(OutputProcessorChain outputProcessorChain, QName element)
XMLSecNamespace	createNamespace(String prefix, String uri)
XMLSecStartElement	createStartElementAndOutputAsEvent(OutputProcessorChain outputProcessorChain, QName element, boolean outputLocalNs, List<XMLSecAttribute> attributes)
void	createStartElementAndOutputAsEvent(OutputProcessorChain outputProcessorChain, QName element, List<XMLSecNamespace> namespaces, List<XMLSecAttribute> attributes)
void	doFinal(OutputProcessorChain outputProcessorChain) Will be called when the whole document is processed.
XMLSecurityConstants.Action	getAction()
int	getActionOrder()
Set<Class<? extends OutputProcessor>>	getAfterProcessors() This OutputProcessor will be added after the processors in this set
Set<Class<? extends OutputProcessor>>	getBeforeProcessors() This OutputProcessor will be added before the processors in this set
XMLSecurityConstants.Phase	getPhase() The Phase in which this OutputProcessor should be applied
XMLSecurityProperties	getSecurityProperties()
void	init(OutputProcessorChain outputProcessorChain) Method will be called after setting the properties
protected void	outputAsEvent(OutputProcessorChain outputProcessorChain, XMLSecEvent xmlSecEvent)
protected void	outputDOMElement(Element element, OutputProcessorChain outputProcessorChain)
protected SecurePart	securePartMatches(XMLSecStartElement xmlSecStartElement, Map<Object,SecurePart> secureParts)
protected SecurePart	securePartMatches(XMLSecStartElement xmlSecStartElement, OutputProcessorChain outputProcessorChain, String dynamicParts)
void	setAction(XMLSecurityConstants.Action action, int actionOrder) setter for the Action after instantiation of the processor
void	setPhase(XMLSecurityConstants.Phase phase)
void	setXMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties) setter for the XMLSecurityProperties after instantiation of the processor

Methods inherited from class java.lang.Object

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

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

processEvent

Field Detail

securityProperties

protected XMLSecurityProperties securityProperties

action

protected XMLSecurityConstants.Action action

actionOrder

protected int actionOrder

Constructor Detail

AbstractOutputProcessor

protected AbstractOutputProcessor()
                           throws XMLSecurityException

Throws:

XMLSecurityException

Method Detail

setXMLSecurityProperties

public void setXMLSecurityProperties(XMLSecurityProperties xmlSecurityProperties)

Description copied from interface: OutputProcessor

setter for the XMLSecurityProperties after instantiation of the processor

Specified by:

setXMLSecurityProperties in interface OutputProcessor

setAction

public void setAction(XMLSecurityConstants.Action action,
                      int actionOrder)

Description copied from interface: OutputProcessor

setter for the Action after instantiation of the processor

Specified by:

setAction in interface OutputProcessor

Parameters:

action - The action this processor belongs to, possibly null for no particular action.

actionOrder - The action order of this processor, possibly -1 for no particular action order.

init

public void init(OutputProcessorChain outputProcessorChain)
          throws XMLSecurityException

Description copied from interface: OutputProcessor

Method will be called after setting the properties

Specified by:

init in interface OutputProcessor

Throws:

XMLSecurityException

getPhase

public XMLSecurityConstants.Phase getPhase()

Description copied from interface: OutputProcessor

The Phase in which this OutputProcessor should be applied

Specified by:

getPhase in interface OutputProcessor

Returns:

The Phase

setPhase

public void setPhase(XMLSecurityConstants.Phase phase)

addBeforeProcessor

public void addBeforeProcessor(Class<? extends OutputProcessor> processor)

Description copied from interface: OutputProcessor

Add this processor before the given processor

Specified by:

addBeforeProcessor in interface OutputProcessor

getBeforeProcessors

public Set<Class<? extends OutputProcessor>> getBeforeProcessors()

Description copied from interface: OutputProcessor

This OutputProcessor will be added before the processors in this set

Specified by:

getBeforeProcessors in interface OutputProcessor

Returns:

The set with the named OutputProcessor

addAfterProcessor

public void addAfterProcessor(Class<? extends OutputProcessor> processor)

Description copied from interface: OutputProcessor

Add this processor after the given processor

Specified by:

addAfterProcessor in interface OutputProcessor

getAfterProcessors

public Set<Class<? extends OutputProcessor>> getAfterProcessors()

Description copied from interface: OutputProcessor

This OutputProcessor will be added after the processors in this set

Specified by:

getAfterProcessors in interface OutputProcessor

Returns:

The set with the named OutputProcessor

getSecurityProperties

public XMLSecurityProperties getSecurityProperties()

getAction

public XMLSecurityConstants.Action getAction()

Specified by:

getAction in interface OutputProcessor

Returns:

The action to which this processor belongs, if any, else null.

getActionOrder

public int getActionOrder()

Specified by:

getActionOrder in interface OutputProcessor

Returns:

The action order of this processor, or -1.

doFinal

public void doFinal(OutputProcessorChain outputProcessorChain)
             throws XMLStreamException,
                    XMLSecurityException

Description copied from interface: OutputProcessor

Will be called when the whole document is processed.

Specified by:

doFinal in interface OutputProcessor

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

addAttributes

public XMLSecStartElement addAttributes(XMLSecStartElement xmlSecStartElement,
                                        List<XMLSecAttribute> attributeList)
                                 throws XMLStreamException

Throws:

XMLStreamException

createStartElementAndOutputAsEvent

public void createStartElementAndOutputAsEvent(OutputProcessorChain outputProcessorChain,
                                               QName element,
                                               List<XMLSecNamespace> namespaces,
                                               List<XMLSecAttribute> attributes)
                                        throws XMLStreamException,
                                               XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

createStartElementAndOutputAsEvent

public XMLSecStartElement createStartElementAndOutputAsEvent(OutputProcessorChain outputProcessorChain,
                                                             QName element,
                                                             boolean outputLocalNs,
                                                             List<XMLSecAttribute> attributes)
                                                      throws XMLStreamException,
                                                             XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

createEndElement

public XMLSecEndElement createEndElement(QName element)

createEndElementAndOutputAsEvent

public void createEndElementAndOutputAsEvent(OutputProcessorChain outputProcessorChain,
                                             QName element)
                                      throws XMLStreamException,
                                             XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

createCharactersAndOutputAsEvent

public void createCharactersAndOutputAsEvent(OutputProcessorChain outputProcessorChain,
                                             String characters)
                                      throws XMLStreamException,
                                             XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

createCharactersAndOutputAsEvent

public void createCharactersAndOutputAsEvent(OutputProcessorChain outputProcessorChain,
                                             char[] text)
                                      throws XMLStreamException,
                                             XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

createCharacters

public XMLSecCharacters createCharacters(String characters)

createCharacters

public XMLSecCharacters createCharacters(char[] text)

createAttribute

public XMLSecAttribute createAttribute(QName attribute,
                                       String attributeValue)

createNamespace

public XMLSecNamespace createNamespace(String prefix,
                                       String uri)

outputAsEvent

protected void outputAsEvent(OutputProcessorChain outputProcessorChain,
                             XMLSecEvent xmlSecEvent)
                      throws XMLStreamException,
                             XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException

securePartMatches

protected SecurePart securePartMatches(XMLSecStartElement xmlSecStartElement,
                                       OutputProcessorChain outputProcessorChain,
                                       String dynamicParts)

securePartMatches

protected SecurePart securePartMatches(XMLSecStartElement xmlSecStartElement,
                                       Map<Object,SecurePart> secureParts)

outputDOMElement

protected void outputDOMElement(Element element,
                                OutputProcessorChain outputProcessorChain)
                         throws XMLStreamException,
                                XMLSecurityException

Throws:

XMLStreamException

XMLSecurityException