Class MTOMXMLStreamWriter
- java.lang.Object
-
- org.apache.axiom.om.impl.MTOMXMLStreamWriter
-
- All Implemented Interfaces:
XMLStreamWriter
public abstract class MTOMXMLStreamWriter extends Object implements 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 and also looking at the OM tree whether it has any optimizable content.
-
-
Constructor Summary
Constructors Constructor Description MTOMXMLStreamWriter()
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract StringgetCharSetEncoding()Returns the character set encoding scheme.abstract OMOutputFormatgetOutputFormat()Get the output format used by this writer.abstract OutputStreamgetOutputStream()Get the underlyingOutputStreamfor this writer, if available.abstract booleanisOptimized()Check if MTOM is enabled.abstract StringprepareDataHandler(DataHandler dataHandler)Prepare aDataHandlerfor serialization without using theDataHandlerWriterAPI.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface javax.xml.stream.XMLStreamWriter
close, flush, getNamespaceContext, getPrefix, getProperty, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeCData, writeCharacters, writeCharacters, writeComment, writeDefaultNamespace, writeDTD, writeEmptyElement, writeEmptyElement, writeEmptyElement, writeEndDocument, writeEndElement, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeStartDocument, writeStartDocument, writeStartDocument, writeStartElement, writeStartElement, writeStartElement
-
-
-
-
Method Detail
-
isOptimized
public abstract boolean isOptimized()
Check if MTOM is enabled.Note that serialization code should use
XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean)orXMLStreamWriterUtils.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 usingxop: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 useprepareDataHandler(DataHandler)so that it can writexop:Includeelements directly to the stream. In that case, the code may use theisOptimized()method check if MTOM is enabled at all.- Returns:
trueif MTOM is enabled,falseotherwise
-
prepareDataHandler
public abstract String prepareDataHandler(DataHandler dataHandler)
Prepare aDataHandlerfor serialization without using theDataHandlerWriterAPI. The method first determines whether the binary data represented by theDataHandlershould be optimized or inlined. If the data should not be optimized, then the method returnsnulland the caller is expected to useXMLStreamWriter.writeCharacters(String)orXMLStreamWriter.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 anxop:Includeelement 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)orXMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean)should be used to write base64Binary values and the application code should never generatexop:Includeelements itself.- Parameters:
dataHandler- theDataHandlerthat the caller intends to write to the stream- Returns:
- the content ID that the caller must use in the
xop:Includeelement ornullif the base64 encoded data should not be optimized
-
getCharSetEncoding
public abstract 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.
-
getOutputFormat
public abstract 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
-
getOutputStream
public abstract OutputStream getOutputStream() throws XMLStreamException
Get the underlyingOutputStreamfor this writer, if available. This method allows a node (perhaps anOMSourcedElement) 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
nullif the stream is not accessible - Throws:
XMLStreamException
-
-