Package org.apache.axiom.util.stax.xop

Class XOPDecodingStreamReader

java.lang.Object

org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

org.apache.axiom.util.stax.xop.XOPDecodingStreamReader

All Implemented Interfaces:

XMLStreamConstants, XMLStreamReader, org.apache.axiom.ext.stax.datahandler.DataHandlerReader

public class XOPDecodingStreamReader
extends org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper
implements org.apache.axiom.ext.stax.datahandler.DataHandlerReader

XMLStreamReader wrapper that decodes XOP. It uses the extension defined by DataHandlerReader to expose the DataHandler objects referenced by xop:Include elements encountered in the underlying stream. If the consumer uses getText(), getTextCharacters(), getTextCharacters(int, char[], int, int) or getElementText() when an xop:Include element is present in the underlying stream, then the decoder will produce a base64 representation of the data.

Note that this class only implements infoset transformation, but doesn't handle MIME processing. A MimePartProvider implementation must be provided to the constructor of this class. This object will be used to load MIME parts referenced by xop:Include elements encountered in the underlying stream.

This class supports deferred loading of MIME parts: If the consumer uses DataHandlerReader.getDataHandlerProvider(), then the MimePartProvider will only be invoked when DataHandlerProvider.getDataHandler() is called.

Field Summary

Fields inherited from interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

PROPERTY

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

Constructors

Constructor	Description
XOPDecodingStreamReader(XMLStreamReader parent, MimePartProvider mimePartProvider)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getContentID()
DataHandler	getDataHandler()
org.apache.axiom.ext.stax.datahandler.DataHandlerProvider	getDataHandlerProvider()
String	getElementText()
int	getEventType()
String	getLocalName()
Location	getLocation()
QName	getName()
int	getNamespaceCount()
String	getNamespacePrefix(int index)
String	getNamespaceURI()
String	getNamespaceURI(int index)
String	getNamespaceURI(String prefix)
String	getPrefix()
Object	getProperty(String name)
String	getText()
char[]	getTextCharacters()
int	getTextCharacters(int sourceStart, char[] target, int targetStart, int length)
int	getTextLength()
int	getTextStart()
boolean	hasName()
boolean	hasText()
boolean	isBinary()
boolean	isCharacters()
boolean	isDeferred()
boolean	isEndElement()
boolean	isOptimized()
boolean	isStartElement()
boolean	isWhiteSpace()
int	next()
int	nextTag()
void	require(int type, String namespaceURI, String localName)

Methods inherited from class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

close, getAttributeCount, getAttributeLocalName, getAttributeName, getAttributeNamespace, getAttributePrefix, getAttributeType, getAttributeValue, getAttributeValue, getCharacterEncodingScheme, getEncoding, getNamespaceContext, getParent, getPIData, getPITarget, getVersion, hasNext, isAttributeSpecified, isStandalone, standaloneSet

Methods inherited from class java.lang.Object

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

Constructor Detail

XOPDecodingStreamReader

public XOPDecodingStreamReader(XMLStreamReader parent,
                               MimePartProvider mimePartProvider)

Constructor.

Parameters:

parent - the XML stream to decode

mimePartProvider - An implementation of the MimePartProvider interface that will be used to load the DataHandler objects for MIME parts referenced by xop:Include element information items encountered in the underlying stream.

Method Detail

next

public int next()
         throws XMLStreamException

Specified by:

next in interface XMLStreamReader

Overrides:

next in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

Throws:

XMLStreamException

getEventType

public int getEventType()

Specified by:

getEventType in interface XMLStreamReader

Overrides:

getEventType in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

nextTag

public int nextTag()
            throws XMLStreamException

Specified by:

nextTag in interface XMLStreamReader

Overrides:

nextTag in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

Throws:

XMLStreamException

getProperty

public Object getProperty(String name)
                   throws IllegalArgumentException

Specified by:

getProperty in interface XMLStreamReader

Overrides:

getProperty in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

Throws:

IllegalArgumentException

