Deprecated List (Axiom Compatibility Classes API)

Deprecated Interfaces
Interface and Description
org.apache.axiom.util.blob.Blob Use `org.apache.axiom.blob.Blob` instead.
org.apache.axiom.attachments.SizeAwareDataSource Please implement `SizeAwareDataSource`
org.apache.axiom.util.blob.WritableBlob Use `WritableBlob` instead.

Deprecated Classes
Class and Description
org.apache.axiom.om.impl.llom.util.AXIOMUtil Use `AXIOMUtil` instead.
org.apache.axiom.om.util.Base64 Use `Base64Utils` instead.
org.apache.axiom.util.blob.BlobDataSource Use `org.apache.axiom.blob.BlobDataSource` instead.
org.apache.axiom.util.blob.BlobOutputStream
org.apache.axiom.attachments.utils.ByteSearch This class was part of the MIME parser in Axiom versions before 1.2.13 and is no longer used. It will be removed in Axiom 1.3. Please note that the code in this class is known to have issues; see AXIOM-449 and AXIOM-450 for more information.
org.apache.axiom.om.impl.builder.DataHandlerReaderUtils Use the corresponding methods in `XMLStreamReaderUtils` instead.
org.apache.axiom.attachments.utils.DataHandlerUtils
org.apache.axiom.om.impl.dom.jaxp.DocumentBuilderFactoryImpl This class has static methods that allow to switch between DOOM and the default DOM implementation as returned by JAXP. This was a hack introduced for Rampart. Recent versions of Rampart no longer rely on this hack. On the other hand usage of `DocumentBuilderFactoryImpl.setDOOMRequired(boolean)` in a concurrent environment can lead to unexpected behavior and severe bugs, as shown in AXIOM-3 and AXIS2-1570. Due to the way `DocumentBuilderFactoryImpl.newDocumentBuilder()` is implemented, it is not possible to get rid of the setDOOMRequired hack without the risk of breaking existing code. Application code should always use `DOMMetaFactory.newDocumentBuilderFactory()` to get an Axiom compatible `DocumentBuilderFactory` and should not attempt to override the JVM's default `DocumentBuilderFactory` with an Axiom compatible version.
org.apache.axiom.om.impl.dom.jaxp.DocumentBuilderImpl See `DocumentBuilderFactoryImpl` for the reason why this class is deprecated.
org.apache.axiom.om.impl.dom.DOOMAbstractFactory Use `OMAbstractFactory.getMetaFactory(String)` with `OMAbstractFactory.FEATURE_DOM` to get a meta factory for DOOM.
org.apache.axiom.om.impl.EmptyOMLocation Use `DummyLocation.INSTANCE` instead.
org.apache.axiom.attachments.utils.IOUtils This class is no longer used and will be removed in Axiom 1.3. You may want to use Commons IO instead.
org.apache.axiom.mime.impl.javamail.JavaMailMultipartWriterFactory The original purpose of this class was to provide an alternative implementation should bugs be discovered in `AxiomMultipartWriterFactory`. However, `AxiomMultipartWriterFactory` exists for several releases now and has no known issues. It should therefore always be used as `MultipartWriterFactory` implementation.
org.apache.axiom.util.blob.MemoryBlob Use `org.apache.axiom.blob.MemoryBlob` instead.
org.apache.axiom.om.impl.MIMEOutputUtils The features of this class are now implemented by `OMMultipartWriter`, which has as cleaner API and supports streaming of individual MIME parts, in particular the SOAP part.
org.apache.axiom.om.impl.llom.util.NamespaceContextImpl Use `MapBasedNamespaceContext` instead.
org.apache.axiom.om.impl.traverse.OMChildElementIterator This type of iterator should always be created using `OMElement.getChildElements()`, and this class should never be referenced directly. It will be removed in Axiom 1.3.
org.apache.axiom.om.impl.traverse.OMChildrenLegacyQNameIterator
org.apache.axiom.om.impl.traverse.OMChildrenLocalNameIterator This type of iterator should always be created using `OMContainer.getChildrenWithLocalName(String)`, and this class should never be referenced directly. It will be removed in Axiom 1.3.
org.apache.axiom.om.impl.traverse.OMChildrenNamespaceIterator This type of iterator should always be created using `OMContainer.getChildrenWithNamespaceURI(String)`, and this class should never be referenced directly. It will be removed in Axiom 1.3.
org.apache.axiom.om.impl.traverse.OMChildrenQNameIterator This type of iterator should always be created using `OMContainer.getChildrenWithName(QName)`, and this class should never be referenced directly. It will be removed in Axiom 1.3.
org.apache.axiom.om.impl.traverse.OMDescendantsIterator This type of iterator should always be created using `OMContainer.getDescendants(boolean)`, and this class should never be referenced directly. It will be removed in Axiom 1.3.
org.apache.axiom.om.impl.OMNamespaceImpl `OMNamespace` instances should always be created using `OMFactory.createOMNamespace(String, String)`. This class will be removed in Axiom 1.3.
org.apache.axiom.om.impl.jaxp.OMResult In order to create a `SAXResult` that builds an Axiom tree, create an `OMDocument` instance and call `OMContainer.getSAXResult()` on it.
org.apache.axiom.om.impl.jaxp.OMSource As of version 1.2.13, application code should use `OMContainer.getSAXSource(boolean)` instead of this class.
org.apache.axiom.om.impl.llom.factory.OMXMLBuilderFactory This class is deprecated because it is located in the wrong package and JAR (it is implementation independent but belongs to LLOM). Please use `OMXMLBuilderFactory` instead.
org.apache.axiom.om.impl.serialize.OMXMLReader This class is used internally by `OMSource`. Starting with Axiom 1.2.13, application code should use `OMContainer.getSAXSource(boolean)` to serialize an OM tree to SAX. If there is a need to obtain an `XMLReader` instance, use `SAXSource.getXMLReader()` on the `SAXSource` returned by `OMContainer.getSAXSource(boolean)`.
org.apache.axiom.util.blob.OverflowBlob Use `org.apache.axiom.blob.OverflowableBlob` instead.
org.apache.axiom.om.impl.builder.SAXOMBuilder To build an Axiom tree from SAX events, either use `OMXMLBuilderFactory.createOMBuilder(SAXSource, boolean)` (if a `SAXSource` is available or can be easily constructed), or create an `OMDocument` (using `OMFactory.createOMDocument()`) and use `OMContainer.getSAXResult()` to create a `SAXResult` for that document. After writing the SAX events to the `SAXResult`, the root element of the resulting tree can be retrieved using `OMDocument.getOMDocumentElement()`. If the application code doesn't support `SAXResult` and needs to interface with a `ContentHandler` directly, use `SAXResult.getHandler()` on the `SAXResult` returned by `OMContainer.getSAXResult()`.
org.apache.axiom.om.impl.serialize.StreamWriterToContentHandlerConverter This is an internal implementation class that is no longer used.
org.apache.axiom.om.util.TextHelper Class containing only deprecated utility methods.
org.apache.axiom.om.util.UUIDGenerator Please use one of the specialized methods in the `UIDGenerator` class. In contrast to what its name suggests, the `UUIDGenerator.getUUID()` method doesn't return a UUID. It doesn't return a valid URN with uuid NID either. See AXIS2-4527 for more information.
org.apache.axiom.om.impl.llom.util.XMLComparator This class is no longer maintained. Please use XmlUnit to compare XML documents.

