com.hazelcast.internal.util

Class XmlUtil

java.lang.Object

com.hazelcast.internal.util.XmlUtil

public final class XmlUtil
extends Object

Utility class for XML processing.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SYSTEM_PROPERTY_IGNORE_XXE_PROTECTION_FAILURES System property name which allows ignoring failures during enabling the XML External Entity protection.

Method Summary

Modifier and Type	Method and Description
static String	format(String input, int indent) Formats given XML String with the given indentation used.
ErrorListener	getErrorListener() Returns ErrorListener implementation which just throws the original error.
static SchemaFactory	getSchemaFactory() Returns SchemaFactory with XXE protection enabled.
static TransformerFactory	getTransformerFactory() Returns TransformerFactory with XXE protection enabled.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_PROPERTY_IGNORE_XXE_PROTECTION_FAILURES

public static final String SYSTEM_PROPERTY_IGNORE_XXE_PROTECTION_FAILURES

System property name which allows ignoring failures during enabling the XML External Entity protection. This property should only be used as a last resort. Hazelcast uses the XXE protection by setting properties XMLConstants.ACCESS_EXTERNAL_DTD and XMLConstants.ACCESS_EXTERNAL_SCHEMA. These properties are supported in modern XML processors (JAXP 1.5+, Java 8+). Old JAXP implementations on the classpath (e.g. Xerces, Xalan) may miss the support and they throw exception during enabling the XXE protection. Setting this system property to true suppresses/ignores such Exceptions.

See Also:

Constant Field Values

Method Detail

getTransformerFactory

public static TransformerFactory getTransformerFactory()

Returns TransformerFactory with XXE protection enabled.

getSchemaFactory

public static SchemaFactory getSchemaFactory()
                                      throws SAXException

Returns SchemaFactory with XXE protection enabled.

Throws:

SAXException

format

public static String format(@Nullable
                            String input,
                            int indent)
                     throws IllegalArgumentException

Formats given XML String with the given indentation used. If the input XML string is null, or indent parameter is negative, or XML transformation fails, then the original value is returned unchanged. The IllegalArgumentException is thrown when indent==0.

Parameters:

input - the XML String

indent - indentation (number of spaces used for one indentation level)

Returns:

formatted XML String or the original String if the formatting fails.

Throws:

IllegalArgumentException - when indentation is equal to zero

getErrorListener

public ErrorListener getErrorListener()

Returns ErrorListener implementation which just throws the original error.