org.apache.axiom.om

Interface OMDataSource

All Known Subinterfaces:

OMDataSourceExt, QNameAwareOMDataSource

All Known Implementing Classes:

AbstractOMDataSource, AbstractPullOMDataSource, AbstractPushOMDataSource, ByteArrayDataSource, CharArrayDataSource, InputStreamDataSource, JAXBOMDataSource, OMDataSourceExtBase, ParserInputStreamDataSource, PushOMDataSource, TestDataSource, TestSerializeAndConsumeWithOMSEInBody.DummySource, WrappedTextNodeOMDataSource, WrappedTextNodeOMDataSourceFromDataSource, WrappedTextNodeOMDataSourceFromReader

public interface OMDataSource

Interface to arbitrary source of XML element data. This provides the hook for using a general data source (such as data binding frameworks) as the backing source of data for an element.

Method Summary

Modifier and Type	Method and Description
javax.xml.stream.XMLStreamReader	getReader() Get parser for element data.
void	serialize(java.io.OutputStream output, OMOutputFormat format) Serializes element data directly to stream.
void	serialize(java.io.Writer writer, OMOutputFormat format) Serializes element data directly to writer.
void	serialize(javax.xml.stream.XMLStreamWriter xmlWriter) Serializes element data directly to StAX writer.

Method Detail

serialize

void serialize(java.io.OutputStream output,
               OMOutputFormat format)
        throws javax.xml.stream.XMLStreamException

Serializes element data directly to stream.

It is assumed that this method consumes the content (i.e. destroys the backing object) unless the data source also implements OMDataSourceExt and OMDataSourceExt.isDestructiveWrite() returns false.

Parameters:

output - destination stream for element XML text

format - Output format information. The implementation must use this information to choose the correct character set encoding when writing to the output stream. This parameter must not be null.

Throws:

javax.xml.stream.XMLStreamException

serialize

void serialize(java.io.Writer writer,
               OMOutputFormat format)
        throws javax.xml.stream.XMLStreamException

Serializes element data directly to writer.

It is assumed that this method consumes the content (i.e. destroys the backing object) unless the data source also implements OMDataSourceExt and OMDataSourceExt.isDestructiveWrite() returns false.

Parameters:

writer - destination writer for element XML text

format - output format information (null if none; may be ignored if not supported by data binding even if supplied)

Throws:

javax.xml.stream.XMLStreamException

serialize

void serialize(javax.xml.stream.XMLStreamWriter xmlWriter)
        throws javax.xml.stream.XMLStreamException

Serializes element data directly to StAX writer.

The implementation of this method must satisfy the following requirements:

• The implementation MUST NOT not write any start document or end document event, i.e. it MUST NOT use XMLStreamWriter.writeStartDocument(), XMLStreamWriter.writeStartDocument(String), XMLStreamWriter.writeStartDocument(String, String) or XMLStreamWriter.writeEndElement().
• The implementation MUST output a single element (hereafter called the root element). It MUST NOT output any other content before or after that element.
• The implementation MUST specify the namespace URI when writing an element, i.e. it MUST NOT use the namespace unaware methods XMLStreamWriter.writeStartElement(String) or XMLStreamWriter.writeEmptyElement(String). On the other hand, it MAY use the namespace unaware XMLStreamWriter.writeAttribute(String, String) method, provided that the specified name is an NCName.
• The implementation MUST ensure that the produced XML is well formed with respect to namespaces, i.e. it MUST generate the required namespace declarations using XMLStreamWriter.writeNamespace(String, String) and XMLStreamWriter.writeDefaultNamespace(String). It MUST NOT assume that the XMLStreamWriter performs any kind of namespace repairing (although that may be the case).
• In addition the implementation MAY use XMLStreamWriter.setPrefix(String, String) and XMLStreamWriter.setDefaultNamespace(String) to track the namespace declarations it generates, so that the namespace context maintained by the XMLStreamWriter accurately reflects the namespace context in the output document. However, it MUST NOT call these methods before the start of the root element or after the end of the root element.
• Since the element may be serialized as part of a larger document, the implementation MUST take into account the pre-existing namespace context (which can be queried using XMLStreamWriter.getPrefix(String) and XMLStreamWriter.getNamespaceContext()). This means that the implementation MUST NOT assume that the empty prefix is bound to the empty namespace URI. Therefore if the implementation outputs elements that have no namespace, it MUST generate namespace declarations of the form xmlns="" in the appropriate locations. In addition it MAY use the namespace context information to minimize the number of generated namespace declarations (by reusing already bound prefixes).
• If the implementation produces base64 binary data (that could be optimized using XOP/MTOM), then it SHOULD use XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandler, String, boolean) or XMLStreamWriterUtils.writeDataHandler(XMLStreamWriter, DataHandlerProvider, String, boolean) to write the data to the stream. If this is not possible (e.g. because the content is produced by a third party library that is not aware of these APIs), then the implementation MUST use the following approach:
  • If the XMLStreamWriter is an MTOMXMLStreamWriter, then the implementation MAY use MTOMXMLStreamWriter.prepareDataHandler(DataHandler) and generate the necessary xop:Include elements itself. In this case, the implementation MAY use MTOMXMLStreamWriter.isOptimized() to check if XOP/MTOM is enabled at all. Alternatively, instead of handling MTOMXMLStreamWriter in a special way, the implementation MAY use the approach described in the next item. This works because MTOMXMLStreamWriter exposes the DataHandlerWriter extension. However, this causes a slight overhead because the stream is first XOP decoded and then reencoded again.
  • If the XMLStreamWriter exposes the DataHandlerWriter extension, but is not an MTOMXMLStreamWriter (or is an MTOMXMLStreamWriter, but the implementation doesn't implement the approach described in the previous item), then the implementation MUST wrap the XMLStreamWriter in an XOPDecodingStreamWriter and write xop:Include elements to that wrapper, so that they can be translated into appropriate calls to the DataHandlerWriter. This requirement is important for two reasons:
    • It allows Axiom to respect the contract of the OMSerializable.serialize(XMLStreamWriter, boolean) method.
    • If the OMDataSource is push-only (see AbstractPushOMDataSource), then it enables OMSourcedElement to create OMText nodes for the binary content in an efficient way.
  • In all other cases, the implementation MUST use XMLStreamWriter.writeCharacters(String) or XMLStreamWriter.writeCharacters(char[], int, int) to write the base64 encoded data to the stream.

On the other hand, the caller of this method (typically an OMSourcedElement instance) must ensure that the following requirements are satisfied:

• The namespace context information provided by XMLStreamWriter.getPrefix(String) and XMLStreamWriter.getNamespaceContext() MUST accurately reflect the actual namespace context at the location in the output document where the root element is serialized. Note that this requirement may be relaxed if the caller implements some form of namespace repairing.

It is assumed that this method consumes the content (i.e. destroys the backing object) unless the data source also implements OMDataSourceExt and OMDataSourceExt.isDestructiveWrite() returns false.

Parameters:

xmlWriter - destination writer

Throws:

javax.xml.stream.XMLStreamException

getReader

javax.xml.stream.XMLStreamReader getReader()
                                    throws javax.xml.stream.XMLStreamException

Get parser for element data. In the general case this may require the data source to serialize data as XML text and then parse that text.

It is assumed that this method consumed the content (i.e. destroys the backing object) unless the data source also implements OMDataSourceExt and OMDataSourceExt.isDestructiveRead() returns false.

Returns:

element parser

Throws:

javax.xml.stream.XMLStreamException