getElementText

public String getElementText()
                      throws XMLStreamException

Specified by:

getElementText in interface XMLStreamReader

Overrides:

getElementText in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

Throws:

XMLStreamException

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface XMLStreamReader

Overrides:

getPrefix in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getNamespaceURI

public String getNamespaceURI()

Specified by:

getNamespaceURI in interface XMLStreamReader

Overrides:

getNamespaceURI in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface XMLStreamReader

Overrides:

getLocalName in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getName

public QName getName()

Specified by:

getName in interface XMLStreamReader

Overrides:

getName in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getLocation

public Location getLocation()

Specified by:

getLocation in interface XMLStreamReader

Overrides:

getLocation in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getNamespaceURI

public String getNamespaceURI(String prefix)

Specified by:

getNamespaceURI in interface XMLStreamReader

Overrides:

getNamespaceURI in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getNamespaceCount

public int getNamespaceCount()

Specified by:

getNamespaceCount in interface XMLStreamReader

Overrides:

getNamespaceCount in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getNamespacePrefix

public String getNamespacePrefix(int index)

Specified by:

getNamespacePrefix in interface XMLStreamReader

Overrides:

getNamespacePrefix in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getNamespaceURI

public String getNamespaceURI(int index)

Specified by:

getNamespaceURI in interface XMLStreamReader

Overrides:

getNamespaceURI in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getText

public String getText()

Specified by:

getText in interface XMLStreamReader

Overrides:

getText in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getTextCharacters

public char[] getTextCharacters()

Specified by:

getTextCharacters in interface XMLStreamReader

Overrides:

getTextCharacters in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getTextCharacters

public int getTextCharacters(int sourceStart,
                             char[] target,
                             int targetStart,
                             int length)
                      throws XMLStreamException

Specified by:

getTextCharacters in interface XMLStreamReader

Overrides:

getTextCharacters in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

Throws:

XMLStreamException

getTextLength

public int getTextLength()

Specified by:

getTextLength in interface XMLStreamReader

Overrides:

getTextLength in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

getTextStart

public int getTextStart()

Specified by:

getTextStart in interface XMLStreamReader

Overrides:

getTextStart in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

hasText

public boolean hasText()

Specified by:

hasText in interface XMLStreamReader

Overrides:

hasText in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

isCharacters

public boolean isCharacters()

Specified by:

isCharacters in interface XMLStreamReader

Overrides:

isCharacters in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

isStartElement

public boolean isStartElement()

Specified by:

isStartElement in interface XMLStreamReader

Overrides:

isStartElement in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

isEndElement

public boolean isEndElement()

Specified by:

isEndElement in interface XMLStreamReader

Overrides:

isEndElement in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

hasName

public boolean hasName()

Specified by:

hasName in interface XMLStreamReader

Overrides:

hasName in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

isWhiteSpace

public boolean isWhiteSpace()

Specified by:

isWhiteSpace in interface XMLStreamReader

Overrides:

isWhiteSpace in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

require

public void require(int type,
                    String namespaceURI,
                    String localName)
             throws XMLStreamException

Specified by:

require in interface XMLStreamReader

Overrides:

require in class org.apache.axiom.util.stax.wrapper.XMLStreamReaderWrapper

Throws:

XMLStreamException

isBinary

public boolean isBinary()

Specified by:

isBinary in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

isOptimized

public boolean isOptimized()

Specified by:

isOptimized in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

isDeferred

public boolean isDeferred()

Specified by:

isDeferred in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

getContentID

public String getContentID()

Specified by:

getContentID in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

getDataHandler

public DataHandler getDataHandler()
                           throws XMLStreamException

Specified by:

getDataHandler in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader

Throws:

XMLStreamException

getDataHandlerProvider

public org.apache.axiom.ext.stax.datahandler.DataHandlerProvider getDataHandlerProvider()

Specified by:

getDataHandlerProvider in interface org.apache.axiom.ext.stax.datahandler.DataHandlerReader