XMLUtils (citrus-core 2.4 API)

java.lang.Object
- com.consol.citrus.util.XMLUtils

```
public final class XMLUtils
extends Object
```
Class providing several utility methods for XML processing.

Since:

2006

Author:

Jan Szczepanski, Christoph Deppisch

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CDATA_SECTIONS`
`static String`	`ELEMENT_CONTENT_WHITESPACE`
`static String`	`FORMAT_PRETTY_PRINT`
`static String`	`RESOURCE_RESOLVER`
`static String`	`SPLIT_CDATA_SECTIONS`
`static String`	`VALIDATE_IF_SCHEMA`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static LSInput`	`createLSInput()` Creates LSInput from dom implementation.
`static LSOutput`	`createLSOutput()` Creates LSOutput form dom implementation.
`static LSParser`	`createLSParser()` Creates basic LSParser instance and sets common properties and configuration parameters.
`static LSSerializer`	`createLSSerializer()` Creates basic LSSerializer instance and sets common properties and configuration parameters.
`static Node`	`findNodeByName(Document doc, String pathExpression)` Searches for a node within a DOM document with a given node path expression.
`static String`	`getNodesPathName(Node node)` Returns the path expression for a given node.
`static Charset`	`getTargetCharset(Document doc)` Try to find encoding for document node.
`static Map<String,String>`	`lookupNamespaces(Node referenceNode)` Look up namespace attribute declarations in the specified node and store them in a binding map, where the key is the namespace prefix and the value is the namespace uri.
`static Map<String,String>`	`lookupNamespaces(String xml)` Look up namespace attribute declarations in the XML fragment and store them in a binding map, where the key is the namespace prefix and the value is the namespace uri.
`static String`	`omitXmlDeclaration(String xml)` Removes leading XML declaration from xml if present.
`static Document`	`parseMessagePayload(String messagePayload)` Parse message payload with DOM implementation.
`static String`	`prettyPrint(String xml)` Pretty prints a XML string.
`static String`	`serialize(Document doc)` Serializes a DOM document
`static void`	`setParserConfigParameter(LSParser parser, String parameterName, Object value)` Sets a config parameter on LSParser instance if settable.
`static void`	`setSerializerConfigParameter(LSSerializer serializer, String parameterName, Object value)` Sets a config parameter on LSParser instance if settable.
`static void`	`stripWhitespaceNodes(Node element)` Removes text nodes that are only containing whitespace characters inside a DOM tree.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SPLIT_CDATA_SECTIONS
```
public static final String SPLIT_CDATA_SECTIONS
```
    See Also:
    
    Constant Field Values
  - FORMAT_PRETTY_PRINT
```
public static final String FORMAT_PRETTY_PRINT
```
    See Also:
    
    Constant Field Values
  - ELEMENT_CONTENT_WHITESPACE
```
public static final String ELEMENT_CONTENT_WHITESPACE
```
    See Also:
    
    Constant Field Values
  - CDATA_SECTIONS
```
public static final String CDATA_SECTIONS
```
    See Also:
    
    Constant Field Values
  - VALIDATE_IF_SCHEMA
```
public static final String VALIDATE_IF_SCHEMA
```
    See Also:
    
    Constant Field Values
  - RESOURCE_RESOLVER
```
public static final String RESOURCE_RESOLVER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - createLSParser
```
public static LSParser createLSParser()
```
    Creates basic LSParser instance and sets common properties and configuration parameters.
    
    Returns:
  - createLSSerializer
```
public static LSSerializer createLSSerializer()
```
    Creates basic LSSerializer instance and sets common properties and configuration parameters.
    
    Returns:
  - createLSInput
```
public static LSInput createLSInput()
```
    Creates LSInput from dom implementation.
    
    Returns:
  - createLSOutput
```
public static LSOutput createLSOutput()
```
    Creates LSOutput form dom implementation.
    
    Returns:
  - findNodeByName
```
public static Node findNodeByName(Document doc,
                                  String pathExpression)
