Class AbstractDecryptInputProcessor

java.lang.Object

org.apache.xml.security.stax.ext.AbstractInputProcessor

org.apache.xml.security.stax.impl.processor.input.AbstractDecryptInputProcessor

All Implemented Interfaces:

InputProcessor

Direct Known Subclasses:

XMLDecryptInputProcessor

public abstract class AbstractDecryptInputProcessor
extends AbstractInputProcessor

Processor for decryption of EncryptedData XML structures

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractDecryptInputProcessor.AbstractDecryptedEventReaderInputProcessor	The DecryptedEventReaderInputProcessor reads the decrypted stream with a StAX reader and forwards the generated XMLEvents

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Integer	maximumAllowedEncryptedDataEvents
protected static final Integer	maximumAllowedXMLStructureDepth

Constructor Summary

Constructors

Constructor	Description
AbstractDecryptInputProcessor(KeyInfoType keyInfoType, ReferenceList referenceList, XMLSecurityProperties securityProperties)
AbstractDecryptInputProcessor(XMLSecurityProperties securityProperties)

Method Summary

Modifier and Type	Method	Description
protected InputStream	applyTransforms(ReferenceType referenceType, InputStream inputStream)
void	doFinal(InputProcessorChain inputProcessorChain)	Will be called when the whole document is processed.
List<ReferenceType>	getProcessedReferences()
Map<String, ReferenceType>	getReferences()
protected abstract void	handleCipherReference(InputProcessorChain inputProcessorChain, EncryptedDataType encryptedDataType, Cipher cipher, InboundSecurityToken inboundSecurityToken)
protected abstract void	handleEncryptedContent(InputProcessorChain inputProcessorChain, XMLSecStartElement parentXMLSecStartElement, InboundSecurityToken inboundSecurityToken, EncryptedDataType encryptedDataType)
protected abstract void	handleSecurityToken(InboundSecurityToken inboundSecurityToken, InboundSecurityContext inboundSecurityContext, EncryptedDataType encryptedDataType)
protected abstract InputStream	handleXOPInclude(InputProcessorChain inputProcessorChain, EncryptedDataType encryptedDataType, String href, Cipher cipher, InboundSecurityToken inboundSecurityToken)
protected ReferenceType	matchesReferenceId(XMLSecStartElement xmlSecStartElement)
protected abstract AbstractDecryptInputProcessor.AbstractDecryptedEventReaderInputProcessor	newDecryptedEventReaderInputProcessor(boolean encryptedHeader, XMLSecStartElement xmlSecStartElement, EncryptedDataType currentEncryptedDataType, InboundSecurityToken inboundSecurityToken, InboundSecurityContext inboundSecurityContext)
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 AbstractInputProcessor

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

Methods inherited from class Object

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

Field Details

maximumAllowedXMLStructureDepth

protected static final Integer maximumAllowedXMLStructureDepth

maximumAllowedEncryptedDataEvents

protected static final Integer maximumAllowedEncryptedDataEvents

Constructor Details

AbstractDecryptInputProcessor

public AbstractDecryptInputProcessor(XMLSecurityProperties securityProperties)
                              throws XMLSecurityException

Throws:

XMLSecurityException

AbstractDecryptInputProcessor

public AbstractDecryptInputProcessor(KeyInfoType keyInfoType,
 ReferenceList referenceList,
 XMLSecurityProperties securityProperties)
                              throws XMLSecurityException

Throws:

XMLSecurityException

Method Details

getReferences

public Map<String, ReferenceType> getReferences()

getProcessedReferences

public List<ReferenceType> getProcessedReferences()

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

Parameters:

inputProcessorChain -

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

Parameters:

inputProcessorChain -

Returns:

The next XMLSecEvent

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs

applyTransforms

protected InputStream applyTransforms(ReferenceType referenceType,
 InputStream inputStream)
                               throws XMLSecurityException

Throws:

XMLSecurityException

newDecryptedEventReaderInputProcessor

protected abstract AbstractDecryptInputProcessor.AbstractDecryptedEventReaderInputProcessor newDecryptedEventReaderInputProcessor(boolean encryptedHeader,
 XMLSecStartElement xmlSecStartElement,
 EncryptedDataType currentEncryptedDataType,
 InboundSecurityToken inboundSecurityToken,
 InboundSecurityContext inboundSecurityContext)
                                                                                                                           throws XMLSecurityException

Throws:

XMLSecurityException

handleSecurityToken

protected abstract void handleSecurityToken(InboundSecurityToken inboundSecurityToken,
 InboundSecurityContext inboundSecurityContext,
 EncryptedDataType encryptedDataType)
                                     throws XMLSecurityException

Throws:

XMLSecurityException

handleEncryptedContent

protected abstract void handleEncryptedContent(InputProcessorChain inputProcessorChain,
 XMLSecStartElement parentXMLSecStartElement,
 InboundSecurityToken inboundSecurityToken,
 EncryptedDataType encryptedDataType)
                                        throws XMLSecurityException

Throws:

XMLSecurityException

handleCipherReference

protected abstract void handleCipherReference(InputProcessorChain inputProcessorChain,
 EncryptedDataType encryptedDataType,
 Cipher cipher,
 InboundSecurityToken inboundSecurityToken)
                                       throws XMLSecurityException

Throws:

XMLSecurityException

handleXOPInclude

protected abstract InputStream handleXOPInclude(InputProcessorChain inputProcessorChain,
 EncryptedDataType encryptedDataType,
 String href,
 Cipher cipher,
 InboundSecurityToken inboundSecurityToken)
                                         throws XMLSecurityException

Throws:

XMLSecurityException

matchesReferenceId

protected ReferenceType matchesReferenceId(XMLSecStartElement xmlSecStartElement)

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

Parameters:

inputProcessorChain -

Throws:

XMLStreamException - thrown when a streaming error occurs

XMLSecurityException - thrown when a Security failure occurs