es.ree.eemws.core.utils.xml

Class XMLUtil

java.lang.Object

es.ree.eemws.core.utils.xml.XMLUtil

public final class XMLUtil
extends java.lang.Object

Class that contains utilities for XML messages.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	document2String(org.w3c.dom.Document doc) Returns the string representation of a given XML document.
static java.lang.String	getNodeValue(java.lang.String tag, java.lang.StringBuilder doc) Gets the value of the node.
static java.lang.String	getRootTag(java.lang.StringBuilder strXml) Searches a XML document root tag value given the document as a string.
static java.lang.StringBuilder	prettyPrint(java.lang.String whatToPretty) Gets a pretty print document using the format of the opening and closing tags.
static java.lang.StringBuilder	removeNameSpaces(java.lang.String xml) This method removes namespace prefixes of a given document with leaving this default namespace.
static java.lang.String	soapMessage2String(javax.xml.soap.SOAPMessage message) Transforms a SOAP message into a String.
static org.w3c.dom.Document	string2Document(java.lang.String msgAsString) Returns an XML document from a String.
static org.w3c.dom.Document	string2Document(java.lang.StringBuilder msgAsString) Returns an XML document from a StringBuilder (String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNodeValue

public static java.lang.String getNodeValue(java.lang.String tag,
                            java.lang.StringBuilder doc)

Gets the value of the node.

Parameters:

tag - Tag name.

doc - XML document in string.

Returns:

Value of the node.

string2Document

public static org.w3c.dom.Document string2Document(java.lang.String msgAsString)
                                            throws javax.xml.parsers.ParserConfigurationException,
                                                   org.xml.sax.SAXException,
                                                   java.io.IOException

Returns an XML document from a String.

Parameters:

msgAsString - String that contains an XML document to be transformed.

Returns:

An XML document.

Throws:

javax.xml.parsers.ParserConfigurationException - If the factory cannot transform the the string into a document.

org.xml.sax.SAXException - If the given string doesn't contain a valid XML document.

java.io.IOException - If the given string cannot be read.

string2Document

public static org.w3c.dom.Document string2Document(java.lang.StringBuilder msgAsString)
                                            throws javax.xml.parsers.ParserConfigurationException,
                                                   org.xml.sax.SAXException,
                                                   java.io.IOException

Returns an XML document from a StringBuilder (String).

Parameters:

msgAsString - String that contains an XML document to be transformed.

Returns:

An XML document.

Throws:

javax.xml.parsers.ParserConfigurationException - If the factory cannot transform the the string into a document.

org.xml.sax.SAXException - If the given string doesn't contain a valid XML document.

java.io.IOException - If the given string cannot be read.

document2String

public static java.lang.String document2String(org.w3c.dom.Document doc)
                                        throws javax.xml.transform.TransformerException

Returns the string representation of a given XML document. Note that the return string us UTF-8 encoded and has no XML declaration.

Parameters:

doc - The input document to transform.

Returns:

A string representation of the given XML document.

Throws:

javax.xml.transform.TransformerException - If it's impossible to convert the given document.

prettyPrint

public static java.lang.StringBuilder prettyPrint(java.lang.String whatToPretty)

Gets a pretty print document using the format of the opening and closing tags.

Parameters:

whatToPretty - Text formatting.

Returns:

Document formatted as.

removeNameSpaces

public static java.lang.StringBuilder removeNameSpaces(java.lang.String xml)

This method removes namespace prefixes of a given document with leaving this default namespace. Example: input ... output ...

Parameters:

xml - XML document to remove references to prefixes of namespaces.

Returns:

XML document without namespaces.

getRootTag

public static java.lang.String getRootTag(java.lang.StringBuilder strXml)

Searches a XML document root tag value given the document as a string. We search from the end to the top (The last tag is also the root tag!) There are serveral cases:

(1) Simple end tag: (2) End tag with namespace prefix: (3) Empty document: (4) Empty document with namespace prefix:

Parameters:

strXml - document as a string.

Returns:

Xml's root tag as a String null if the given xml is not well formed (cannot find root tag).

soapMessage2String

public static java.lang.String soapMessage2String(javax.xml.soap.SOAPMessage message)
                                           throws javax.xml.soap.SOAPException

Transforms a SOAP message into a String.

Parameters:

message - SOAP message.

Returns:

String with the content of the SOAP message.

Throws:

javax.xml.soap.SOAPException - Exception transform the message.