org.apache.axiom.om.impl

Class MTOMXMLStreamWriter

java.lang.Object

org.apache.axiom.om.impl.MTOMXMLStreamWriter

All Implemented Interfaces:

javax.xml.stream.XMLStreamWriter

public class MTOMXMLStreamWriter
extends java.lang.Object
implements javax.xml.stream.XMLStreamWriter

MTOMXMLStreamWriter is an XML + Attachments stream writer. For the moment this assumes that transport takes the decision of whether to optimize or not by looking at whether the MTOM optimize is enabled & also looking at the OM tree whether it has any optimizable content.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MTOMXMLStreamWriter.Part Stores a part that has been added without using the DataHandlerWriter API.

Field Summary

Fields

Modifier and Type	Field and Description
private int	depth
private OMOutputFormat	format
private boolean	isComplete
private boolean	isEndDocument
private static org.apache.commons.logging.Log	log
private OMMultipartWriter	multipartWriter
private OptimizationPolicy	optimizationPolicy
private java.util.List	otherParts
private java.io.OutputStream	outStream
private boolean	preserveAttachments
private java.io.OutputStream	rootPartOutputStream
private XMLStreamWriterFilter	xmlStreamWriterFilter
private javax.xml.stream.XMLStreamWriter	xmlWriter

Constructor Summary

Constructors

Constructor and Description
MTOMXMLStreamWriter(java.io.OutputStream outStream, OMOutputFormat format)
MTOMXMLStreamWriter(java.io.OutputStream outStream, OMOutputFormat format, boolean preserveAttachments) Creates a new MTOMXMLStreamWriter with specified encoding.
MTOMXMLStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush() Flush is overridden to trigger the attachment serialization
java.lang.String	getCharSetEncoding() Returns the character set encoding scheme.
java.lang.String	getContentType()
java.lang.String	getMimeBoundary()
javax.xml.namespace.NamespaceContext	getNamespaceContext()
java.lang.String	getNextContentId()
OMOutputFormat	getOutputFormat() Get the output format used by this writer.
java.io.OutputStream	getOutputStream() Get the underlying OutputStream for this writer, if available.
java.lang.String	getPrefix(java.lang.String string)
java.lang.Object	getProperty(java.lang.String string)
java.lang.String	getRootContentId()
javax.xml.stream.XMLStreamWriter	getXmlStreamWriter()
java.lang.String	getXmlVersion()
boolean	isIgnoreXMLDeclaration()
boolean	isOptimized() Check if MTOM is enabled.
boolean	isOptimizedThreshold(OMText node) Deprecated. Serialization code should use XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) to submit any binary content and let this writer decide whether the content should be written as base64 encoded character data or using xop:Include. If this is not possible, then prepareDataHandler(DataHandler) should be used. All the aforementioned methods take into account the settings defined in OMOutputFormat to determine whether the binary data should be optimized or not. Therefore, there is not need for this method anymore.
java.lang.String	prepareDataHandler(javax.activation.DataHandler dataHandler) Prepare a DataHandler for serialization without using the DataHandlerWriter API.
XMLStreamWriterFilter	removeFilter()
void	setCharSetEncoding(java.lang.String charSetEncoding)
void	setDefaultNamespace(java.lang.String string)
void	setDoOptimize(boolean b)
void	setFilter(XMLStreamWriterFilter filter)
void	setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration)
void	setNamespaceContext(javax.xml.namespace.NamespaceContext namespaceContext)
void	setOutputFormat(OMOutputFormat format)
void	setPrefix(java.lang.String string, java.lang.String string1)
void	setSoap11(boolean b)
void	setXmlStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)
void	setXmlVersion(java.lang.String xmlVersion)
void	writeAttribute(java.lang.String string, java.lang.String string1)
void	writeAttribute(java.lang.String string, java.lang.String string1, java.lang.String string2)
void	writeAttribute(java.lang.String string, java.lang.String string1, java.lang.String string2, java.lang.String string3)
void	writeCData(java.lang.String string)
void	writeCharacters(char[] chars, int i, int i1)
void	writeCharacters(java.lang.String string)
void	writeComment(java.lang.String string)
void	writeDefaultNamespace(java.lang.String string)
void	writeDTD(java.lang.String string)
void	writeEmptyElement(java.lang.String string)
void	writeEmptyElement(java.lang.String string, java.lang.String string1)
void	writeEmptyElement(java.lang.String string, java.lang.String string1, java.lang.String string2)
void	writeEndDocument()
void	writeEndElement()
void	writeEntityRef(java.lang.String string)
void	writeNamespace(java.lang.String string, java.lang.String string1)
void	writeOptimized(OMText node) Deprecated. Serialization code should use XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) to submit any binary content and let this writer decide whether the content should be written as base64 encoded character data or using xop:Include. If this is not possible, then prepareDataHandler(DataHandler) should be used.
void	writeProcessingInstruction(java.lang.String string)
void	writeProcessingInstruction(java.lang.String string, java.lang.String string1)
void	writeStartDocument()
void	writeStartDocument(java.lang.String string)
void	writeStartDocument(java.lang.String string, java.lang.String string1)
void	writeStartElement(java.lang.String string)
void	writeStartElement(java.lang.String string, java.lang.String string1)
void	writeStartElement(java.lang.String string, java.lang.String string1, java.lang.String string2)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final org.apache.commons.logging.Log log

