You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2026/08/28 18:43:54 UTC
(commons-xml) 05/17: Javadoc: "hardening" -> "secure/securing" wording to match new class and method names.
This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/commons-xml.git
commit 30634b636e533031ce0d87d63d2495e1f375bbaf
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Aug 28 14:33:36 2026 -0400
Javadoc: "hardening" -> "secure/securing" wording to match new class and
method names.
Rename test methods.
---
.../java/org/apache/commons/xml/SaxonProvider.java | 2 +-
.../commons/xml/SecureDocumentBuilderFactory.java | 18 +++++++++---------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/xml/SaxonProvider.java b/src/main/java/org/apache/commons/xml/SaxonProvider.java
index 0d85b3c..39f7a5c 100644
--- a/src/main/java/org/apache/commons/xml/SaxonProvider.java
+++ b/src/main/java/org/apache/commons/xml/SaxonProvider.java
@@ -52,7 +52,7 @@ final class SaxonProvider {
*
* <ol>
* <li><b>SAX layer.</b> {@link #makeParser} hands every {@link XMLReader} Saxon would otherwise use through
- * {@link SecureSAXParserFactory#secure(XMLReader)}, which routes it to the matching bundled hardening recipe. External DTDs, entities and XInclude
+ * {@link SecureSAXParserFactory#secure(XMLReader)}, which routes it to the matching bundled secure recipe. External DTDs, entities and XInclude
* resolve to empty content at parse time.</li>
* <li><b>Collection layer.</b> {@code fn:collection} bypasses the resource resolver and fetches directly, so an empty {@link CollectionFinder} supplies its
* ignore outcome instead.</li>
diff --git a/src/main/java/org/apache/commons/xml/SecureDocumentBuilderFactory.java b/src/main/java/org/apache/commons/xml/SecureDocumentBuilderFactory.java
index cfa7234..1f2e129 100644
--- a/src/main/java/org/apache/commons/xml/SecureDocumentBuilderFactory.java
+++ b/src/main/java/org/apache/commons/xml/SecureDocumentBuilderFactory.java
@@ -48,7 +48,7 @@
*/
public final class SecureDocumentBuilderFactory {
- /** Class name of Android's Harmony-based {@link DocumentBuilderFactory}, which exposes no hardening surface. */
+ /** Class name of Android's Harmony-based {@link DocumentBuilderFactory}, which exposes no secure surface. */
private static final String ANDROID_DOCUMENT_BUILDER_FACTORY = "org.apache.harmony.xml.parsers.DocumentBuilderFactoryImpl";
/** System property naming the {@link DocumentBuilderFactory} implementation, the JDK's own mechanism for reconfiguring the default parser. */
private static final String DOM_FACTORY_ID = "javax.xml.parsers.DocumentBuilderFactory";
@@ -59,7 +59,7 @@ public final class SecureDocumentBuilderFactory {
MethodType.methodType(DocumentBuilderFactory.class));
/**
- * Capability-driven hardening for any {@link DocumentBuilderFactory} on the classpath.
+ * Capability-driven secure for any {@link DocumentBuilderFactory} on the classpath.
*
* <p>Rather than branching on the implementation class, this method probes what the factory supports and adapts:</p>
* <ul>
@@ -109,7 +109,7 @@ private static DocumentBuilderFactory makeNSAware(final DocumentBuilderFactory f
* </p>
*
* @return A secure factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws FactoryConfigurationError Thrown if the running platform provides neither {@code newDefaultInstance()} nor the JDK's built-in implementation
* (for example Android).
*/
@@ -136,7 +136,7 @@ public static DocumentBuilderFactory newDefaultInstance() {
* {@link #newDefaultInstance()}, the behavior {@code DocumentBuilderFactory.newDefaultNSInstance()} (Java 13 or later) is specified to have.
*
* @return A hardened, namespace-aware factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws FactoryConfigurationError Thrown if the running platform provides neither {@code newDefaultInstance()} nor the JDK's built-in implementation
* (for example Android).
*/
@@ -148,7 +148,7 @@ public static DocumentBuilderFactory newDefaultNSInstance() {
* Returns a new, secure {@link DocumentBuilderFactory}.
*
* @return A secure factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws IllegalStateException Thrown if a (non-Andoid) factory cannot support the secure processing feature
* {@link XMLConstants#FEATURE_SECURE_PROCESSING}.
* @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service configuration error} or if the
@@ -164,7 +164,7 @@ public static DocumentBuilderFactory newInstance() {
* @param factoryClassName The fully qualified class name of the {@link DocumentBuilderFactory} implementation.
* @param classLoader The class loader used to load the factory class; {@code null} means the current thread's context class loader.
* @return A secure factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws IllegalStateException Thrown if a (non-Andoid) factory cannot support the secure processing feature
* {@link XMLConstants#FEATURE_SECURE_PROCESSING}.
* @throws FactoryConfigurationError Thrown if {@code factoryClassName} is {@code null} or the factory class cannot be loaded or instantiated.
@@ -178,7 +178,7 @@ public static DocumentBuilderFactory newInstance(final String factoryClassName,
* {@code DocumentBuilderFactory.newNSInstance()} (Java 13 or later) is specified to have.
*
* @return A hardened, namespace-aware factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service configuration error} or if the
* implementation is not available or cannot be instantiated.
*/
@@ -196,7 +196,7 @@ public static DocumentBuilderFactory newNSInstance() {
*
* @param overrideDefaultParser whether {@value SecureSAXParserFactory#OVERRIDE_DEFAULT_PARSER} on the originating factory asks to override the JDK's default parser.
* @return A hardened, namespace-aware factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws FactoryConfigurationError Thrown from a factory in case of a {@link java.util.ServiceConfigurationError service configuration error} or if the
* implementation is not available or cannot be instantiated.
*/
@@ -212,7 +212,7 @@ static DocumentBuilderFactory newNSInstance(final boolean overrideDefaultParser)
* @param factoryClassName The fully qualified class name of the {@link DocumentBuilderFactory} implementation.
* @param classLoader The class loader used to load the factory class; {@code null} means the current thread's context class loader.
* @return A hardened, namespace-aware factory.
- * @throws IllegalStateException Thrown if a required hardening setting cannot be applied to the underlying implementation.
+ * @throws IllegalStateException Thrown if a required secure setting cannot be applied to the underlying implementation.
* @throws FactoryConfigurationError Thrown if {@code factoryClassName} is {@code null} or the factory class cannot be loaded or instantiated.
*/
public static DocumentBuilderFactory newNSInstance(final String factoryClassName, final ClassLoader classLoader) {