com.helger.xml.serialize.read.DOMReaderSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-xml Show documentation
Show all versions of ph-xml Show documentation
Java 1.8+ Library with XML handling routines
/*
* Copyright (C) 2014-2023 Philip Helger (www.helger.com)
* philip[at]helger[dot]com
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.helger.xml.serialize.read;
import java.util.Locale;
import java.util.Map;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.NotThreadSafe;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.validation.Schema;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.EntityResolver;
import org.xml.sax.ErrorHandler;
import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.ReturnsMutableCopy;
import com.helger.commons.callback.CallbackList;
import com.helger.commons.callback.exception.IExceptionCallback;
import com.helger.commons.collection.impl.CommonsEnumMap;
import com.helger.commons.collection.impl.ICommonsMap;
import com.helger.commons.lang.ICloneable;
import com.helger.commons.string.ToStringGenerator;
import com.helger.xml.EXMLParserFeature;
import com.helger.xml.EXMLParserProperty;
import com.helger.xml.XMLFactory;
/**
* DOM reader settings
*
* @author Philip Helger
*/
@NotThreadSafe
public class DOMReaderSettings implements ICloneable , IDOMReaderSettings
{
private static final Logger LOGGER = LoggerFactory.getLogger (DOMReaderSettings.class);
// DocumentBuilderFactory properties
private boolean m_bNamespaceAware;
private boolean m_bValidating;
private boolean m_bIgnoringElementContentWhitespace;
private boolean m_bExpandEntityReferences;
private boolean m_bIgnoringComments;
private boolean m_bCoalescing;
private Schema m_aSchema;
private boolean m_bXIncludeAware;
private final ICommonsMap m_aProperties = new CommonsEnumMap <> (EXMLParserProperty.class);
private final ICommonsMap m_aFeatures = new CommonsEnumMap <> (EXMLParserFeature.class);
// DocumentBuilder properties
private EntityResolver m_aEntityResolver;
private ErrorHandler m_aErrorHandler;
// Handling properties
private final CallbackList > m_aExceptionCallbacks = new CallbackList <> ();
private boolean m_bRequiresNewXMLParserExplicitly;
/**
* Constructor using the default settings from
* {@link DOMReaderDefaultSettings}.
*/
public DOMReaderSettings ()
{
// DocumentBuilderFactory
setNamespaceAware (DOMReaderDefaultSettings.isNamespaceAware ());
setValidating (DOMReaderDefaultSettings.isValidating ());
setIgnoringElementContentWhitespace (DOMReaderDefaultSettings.isIgnoringElementContentWhitespace ());
setExpandEntityReferences (DOMReaderDefaultSettings.isExpandEntityReferences ());
setIgnoringComments (DOMReaderDefaultSettings.isIgnoringComments ());
setCoalescing (DOMReaderDefaultSettings.isCoalescing ());
setSchema (DOMReaderDefaultSettings.getSchema ());
setXIncludeAware (DOMReaderDefaultSettings.isXIncludeAware ());
setPropertyValues (DOMReaderDefaultSettings.getAllPropertyValues ());
setFeatureValues (DOMReaderDefaultSettings.getAllFeatureValues ());
// DocumentBuilder
setEntityResolver (DOMReaderDefaultSettings.getEntityResolver ());
setErrorHandler (DOMReaderDefaultSettings.getErrorHandler ());
// Custom
exceptionCallbacks ().set (DOMReaderDefaultSettings.exceptionCallbacks ());
setRequiresNewXMLParserExplicitly (DOMReaderDefaultSettings.isRequiresNewXMLParserExplicitly ());
}
/**
* Copy constructor.
*
* @param aOther
* The settings object to copy from. May not be null.
*/
public DOMReaderSettings (@Nonnull final IDOMReaderSettings aOther)
{
ValueEnforcer.notNull (aOther, "Other");
// DocumentBuilderFactory
setNamespaceAware (aOther.isNamespaceAware ());
setValidating (aOther.isValidating ());
setIgnoringElementContentWhitespace (aOther.isIgnoringElementContentWhitespace ());
setExpandEntityReferences (aOther.isExpandEntityReferences ());
setIgnoringComments (aOther.isIgnoringComments ());
setCoalescing (aOther.isCoalescing ());
setSchema (aOther.getSchema ());
setXIncludeAware (aOther.isXIncludeAware ());
setPropertyValues (aOther.getAllPropertyValues ());
setFeatureValues (aOther.getAllFeatureValues ());
// DocumentBuilder
setEntityResolver (aOther.getEntityResolver ());
setErrorHandler (aOther.getErrorHandler ());
// Custom
exceptionCallbacks ().set (aOther.exceptionCallbacks ());
setRequiresNewXMLParserExplicitly (aOther.isRequiresNewXMLParserExplicitly ());
}
public boolean isNamespaceAware ()
{
return m_bNamespaceAware;
}
@Nonnull
public final DOMReaderSettings setNamespaceAware (final boolean bNamespaceAware)
{
m_bNamespaceAware = bNamespaceAware;
return this;
}
public boolean isValidating ()
{
return m_bValidating;
}
@Nonnull
public final DOMReaderSettings setValidating (final boolean bValidating)
{
m_bValidating = bValidating;
return this;
}
public boolean isIgnoringElementContentWhitespace ()
{
return m_bIgnoringElementContentWhitespace;
}
@Nonnull
public final DOMReaderSettings setIgnoringElementContentWhitespace (final boolean bIgnoringElementContentWhitespace)
{
m_bIgnoringElementContentWhitespace = bIgnoringElementContentWhitespace;
return this;
}
public boolean isExpandEntityReferences ()
{
return m_bExpandEntityReferences;
}
@Nonnull
public final DOMReaderSettings setExpandEntityReferences (final boolean bExpandEntityReferences)
{
m_bExpandEntityReferences = bExpandEntityReferences;
return this;
}
public boolean isIgnoringComments ()
{
return m_bIgnoringComments;
}
@Nonnull
public final DOMReaderSettings setIgnoringComments (final boolean bIgnoringComments)
{
m_bIgnoringComments = bIgnoringComments;
return this;
}
public boolean isCoalescing ()
{
return m_bCoalescing;
}
@Nonnull
public final DOMReaderSettings setCoalescing (final boolean bCoalescing)
{
m_bCoalescing = bCoalescing;
return this;
}
@Nullable
public Schema getSchema ()
{
return m_aSchema;
}
@Nonnull
public final DOMReaderSettings setSchema (@Nullable final Schema aSchema)
{
m_aSchema = aSchema;
return this;
}
public boolean isXIncludeAware ()
{
return m_bXIncludeAware;
}
@Nonnull
public final DOMReaderSettings setXIncludeAware (final boolean bXIncludeAware)
{
m_bXIncludeAware = bXIncludeAware;
return this;
}
public boolean hasAnyProperties ()
{
return m_aProperties.isNotEmpty ();
}
@Nullable
public Object getPropertyValue (@Nullable final EXMLParserProperty eProperty)
{
return eProperty == null ? null : m_aProperties.get (eProperty);
}
@Nonnull
@ReturnsMutableCopy
public ICommonsMap getAllPropertyValues ()
{
return m_aProperties.getClone ();
}
@Nonnull
public final DOMReaderSettings setPropertyValue (@Nonnull final EXMLParserProperty eProperty,
@Nullable final Object aPropertyValue)
{
ValueEnforcer.notNull (eProperty, "Property");
if (aPropertyValue != null &&
eProperty.getValueClass () != null &&
!eProperty.getValueClass ().isAssignableFrom (aPropertyValue.getClass ()))
{
LOGGER.warn ("Setting the XML parser property '" +
eProperty +
"' to a value of " +
aPropertyValue.getClass () +
" will most likely not be interpreted!");
}
if (aPropertyValue != null)
m_aProperties.put (eProperty, aPropertyValue);
else
m_aProperties.remove (eProperty);
return this;
}
@Nonnull
public final DOMReaderSettings setPropertyValues (@Nullable final Map aProperties)
{
if (aProperties != null)
m_aProperties.putAll (aProperties);
return this;
}
@Nonnull
public final DOMReaderSettings removePropertyValue (@Nullable final EXMLParserProperty eProperty)
{
if (eProperty != null)
m_aProperties.removeObject (eProperty);
return this;
}
@Nonnull
public final DOMReaderSettings removeAllPropertyValues ()
{
m_aProperties.removeAll ();
return this;
}
@Nullable
public Locale getLocale ()
{
return (Locale) getPropertyValue (EXMLParserProperty.GENERAL_LOCALE);
}
@Nonnull
public DOMReaderSettings setLocale (@Nullable final Locale aLocale)
{
return setPropertyValue (EXMLParserProperty.GENERAL_LOCALE, aLocale);
}
public boolean hasAnyFeature ()
{
return m_aFeatures.isNotEmpty ();
}
@Nullable
public Boolean getFeatureValue (@Nullable final EXMLParserFeature eFeature)
{
return eFeature == null ? null : m_aFeatures.get (eFeature);
}
@Nonnull
@ReturnsMutableCopy
public ICommonsMap getAllFeatureValues ()
{
return m_aFeatures.getClone ();
}
@Nonnull
public final DOMReaderSettings setFeatureValue (@Nonnull final EXMLParserFeature eFeature, final boolean bValue)
{
ValueEnforcer.notNull (eFeature, "Feature");
m_aFeatures.put (eFeature, Boolean.valueOf (bValue));
return this;
}
@Nonnull
public final DOMReaderSettings setFeatureValue (@Nonnull final EXMLParserFeature eFeature,
@Nullable final Boolean aValue)
{
ValueEnforcer.notNull (eFeature, "Feature");
if (aValue == null)
m_aFeatures.remove (eFeature);
else
m_aFeatures.put (eFeature, aValue);
return this;
}
@Nonnull
public final DOMReaderSettings setFeatureValues (@Nullable final Map aValues)
{
if (aValues != null)
m_aFeatures.putAll (aValues);
return this;
}
@Nonnull
public final DOMReaderSettings removeFeature (@Nullable final EXMLParserFeature eFeature)
{
if (eFeature != null)
m_aFeatures.removeObject (eFeature);
return this;
}
@Nonnull
public final DOMReaderSettings removeFeatures (@Nullable final EXMLParserFeature... aFeatures)
{
if (aFeatures != null)
for (final EXMLParserFeature eFeature : aFeatures)
m_aFeatures.removeObject (eFeature);
return this;
}
@Nonnull
public final DOMReaderSettings removeAllFeatures ()
{
m_aFeatures.removeAll ();
return this;
}
public boolean requiresNewXMLParser ()
{
// Force a new XML parser?
if (m_bRequiresNewXMLParserExplicitly)
return true;
if (m_bNamespaceAware != XMLFactory.DEFAULT_DOM_NAMESPACE_AWARE ||
m_bValidating != XMLFactory.DEFAULT_DOM_VALIDATING ||
m_bIgnoringElementContentWhitespace != XMLFactory.DEFAULT_DOM_IGNORING_ELEMENT_CONTENT_WHITESPACE ||
m_bExpandEntityReferences != XMLFactory.DEFAULT_DOM_EXPAND_ENTITY_REFERENCES ||
m_bIgnoringComments != XMLFactory.DEFAULT_DOM_IGNORING_COMMENTS ||
m_bCoalescing != XMLFactory.DEFAULT_DOM_COALESCING ||
m_aSchema != null ||
m_bXIncludeAware != XMLFactory.DEFAULT_DOM_XINCLUDE_AWARE ||
m_aProperties.isNotEmpty () ||
m_aFeatures.isNotEmpty ())
return true;
// Special case for JDK > 1.7.0_45 because of maximum entity expansion
// See http://docs.oracle.com/javase/tutorial/jaxp/limits/limits.html
return m_aEntityResolver != null;
}
@Nullable
public EntityResolver getEntityResolver ()
{
return m_aEntityResolver;
}
@Nonnull
public final DOMReaderSettings setEntityResolver (@Nullable final EntityResolver aEntityResolver)
{
m_aEntityResolver = aEntityResolver;
return this;
}
@Nullable
public ErrorHandler getErrorHandler ()
{
return m_aErrorHandler;
}
@Nonnull
public final DOMReaderSettings setErrorHandler (@Nullable final ErrorHandler aErrorHandler)
{
m_aErrorHandler = aErrorHandler;
return this;
}
@Nonnull
public CallbackList > exceptionCallbacks ()
{
return m_aExceptionCallbacks;
}
public boolean isRequiresNewXMLParserExplicitly ()
{
return m_bRequiresNewXMLParserExplicitly;
}
@Nonnull
public final DOMReaderSettings setRequiresNewXMLParserExplicitly (final boolean bRequiresNewXMLParserExplicitly)
{
m_bRequiresNewXMLParserExplicitly = bRequiresNewXMLParserExplicitly;
return this;
}
@Nonnull
public DOMReaderSettings getClone ()
{
return new DOMReaderSettings (this);
}
public void applyToDocumentBuilderFactory (@Nonnull final DocumentBuilderFactory aDocumentBuilderFactory)
{
ValueEnforcer.notNull (aDocumentBuilderFactory, "DocumentBuilderFactory");
aDocumentBuilderFactory.setNamespaceAware (isNamespaceAware ());
aDocumentBuilderFactory.setValidating (isValidating ());
aDocumentBuilderFactory.setIgnoringElementContentWhitespace (isIgnoringElementContentWhitespace ());
aDocumentBuilderFactory.setExpandEntityReferences (isExpandEntityReferences ());
aDocumentBuilderFactory.setIgnoringComments (isIgnoringComments ());
aDocumentBuilderFactory.setCoalescing (isCoalescing ());
try
{
aDocumentBuilderFactory.setSchema (getSchema ());
}
catch (final UnsupportedOperationException ex)
{
LOGGER.warn ("DocumentBuilderFactory does not support XML Schema: " + ex.getMessage ());
}
try
{
aDocumentBuilderFactory.setXIncludeAware (isXIncludeAware ());
}
catch (final UnsupportedOperationException ex)
{
LOGGER.warn ("DocumentBuilderFactory does not support XInclude setting: " + ex.getMessage ());
}
// Apply properties
if (hasAnyProperties ())
for (final Map.Entry aEntry : getAllPropertyValues ().entrySet ())
aEntry.getKey ().applyTo (aDocumentBuilderFactory, aEntry.getValue ());
// Apply features
if (hasAnyFeature ())
for (final Map.Entry aEntry : getAllFeatureValues ().entrySet ())
aEntry.getKey ().applyTo (aDocumentBuilderFactory, aEntry.getValue ().booleanValue ());
}
public void applyToDocumentBuilder (@Nonnull final DocumentBuilder aDocumentBuilder)
{
ValueEnforcer.notNull (aDocumentBuilder, "DocumentBuilder");
// Set error handler
aDocumentBuilder.setErrorHandler (getErrorHandler ());
// Set optional entity resolver
aDocumentBuilder.setEntityResolver (getEntityResolver ());
}
@Override
public String toString ()
{
return new ToStringGenerator (this).append ("namespaceAware", m_bNamespaceAware)
.append ("validating", m_bValidating)
.append ("ignoringElementContentWhitespace", m_bIgnoringElementContentWhitespace)
.append ("expandEntityReferences", m_bExpandEntityReferences)
.append ("ignoringComments", m_bIgnoringComments)
.append ("coalescing", m_bCoalescing)
.append ("schema", m_aSchema)
.append ("XIncludeAware", m_bXIncludeAware)
.append ("properties", m_aProperties)
.append ("features", m_aFeatures)
.append ("entityResolver", m_aEntityResolver)
.append ("errorHandler", m_aErrorHandler)
.append ("exceptionCallbacks", m_aExceptionCallbacks)
.append ("requiresNewXMLParserExplicitly", m_bRequiresNewXMLParserExplicitly)
.getToString ();
}
}