xmlWriter

private javax.xml.stream.XMLStreamWriter xmlWriter

outStream

private java.io.OutputStream outStream

otherParts

private java.util.List otherParts

multipartWriter

private OMMultipartWriter multipartWriter

rootPartOutputStream

private java.io.OutputStream rootPartOutputStream

format

private OMOutputFormat format

optimizationPolicy

private final OptimizationPolicy optimizationPolicy

preserveAttachments

private final boolean preserveAttachments

isEndDocument

private boolean isEndDocument

isComplete

private boolean isComplete

depth

private int depth

xmlStreamWriterFilter

private XMLStreamWriterFilter xmlStreamWriterFilter

Constructor Detail

MTOMXMLStreamWriter

public MTOMXMLStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)

MTOMXMLStreamWriter

public MTOMXMLStreamWriter(java.io.OutputStream outStream,
                           OMOutputFormat format)
                    throws javax.xml.stream.XMLStreamException,
                           javax.xml.stream.FactoryConfigurationError

Throws:

javax.xml.stream.XMLStreamException

javax.xml.stream.FactoryConfigurationError

MTOMXMLStreamWriter

public MTOMXMLStreamWriter(java.io.OutputStream outStream,
                           OMOutputFormat format,
                           boolean preserveAttachments)
                    throws javax.xml.stream.XMLStreamException,
                           javax.xml.stream.FactoryConfigurationError

Creates a new MTOMXMLStreamWriter with specified encoding.

Parameters:

outStream -

format -

preserveAttachments - specifies whether attachments must be preserved or can be consumed (i.e. streamed) during serialization; if set to false then DataHandlerExt.readOnce() or an equivalent method may be used to get the data for an attachment

Throws:

javax.xml.stream.XMLStreamException

javax.xml.stream.FactoryConfigurationError

See Also:

OMOutputFormat.DEFAULT_CHAR_SET_ENCODING

Method Detail

writeStartElement

public void writeStartElement(java.lang.String string)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String string,
                              java.lang.String string1)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartElement

public void writeStartElement(java.lang.String string,
                              java.lang.String string1,
                              java.lang.String string2)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeStartElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String string,
                              java.lang.String string1)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String string,
                              java.lang.String string1,
                              java.lang.String string2)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEmptyElement

public void writeEmptyElement(java.lang.String string)
                       throws javax.xml.stream.XMLStreamException

Specified by:

writeEmptyElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEndElement

public void writeEndElement()
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeEndElement in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws javax.xml.stream.XMLStreamException

