public class XmlHelper
extends java.lang.Object
Constructor and Description |
---|
XmlHelper() |
Modifier and Type | Method and Description |
---|---|
static org.w3c.dom.Document |
createDocument(AdaptrisMessage msg)
Deprecated.
Consider using
createDocument(AdaptrisMessage, NamespaceContext) instead. |
static org.w3c.dom.Document |
createDocument(AdaptrisMessage msg,
boolean namespaceAware)
Deprecated.
since 3.1.0 use {
createDocument(AdaptrisMessage, DocumentBuilderFactoryBuilder) instead. |
static org.w3c.dom.Document |
createDocument(AdaptrisMessage msg,
DocumentBuilderFactoryBuilder builder)
Create a document from an AdaptrisMessage.
|
static org.w3c.dom.Document |
createDocument(AdaptrisMessage msg,
DocumentBuilderFactoryBuilder builder,
boolean newDocOnFailure)
Create a document from an AdaptrisMessage.
|
static org.w3c.dom.Document |
createDocument(AdaptrisMessage msg,
javax.xml.namespace.NamespaceContext namespaceContext)
Deprecated.
since 3.1.0 use {
createDocument(AdaptrisMessage, DocumentBuilderFactoryBuilder) instead. |
static org.w3c.dom.Document |
createDocument(java.io.InputStream in,
DocumentBuilderFactoryBuilder builder)
Create a document from an
InputStream . |
static org.w3c.dom.Document |
createDocument(java.io.InputStream in,
DocumentBuilderFactoryBuilder builder,
boolean newDocOnFailure)
Create a document from an
InputStream . |
static org.w3c.dom.Document |
createDocument(java.lang.String s)
Deprecated.
since 3.1.0 use {
createDocument(String, DocumentBuilderFactoryBuilder) instead. |
static org.w3c.dom.Document |
createDocument(java.lang.String s,
boolean namespaceAware)
Deprecated.
since 3.1.0 use {
createDocument(String, DocumentBuilderFactoryBuilder) instead. |
static org.w3c.dom.Document |
createDocument(java.lang.String s,
DocumentBuilderFactoryBuilder builder)
Create a document from an AdaptrisMessage.
|
static org.w3c.dom.Document |
createDocument(java.lang.String s,
DocumentBuilderFactoryBuilder builder,
boolean newDocOnFailure)
Create a document from an AdaptrisMessage.
|
static org.w3c.dom.Document |
createDocument(java.lang.String s,
javax.xml.namespace.NamespaceContext namespaceContext)
Deprecated.
since 3.1.0 use {
createDocument(String, DocumentBuilderFactoryBuilder) instead. |
static XmlUtils |
createXmlUtils(AdaptrisMessage msg)
Deprecated.
Consider using
createXmlUtils(AdaptrisMessage, NamespaceContext) instead. |
static XmlUtils |
createXmlUtils(AdaptrisMessage msg,
javax.xml.namespace.NamespaceContext ctx)
Deprecated.
since 3.1.0 use {
createDocument(AdaptrisMessage, DocumentBuilderFactoryBuilder) instead. |
static XmlUtils |
createXmlUtils(AdaptrisMessage msg,
javax.xml.namespace.NamespaceContext ctx,
DocumentBuilderFactoryBuilder builder)
Create an XMLUtils class from an AdaptrisMessage.
|
static java.lang.String |
getXmlEncoding(AdaptrisMessage msg,
java.lang.String enc)
Figure out what encoding to use when writing a document.
|
static java.lang.String |
safeElementName(java.lang.String input,
java.lang.String defaultIfBlank)
Make a safe element name by stripping out illegal XML characters and illegal element characters.
|
static java.lang.String |
stripIllegalXmlCharacters(java.lang.String input)
Strip illegal XML characters from data.
|
static void |
writeXmlDocument(org.w3c.dom.Document doc,
AdaptrisMessage msg,
java.lang.String encoding)
Write an XML document to the message with specified encoding.
|
@Deprecated public static XmlUtils createXmlUtils(AdaptrisMessage msg) throws CoreException
createXmlUtils(AdaptrisMessage, NamespaceContext)
instead.msg
- the Adaptris messageCoreException
- if the msg does not contain valid XML.@Deprecated public static XmlUtils createXmlUtils(AdaptrisMessage msg, javax.xml.namespace.NamespaceContext ctx) throws CoreException
createDocument(AdaptrisMessage, DocumentBuilderFactoryBuilder)
instead.msg
- the Adaptris messagectx
- the NamespaceContext.CoreException
- if the msg does not contain valid XML.public static XmlUtils createXmlUtils(AdaptrisMessage msg, javax.xml.namespace.NamespaceContext ctx, DocumentBuilderFactoryBuilder builder) throws CoreException
msg
- the Adaptris messagectx
- the NamespaceContext.builder
- configuration for the underlying DocumentBuilderFactory
instance..CoreException
- if the msg does not contain valid XML.@Deprecated public static org.w3c.dom.Document createDocument(AdaptrisMessage msg) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
createDocument(AdaptrisMessage, NamespaceContext)
instead.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
createDocument(AdaptrisMessage, boolean)
@Deprecated public static org.w3c.dom.Document createDocument(AdaptrisMessage msg, boolean namespaceAware) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
createDocument(AdaptrisMessage, DocumentBuilderFactoryBuilder)
instead.msg
- the AdaptrisMessagenamespaceAware
- whether or not the document builder factory used will be namespace aware.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static org.w3c.dom.Document createDocument(AdaptrisMessage msg, DocumentBuilderFactoryBuilder builder) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
msg
- the AdaptrisMessagebuilder
- configuration for the underlying DocumentBuilderFactory
instance..javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static org.w3c.dom.Document createDocument(AdaptrisMessage msg, DocumentBuilderFactoryBuilder builder, boolean newDocOnFailure) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
msg
- the AdaptrisMessagebuilder
- configuration for the underlying DocumentBuilderFactory
instance.newDocOnFailure
- create a new Document if the msg failed to parse.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
@Deprecated public static org.w3c.dom.Document createDocument(AdaptrisMessage msg, javax.xml.namespace.NamespaceContext namespaceContext) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
createDocument(AdaptrisMessage, DocumentBuilderFactoryBuilder)
instead.msg
- the AdaptrisMessagenamespaceContext
- the name space context, if null, then we will not be namespace aware.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
@Deprecated public static org.w3c.dom.Document createDocument(java.lang.String s) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
createDocument(String, DocumentBuilderFactoryBuilder)
instead.s
- the string containing XMLjavax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
@Deprecated public static org.w3c.dom.Document createDocument(java.lang.String s, javax.xml.namespace.NamespaceContext namespaceContext) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
createDocument(String, DocumentBuilderFactoryBuilder)
instead.s
- the string containing XMLnamespaceContext
- the namespace context, if null, then we will not be namespace aware.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
@Deprecated public static org.w3c.dom.Document createDocument(java.lang.String s, boolean namespaceAware) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
createDocument(String, DocumentBuilderFactoryBuilder)
instead.s
- the string containing XMLnamespaceAware
- whether or not the document builder factory used will be namespace aware.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static org.w3c.dom.Document createDocument(java.lang.String s, DocumentBuilderFactoryBuilder builder) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
s
- the string containing XMLbuilder
- configuration for the underlying DocumentBuilderFactory
instance..javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static org.w3c.dom.Document createDocument(java.lang.String s, DocumentBuilderFactoryBuilder builder, boolean newDocOnFailure) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
s
- the string containing XMLbuilder
- configuration for the underlying DocumentBuilderFactory
instance..newDocOnFailure
- return a new document if the String is not XML.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static org.w3c.dom.Document createDocument(java.io.InputStream in, DocumentBuilderFactoryBuilder builder) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
InputStream
.in
- the inputstreambuilder
- configuration for the underlying DocumentBuilderFactory
instance..javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static org.w3c.dom.Document createDocument(java.io.InputStream in, DocumentBuilderFactoryBuilder builder, boolean newDocOnFailure) throws javax.xml.parsers.ParserConfigurationException, java.io.IOException, org.xml.sax.SAXException
InputStream
.in
- the inputstreambuilder
- configuration for the underlying DocumentBuilderFactory
instance.newDocOnFailure
- return a new document if the input stream failed to parse.javax.xml.parsers.ParserConfigurationException
java.io.IOException
org.xml.sax.SAXException
public static java.lang.String safeElementName(java.lang.String input, java.lang.String defaultIfBlank)
input
- the input string.defaultIfBlank
- the default element name if the input resolves to the blank string (whitespace is trimmed).public static java.lang.String stripIllegalXmlCharacters(java.lang.String input)
The following regular expression is used to strip out all invalid XML 1.0 characters :
"[^ \r\n --�𐀀-]"
.
input
- the input stringpublic static void writeXmlDocument(org.w3c.dom.Document doc, AdaptrisMessage msg, java.lang.String encoding) throws java.lang.Exception
doc
- the documentmsg
- the messageencoding
- will default to "UTF-8" if not specified, and the msg does not have a declared content encoding.java.lang.Exception
public static java.lang.String getXmlEncoding(AdaptrisMessage msg, java.lang.String enc)
msg
- the messageenc
- the configured encoding, if any.encoding
, AdaptrisMessage#getContentEncoding()
or 'UTF-8' in that order or
preference.