OMDataSource
implementations. Instead, use AbstractOMDataSource,
AbstractPullOMDataSource or AbstractPushOMDataSource.public abstract class OMDataSourceExtBase extends Object implements OMDataSourceExt
LOSSY_PREFIX| Constructor and Description |
|---|
OMDataSourceExtBase()
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
getProperty(String key)
Deprecated.
Query a property stored on the OMDataSource
|
InputStream |
getXMLInputStream(String encoding)
Deprecated.
Returns a InputStream representing the xml data
|
boolean |
hasProperty(String key)
Deprecated.
Returns true if property is set
|
void |
serialize(OutputStream output,
OMOutputFormat format)
Deprecated.
Serializes element data directly to stream.
|
void |
serialize(Writer writer,
OMOutputFormat format)
Deprecated.
Serializes element data directly to writer.
|
void |
serialize(javax.xml.stream.XMLStreamWriter xmlWriter)
Deprecated.
Serializes element data directly to StAX writer.
|
Object |
setProperty(String key,
Object value)
Deprecated.
Set a property on the OMDataSource
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclose, copy, getObject, getXMLBytes, isDestructiveRead, isDestructiveWritegetReaderpublic Object getProperty(String key)
OMDataSourceExtgetProperty in interface OMDataSourceExtpublic Object setProperty(String key, Object value)
OMDataSourceExtsetProperty in interface OMDataSourceExtpublic boolean hasProperty(String key)
OMDataSourceExthasProperty in interface OMDataSourceExtpublic InputStream getXMLInputStream(String encoding) throws UnsupportedEncodingException
OMDataSourceExtgetXMLInputStream in interface OMDataSourceExtencoding - String encoding of InputStreamUnsupportedEncodingExceptionpublic void serialize(OutputStream output, OMOutputFormat format) throws javax.xml.stream.XMLStreamException
OMDataSource
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.
serialize in interface OMDataSourceoutput - destination stream for element XML textformat - 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.javax.xml.stream.XMLStreamExceptionpublic void serialize(Writer writer, OMOutputFormat format) throws javax.xml.stream.XMLStreamException
OMDataSource
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.
serialize in interface OMDataSourcewriter - destination writer for element XML textformat - output format information (null if none; may be ignored if not
supported by data binding even if supplied)javax.xml.stream.XMLStreamExceptionpublic void serialize(javax.xml.stream.XMLStreamWriter xmlWriter) throws javax.xml.stream.XMLStreamException
OMDataSourceThe implementation of this method must satisfy the following requirements:
XMLStreamWriter.writeStartDocument(),
XMLStreamWriter.writeStartDocument(String),
XMLStreamWriter.writeStartDocument(String, String) or
XMLStreamWriter.writeEndElement().
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.
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).
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.
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).
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:
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.
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:
OMSerializable.serialize(XMLStreamWriter, boolean) method.
OMDataSource is push-only (see AbstractPushOMDataSource), then it
enables OMSourcedElement to create OMText nodes for the binary content in an
efficient way.
XMLStreamWriter.writeCharacters(String) or
XMLStreamWriter.writeCharacters(char[], int, int) to write the base64 encoded data to
the stream.
XMLStreamWriter.close().
On the other hand, the caller of this method (typically an OMSourcedElement instance)
must ensure that the following requirements are satisfied:
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.
serialize in interface OMDataSourcexmlWriter - destination writerjavax.xml.stream.XMLStreamExceptionCopyright ? The Apache Software Foundation. All Rights Reserved.