Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

org.apache.axiom.attachments.SizeAwareDataSource
Please implement SizeAwareDataSource

Deprecated Classes

org.apache.axiom.om.util.Base64
Use Base64Utils instead.

org.apache.axiom.attachments.lifecycle.impl.DataHandlerExtImpl
This class is no longer used in Axiom 1.2.13 and will be removed in Axiom 1.3.

org.apache.axiom.om.impl.builder.DataHandlerReaderUtils
Use the corresponding methods in XMLStreamReaderUtils instead.

org.apache.axiom.om.impl.EmptyOMLocation
use DummyLocation.INSTANCE 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.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.ds.OMDataSourceExtBase
As described in AXIOM-419, this class has multiple issues and should no longer be used as a base class for OMDataSource implementations. Instead, use AbstractOMDataSource, AbstractPullOMDataSource or AbstractPushOMDataSource.

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.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 also doesn't return a valid URN with uuid NID. See AXIS2-4527 for more information.

Deprecated Fields

org.apache.axiom.om.OMConstants.ARRAY_ITEM_LOCALNAME
This constant was used in early prototypes of Axis2 and is no longer relevant.

org.apache.axiom.om.OMConstants.ARRAY_ITEM_NS_PREFIX
This constant was used in early prototypes of Axis2 and is no longer relevant.

org.apache.axiom.om.OMConstants.ARRAY_ITEM_NSURI
This constant was used in early prototypes of Axis2 and is no longer relevant.

org.apache.axiom.om.OMConstants.ARRAY_ITEM_QNAME
This constant was used in early prototypes of Axis2 and is no longer relevant.

org.apache.axiom.om.impl.MTOMConstants.ATTACHMENTS
This was used in old versions of Axis2 as the key identifying the attachments map in the message context. You should no longer use this.

org.apache.axiom.om.OMConstants.DATA_HANDLER

org.apache.axiom.om.OMConstants.DEFAULT_DEFAULT_NAMESPACE

org.apache.axiom.om.OMConstants.IS_BINARY

org.apache.axiom.om.OMConstants.IS_DATA_HANDLERS_AWARE

org.apache.axiom.om.OMDataSourceExt.LOSSY_PREFIX
To create an OMSourcedElement with unknown prefix, use OMFactory.createOMElement(OMDataSource, String, OMNamespace) and pass null as prefix.

org.apache.axiom.om.OMOutputFormat.RESPECT_SWA_ATTACHMENT_ORDER
As of version 1.2.13, Axiom always respects the order of attachments.

org.apache.axiom.om.OMOutputFormat.RESPECT_SWA_ATTACHMENT_ORDER_DEFAULT
As of version 1.2.13, Axiom always respects the order of attachments.

org.apache.axiom.om.impl.MTOMConstants.ROOT_PART

org.apache.axiom.om.OMConstants.XMLNS_NS_PREFIX
Use XMLConstants.XMLNS_ATTRIBUTE instead.

org.apache.axiom.om.OMConstants.XMLNS_NS_URI
Use XMLConstants.XMLNS_ATTRIBUTE_NS_URI instead.

Deprecated Methods

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.util.CopyUtils.copy(SOAPEnvelope)
This method has the same effect as calling OMInformationItem.clone(OMCloneOptions) on the source SOAPEnvelope with the following options enabled:

• OMCloneOptions.setFetchDataHandlers(boolean)
• OMCloneOptions.setPreserveModel(boolean)
• OMCloneOptions.setCopyOMDataSources(boolean)

Instead of using this method, application code should use OMInformationItem.clone(OMCloneOptions) directly and fine tune the options for the particular use case.

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.util.StAXUtils.createNetworkDetachedXMLStreamReader(InputStream)
use StAXUtils.createXMLStreamReader(StAXParserConfiguration, InputStream) with StAXParserConfiguration.STANDALONE

org.apache.axiom.om.util.StAXUtils.createNetworkDetachedXMLStreamReader(InputStream, String)
use StAXUtils.createXMLStreamReader(StAXParserConfiguration, InputStream, String) with StAXParserConfiguration.STANDALONE