Deprecated Exceptions
Exceptions and Description
org.apache.axiom.om.impl.exception.OMStreamingException
org.apache.axiom.om.impl.exception.XMLComparisonException This exception is only used by `XMLComparator` which is deprecated.

Deprecated Methods
Method and Description
org.apache.axiom.om.impl.MIMEOutputUtils.complete(OutputStream, byte[], LinkedList, String, String, String, String) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.MIMEOutputUtils.complete(OutputStream, byte[], LinkedList, String, String, String, String, OMOutputFormat) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.MIMEOutputUtils.createMimeBodyPart(String, DataHandler) This method is only useful in conjunction with `MIMEOutputUtils.writeBodyPart(OutputStream, MimeBodyPart, String)`, which is deprecated.
org.apache.axiom.om.impl.MIMEOutputUtils.createMimeBodyPart(String, DataHandler, OMOutputFormat) This method is only useful in conjunction with `MIMEOutputUtils.writeBodyPart(OutputStream, MimeBodyPart, String)`, which is deprecated.
org.apache.axiom.om.impl.MIMEOutputUtils.finishWritingMime(OutputStream) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.builder.SAXOMBuilder.getRootElement()
org.apache.axiom.om.impl.traverse.OMChildrenQNameIterator.isEquals_Legacy(QName, QName)
org.apache.axiom.om.impl.MIMEOutputUtils.startWritingMime(OutputStream, String) Use `OMMultipartWriter` instead.
org.apache.axiom.om.util.TextHelper.toOMText(byte[], int, int, OMFactory, boolean) The implementation of this method is incomplete. It will be removed in Axiom 1.3.
org.apache.axiom.om.util.TextHelper.toOMText(byte[], int, int, OMFactory, boolean, String) The implementation of this method is incomplete. It will be removed in Axiom 1.3.
org.apache.axiom.om.util.TextHelper.toString(InputStream) This method was internally used by Axiom before version 1.2.9 but is no longer required.
org.apache.axiom.om.util.TextHelper.toStringBuffer(InputStream, StringBuffer) This method was internally used by Axiom before version 1.2.9 but is no longer required.
org.apache.axiom.om.util.TextHelper.toStringBuffer(OMText, StringBuffer) If you really need to write the base64 encoded content of an `OMText` instance to a `StringBuffer`, then request the `DataHandler` using `OMText.getDataHandler()` and use `Base64EncodingStringBufferOutputStream` to encode it.
org.apache.axiom.om.impl.MIMEOutputUtils.writeBodyPart(OutputStream, MimeBodyPart, String) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.MIMEOutputUtils.writeDataHandlerWithAttachmentsMessage(DataHandler, String, OutputStream, Map, OMOutputFormat) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.MIMEOutputUtils.writeDataHandlerWithAttachmentsMessage(DataHandler, String, OutputStream, Map, OMOutputFormat, Collection) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.MIMEOutputUtils.writeMimeBoundary(OutputStream, String) Use `OMMultipartWriter` instead.
org.apache.axiom.om.impl.MIMEOutputUtils.writeMM7Message(StringWriter, OutputStream, Attachments, OMOutputFormat, String, String) Axiom only supports standard SwA messages. However, `OMMultipartWriter` provides a flexible way to build MIME packages for non standard formats such as MM7.
org.apache.axiom.om.impl.MIMEOutputUtils.writeSOAPWithAttachmentsMessage(StringWriter, OutputStream, Attachments, OMOutputFormat) Use `OMMultipartWriter` instead.

Deprecated API

Contents