Specified by:

writeEndDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

close

public void close()
           throws javax.xml.stream.XMLStreamException

Specified by:

close in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

flush

public void flush()
           throws javax.xml.stream.XMLStreamException

Flush is overridden to trigger the attachment serialization

Specified by:

flush in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String string,
                           java.lang.String string1)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String string,
                           java.lang.String string1,
                           java.lang.String string2,
                           java.lang.String string3)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeAttribute

public void writeAttribute(java.lang.String string,
                           java.lang.String string1,
                           java.lang.String string2)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeAttribute in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeNamespace

public void writeNamespace(java.lang.String string,
                           java.lang.String string1)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeNamespace in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeDefaultNamespace

public void writeDefaultNamespace(java.lang.String string)
                           throws javax.xml.stream.XMLStreamException

Specified by:

writeDefaultNamespace in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeComment

public void writeComment(java.lang.String string)
                  throws javax.xml.stream.XMLStreamException

Specified by:

writeComment in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String string)
                                throws javax.xml.stream.XMLStreamException

Specified by:

writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeProcessingInstruction

public void writeProcessingInstruction(java.lang.String string,
                                       java.lang.String string1)
                                throws javax.xml.stream.XMLStreamException

Specified by:

writeProcessingInstruction in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeCData

public void writeCData(java.lang.String string)
                throws javax.xml.stream.XMLStreamException

Specified by:

writeCData in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeDTD

public void writeDTD(java.lang.String string)
              throws javax.xml.stream.XMLStreamException

Specified by:

writeDTD in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeEntityRef

public void writeEntityRef(java.lang.String string)
                    throws javax.xml.stream.XMLStreamException

Specified by:

writeEntityRef in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument()
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String string)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeStartDocument

public void writeStartDocument(java.lang.String string,
                               java.lang.String string1)
                        throws javax.xml.stream.XMLStreamException

Specified by:

writeStartDocument in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(java.lang.String string)
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

writeCharacters

public void writeCharacters(char[] chars,
                            int i,
                            int i1)
                     throws javax.xml.stream.XMLStreamException

Specified by:

writeCharacters in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

getPrefix

public java.lang.String getPrefix(java.lang.String string)
                           throws javax.xml.stream.XMLStreamException

Specified by:

getPrefix in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

setPrefix

public void setPrefix(java.lang.String string,
                      java.lang.String string1)
               throws javax.xml.stream.XMLStreamException

Specified by:

setPrefix in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

setDefaultNamespace

public void setDefaultNamespace(java.lang.String string)
                         throws javax.xml.stream.XMLStreamException

Specified by:

setDefaultNamespace in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

setNamespaceContext

public void setNamespaceContext(javax.xml.namespace.NamespaceContext namespaceContext)
                         throws javax.xml.stream.XMLStreamException

Specified by:

setNamespaceContext in interface javax.xml.stream.XMLStreamWriter

Throws:

javax.xml.stream.XMLStreamException

getNamespaceContext

public javax.xml.namespace.NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface javax.xml.stream.XMLStreamWriter

getProperty

public java.lang.Object getProperty(java.lang.String string)
                             throws java.lang.IllegalArgumentException

Specified by:

getProperty in interface javax.xml.stream.XMLStreamWriter

Throws:

java.lang.IllegalArgumentException

isOptimized

public boolean isOptimized()

Check if MTOM is enabled.

Note that serialization code should use XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) to submit any binary content and let this writer decide whether the content should be written as base64 encoded character data or using xop:Include. This makes optimization entirely transparent for the caller and there should be no need to check if the writer is producing MTOM. However, in some cases this is not possible, such as when integrating with 3rd party libraries. The serialization code should then use prepareDataHandler(DataHandler) so that it can write xop:Include elements directly to the stream. In that case, the code may use the isOptimized() method check if MTOM is enabled at all.

Returns:

true if MTOM is enabled, false otherwise

getContentType