org.apache.axiom.om.util.StAXUtils.createNetworkDetachedXMLStreamReader(Reader)
use StAXUtils.createXMLStreamReader(StAXParserConfiguration, Reader) with StAXParserConfiguration.STANDALONE

org.apache.axiom.om.impl.builder.StAXOMBuilder.createPrefix()
A builder doesn't need to generate prefixes.

org.apache.axiom.attachments.lifecycle.DataHandlerExt.deleteWhenReadOnce()
Use DataHandlerExt.readOnce() or DataHandlerExt.purgeDataSource() instead.

org.apache.axiom.om.OMXMLParserWrapper.discard(OMElement)
Use OMNode.discard() to discard elements.

org.apache.axiom.om.impl.MIMEOutputUtils.finishWritingMime(OutputStream)
Use OMMultipartWriter instead.

org.apache.axiom.om.util.ElementHelper.getChildWithName(OMElement, String)
please use OMElement.getFirstChildWithName(qname) instead!

org.apache.axiom.om.util.ElementHelper.getContentID(XMLStreamReader, String)
use ElementHelper.getContentID(XMLStreamReader) instead (see AXIOM-129)

org.apache.axiom.attachments.lifecycle.impl.FileAccessor.getDataHandler(String)
This method is no longer used in Axiom 1.2.13 and will be removed in Axiom 1.3.

org.apache.axiom.om.util.StAXUtils.getEventTypeString(int)
Use XMLEventUtils.getEventTypeString(int) instead

org.apache.axiom.attachments.Attachments.getIncomingAttachmentsAsSingleStream()
As of Axiom 1.2.13, this method is no longer supported.

org.apache.axiom.om.OMNamespace.getName()
This method is deprecated. Please use getNamespaceURI() method instead.

org.apache.axiom.om.OMText.getNamespace()
This API is going away. Please use getTextAsQName() instead.

org.apache.axiom.om.util.StAXUtils.getNetworkDetachedXMLInputFactory()
use StAXUtils.getXMLInputFactory(StAXParserConfiguration) with StAXParserConfiguration.STANDALONE

org.apache.axiom.soap.SOAPFaultNode.getNodeValue()
This method conflicts with Node.getNodeValue() and will be removed in Axiom 1.3. Please use SOAPFaultNode.getFaultNodeValue() instead.

org.apache.axiom.attachments.Attachments.getSOAPPartContentID()
Use Attachments.getRootPartContentID() instead.

org.apache.axiom.attachments.Attachments.getSOAPPartContentType()
Use Attachments.getRootPartContentType() instead.

org.apache.axiom.attachments.Attachments.getSOAPPartInputStream()
Use Attachments.getRootPartInputStream() instead.

org.apache.axiom.om.OMText.getTextAsQName()
If the underlying parser is non coalescing, then this method may unexpectedly fail or return an incorrect result. Always use OMElement.getTextAsQName() to get the QName value of an element.

org.apache.axiom.om.util.ElementHelper.getTextAsStream(OMElement, boolean)
Use OMElement.getTextAsStream(boolean) instead.

org.apache.axiom.om.impl.builder.StAXBuilder.init(InputStream, String, String, String)
Not used anywhere

org.apache.axiom.om.impl.OMNodeEx.internalSerialize(XMLStreamWriter)
This method will be removed in a future version of Axiom. It is only here to maintain backward compatibility with projects using this method despite the fact that it is marked as internal.

org.apache.axiom.om.impl.OMNodeEx.internalSerializeAndConsume(XMLStreamWriter)
This method will be removed in a future version of Axiom. It is only here to maintain backward compatibility with projects using this method despite the fact that it is marked as internal.

org.apache.axiom.om.OMOutputFormat.isAutoCloseWriter()

org.apache.axiom.om.impl.traverse.OMChildrenQNameIterator.isEquals_Legacy(QName, QName)

org.apache.axiom.om.OMXMLStreamReader.isInlineMTOM()
This method will be removed in a future release of Axiom. See OMXMLStreamReader.setInlineMTOM(boolean) for more details.