```
    Searches for a node within a DOM document with a given node path expression. Elements are separated by '.' characters. Example: Foo.Bar.Poo
    
    Parameters:
    
    doc - DOM Document to search for a node.
    
    pathExpression - dot separated path expression
    
    Returns:
    
    Node element found in the DOM document.
  - stripWhitespaceNodes
```
public static void stripWhitespaceNodes(Node element)
```
    Removes text nodes that are only containing whitespace characters inside a DOM tree.
    
    Parameters:
    
    element - the root node to normalize.
  - getNodesPathName
```
public static String getNodesPathName(Node node)
```
    Returns the path expression for a given node. Path expressions look like: Foo.Bar.Poo where elements are separated with a dot character.
    
    Parameters:
    
    node - in DOM tree.
    
    Returns:
    
    the path expression representing the node in DOM tree.
  - serialize
```
public static String serialize(Document doc)
```
    Serializes a DOM document
    
    Parameters:
    
    doc -
    
    Returns:
    
    serialized XML string
    
    Throws:
    
    CitrusRuntimeException
  - prettyPrint
```
public static String prettyPrint(String xml)
```
    Pretty prints a XML string.
    
    Parameters:
    
    xml -
    
    Returns:
    
    pretty printed XML string
    
    Throws:
    
    CitrusRuntimeException
  - lookupNamespaces
```
public static Map<String,String> lookupNamespaces(Node referenceNode)
```
    Look up namespace attribute declarations in the specified node and store them in a binding map, where the key is the namespace prefix and the value is the namespace uri.
    
    Parameters:
    
    referenceNode - XML node to search for namespace declarations.
    
    Returns:
    
    map containing namespace prefix - namespace url pairs.
  - lookupNamespaces
```
public static Map<String,String> lookupNamespaces(String xml)
```
    Look up namespace attribute declarations in the XML fragment and store them in a binding map, where the key is the namespace prefix and the value is the namespace uri.
    
    Parameters:
    
    xml - XML fragment.
    
    Returns:
    
    map containing namespace prefix - namespace uri pairs.
  - parseMessagePayload
```
public static Document parseMessagePayload(String messagePayload)
```
    Parse message payload with DOM implementation.
    
    Parameters:
    
    messagePayload -
    
    Returns:
    
    DOM document.
    
    Throws:
    
    CitrusRuntimeException
  - getTargetCharset
```
public static Charset getTargetCharset(Document doc)
```
    Try to find encoding for document node. Also supports Citrus default encoding set as System property.
    
    Parameters:
    
    doc -
    
    Returns:
  - setSerializerConfigParameter
```
public static void setSerializerConfigParameter(LSSerializer serializer,
                                                String parameterName,
                                                Object value)
```
    Sets a config parameter on LSParser instance if settable. Otherwise logging unset parameter.
    
    Parameters:
    
    serializer -
    
    parameterName -
    
    value -
  - setParserConfigParameter
```
public static void setParserConfigParameter(LSParser parser,
                                            String parameterName,
                                            Object value)
```
    Sets a config parameter on LSParser instance if settable. Otherwise logging unset parameter.
    
    Parameters:
    
    parser -
    
    parameterName -
    
    value -
  - omitXmlDeclaration
```
public static String omitXmlDeclaration(String xml)
```
    Removes leading XML declaration from xml if present.
    
    Parameters:
    
    xml -
    
    Returns:

Class XMLUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SPLIT_CDATA_SECTIONS

FORMAT_PRETTY_PRINT

ELEMENT_CONTENT_WHITESPACE

CDATA_SECTIONS

VALIDATE_IF_SCHEMA

RESOURCE_RESOLVER

Method Detail

createLSParser

createLSSerializer

createLSInput

createLSOutput

findNodeByName

stripWhitespaceNodes

getNodesPathName

serialize

prettyPrint

lookupNamespaces

lookupNamespaces

parseMessagePayload

getTargetCharset

setSerializerConfigParameter

setParserConfigParameter

omitXmlDeclaration