public java.lang.String getContentType()

writeOptimized

public void writeOptimized(OMText node)

Deprecated. Serialization code should use XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) to submit any binary content and let this writer decide whether the content should be written as base64 encoded character data or using xop:Include. If this is not possible, then prepareDataHandler(DataHandler) should be used.

isOptimizedThreshold

public boolean isOptimizedThreshold(OMText node)

Deprecated. Serialization code should use XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) to submit any binary content and let this writer decide whether the content should be written as base64 encoded character data or using xop:Include. If this is not possible, then prepareDataHandler(DataHandler) should be used. All the aforementioned methods take into account the settings defined in OMOutputFormat to determine whether the binary data should be optimized or not. Therefore, there is not need for this method anymore.

prepareDataHandler

public java.lang.String prepareDataHandler(javax.activation.DataHandler dataHandler)

Prepare a DataHandler for serialization without using the DataHandlerWriter API. The method first determines whether the binary data represented by the DataHandler should be optimized or inlined. If the data should not be optimized, then the method returns null and the caller is expected to use writeCharacters(String) or writeCharacters(char[], int, int) to write the base64 encoded data to the stream. If the data should be optimized, then the method returns a content ID and the caller is expected to generate an xop:Include element referring to that content ID.

This method should only be used to integrate Axiom with third party libraries that support XOP. In all other cases, XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) should be used to write base64Binary values and the application code should never generate xop:Include elements itself.

Parameters:

dataHandler - the DataHandler that the caller intends to write to the stream

Returns:

the content ID that the caller must use in the xop:Include element or null if the base64 encoded data should not be optimized

setXmlStreamWriter

public void setXmlStreamWriter(javax.xml.stream.XMLStreamWriter xmlWriter)

getXmlStreamWriter

public javax.xml.stream.XMLStreamWriter getXmlStreamWriter()

getMimeBoundary

public java.lang.String getMimeBoundary()

getRootContentId

public java.lang.String getRootContentId()

getNextContentId

public java.lang.String getNextContentId()

getCharSetEncoding

public java.lang.String getCharSetEncoding()

Returns the character set encoding scheme. If the value of the charSetEncoding is not set then the default will be returned.

Returns:

Returns encoding.

setCharSetEncoding

public void setCharSetEncoding(java.lang.String charSetEncoding)

getXmlVersion

public java.lang.String getXmlVersion()

setXmlVersion

public void setXmlVersion(java.lang.String xmlVersion)

setSoap11

public void setSoap11(boolean b)

isIgnoreXMLDeclaration

public boolean isIgnoreXMLDeclaration()

setIgnoreXMLDeclaration

public void setIgnoreXMLDeclaration(boolean ignoreXMLDeclaration)

setDoOptimize

public void setDoOptimize(boolean b)

getOutputFormat

public OMOutputFormat getOutputFormat()

Get the output format used by this writer.

The caller should use the returned instance in a read-only way, i.e. he should not modify the settings of the output format. Any attempt to do so will lead to unpredictable results.

Returns:

the output format used by this writer

setOutputFormat

public void setOutputFormat(OMOutputFormat format)

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws javax.xml.stream.XMLStreamException

Get the underlying OutputStream for this writer, if available. This method allows a node (perhaps an OMSourcedElement) to write its content directly to the byte stream.

WARNING: This method should be used with extreme care. The caller must be prepared to handle the following issues:

• The caller must use the right charset encoding when writing to the stream.
• The caller should avoid writing byte order marks to the stream.
• The caller must be aware of the fact that a default namespace might have been set in the context where the byte stream is requested. If the XML data written to the stream contains unqualified elements, then the caller must make sure that the default namespace is redeclared as appropriate.

Returns:

the underlying byte stream, or null if the stream is not accessible

Throws:

javax.xml.stream.XMLStreamException

setFilter

public void setFilter(XMLStreamWriterFilter filter)

removeFilter

public XMLStreamWriterFilter removeFilter()