org.apache.axiom.om.impl.MTOMXMLStreamWriter.isOptimizedThreshold(OMText)
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 MTOMXMLStreamWriter.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.

org.apache.axiom.om.impl.util.OMSerializerUtil.isSetPrefixBeforeStartElement(XMLStreamWriter)
This method was used to work around a StAX conformance issue in early versions of the XL XP-J parser. This is now handled by StAXDialect, and this method always returns false.

org.apache.axiom.om.util.StAXUtils.releaseXMLInputFactory(XMLInputFactory)
Returns an XMLInputFactory instance for reuse.

org.apache.axiom.om.util.StAXUtils.releaseXMLOutputFactory(XMLOutputFactory)
Returns an XMLOutputFactory instance for reuse.

org.apache.axiom.om.util.StAXUtils.reset()

org.apache.axiom.om.util.ElementHelper.resolveQName(String)
The algorithm used by this method is incorrect. See AXIOM-356 for more details.

org.apache.axiom.om.util.ElementHelper.resolveQName(String, boolean)
The algorithm used by this method is incorrect. See AXIOM-356 for more details.

org.apache.axiom.om.OMNode.serialize(OutputStream)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serialize(OutputStream, OMOutputFormat)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serialize(Writer)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serialize(Writer, OMOutputFormat)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serializeAndConsume(OutputStream)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serializeAndConsume(OutputStream, OMOutputFormat)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serializeAndConsume(Writer)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.OMNode.serializeAndConsume(Writer, OMOutputFormat)
This method is not meaningful on a node in general, but only on an OMElement.

org.apache.axiom.om.impl.util.OMSerializerUtil.serializeAttribute(OMAttribute, XMLStreamWriter)
use serializeStartpart instead

org.apache.axiom.om.impl.util.OMSerializerUtil.serializeAttributes(OMElement, XMLStreamWriter)
Consider using serializeStartpart instead

org.apache.axiom.om.impl.util.OMSerializerUtil.serializeNamespace(OMNamespace, XMLStreamWriter)
Use serializeStartpart instead

org.apache.axiom.om.impl.util.OMSerializerUtil.serializeNamespaces(OMElement, XMLStreamWriter)
Use serializeStartpart instead

org.apache.axiom.om.OMOutputFormat.setAutoCloseWriter(boolean)

org.apache.axiom.om.impl.builder.StAXOMBuilder.setDoDebug(boolean)

org.apache.axiom.om.OMXMLStreamReader.setInlineMTOM(boolean)
To return optimized base64 content as xop:Include elements, wrap the reader using XOPEncodingStreamReader or use the more generic XOPUtils.getXOPEncodedStream(XMLStreamReader) method. This method introduces unnecessary complexity in the XMLStreamReader implementation used by Axiom and will be removed in a future release.

org.apache.axiom.soap.SOAPFaultNode.setNodeValue(String)
This method conflicts with Node.setNodeValue(String) and will be removed in Axiom 1.3. Please use SOAPFaultNode.setFaultNodeValue(String) instead.

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.MTOMXMLStreamWriter.writeOptimized(OMText)
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 MTOMXMLStreamWriter.prepareDataHandler(DataHandler) should be used.

org.apache.axiom.om.impl.MIMEOutputUtils.writeSOAPWithAttachmentsMessage(StringWriter, OutputStream, Attachments, OMOutputFormat)
Use OMMultipartWriter instead.

org.apache.axiom.om.util.ElementHelper.writeTextTo(OMElement, Writer, boolean)
Use OMElement.writeTextTo(Writer, boolean) instead.

Deprecated Constructors

org.apache.axiom.om.impl.builder.SAXOMBuilder()
Instead of creating an instance of this class directly, create a SAXSource and use OMXMLBuilderFactory.createOMBuilder(SAXSource, boolean).

org.apache.axiom.om.impl.builder.SAXOMBuilder(OMFactory)
Instead of creating an instance of this class directly, create a SAXSource and use OMXMLBuilderFactory.createOMBuilder(OMFactory, SAXSource, boolean).

org.apache.axiom.om.impl.builder.StAXBuilder()

org.apache.axiom.om.impl.builder.StAXOMBuilder()