russell@unturf.com
0a580b313d
Authors: russell@unturf.com · brackishbert@gmail.com · foxhop.net · TimeHexOn.com Patches, unit tests, benchmarks, whitepaper, and outreach briefs. Public domain — no copyright claimed. Use freely.
442 lines
15 KiB
Java
442 lines
15 KiB
Java
/*
|
|
* Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package jdk.xml.internal;
|
|
|
|
import javax.xml.XMLConstants;
|
|
import jdk.xml.internal.JdkProperty.ImplPropMap;
|
|
import jdk.xml.internal.JdkProperty.State;
|
|
import static jdk.xml.internal.JdkXmlUtils.SP_USE_CATALOG;
|
|
|
|
/**
|
|
* This class manages JDK's XML Features. Previously added features and properties
|
|
* may be gradually moved to this class.
|
|
*/
|
|
public class JdkXmlFeatures implements Cloneable {
|
|
public static final String ORACLE_JAXP_PROPERTY_PREFIX =
|
|
"http://www.oracle.com/xml/jaxp/properties/";
|
|
|
|
public static final String XML_FEATURE_MANAGER =
|
|
ORACLE_JAXP_PROPERTY_PREFIX + "XmlFeatureManager";
|
|
|
|
public static final String CATALOG_FEATURES = "javax.xml.catalog.catalogFeatures";
|
|
|
|
public final static String PROPERTY_USE_CATALOG = XMLConstants.USE_CATALOG;
|
|
|
|
public static enum XmlFeature {
|
|
/**
|
|
* Feature enableExtensionFunctions
|
|
* FSP: extension function is enforced by FSP. When FSP is on, extension
|
|
* function is disabled.
|
|
*/
|
|
ENABLE_EXTENSION_FUNCTION(ImplPropMap.ENABLEEXTFUNC, null, null, true,
|
|
null, null, false, false, true, true),
|
|
/**
|
|
* The {@link javax.xml.XMLConstants.USE_CATALOG} feature.
|
|
* FSP: USE_CATALOG is not enforced by FSP.
|
|
*/
|
|
USE_CATALOG(null, PROPERTY_USE_CATALOG, SP_USE_CATALOG, false,
|
|
null, null, true, false, true, false),
|
|
|
|
/**
|
|
* Feature resetSymbolTable
|
|
* FSP: RESET_SYMBOL_TABLE_FEATURE is not enforced by FSP.
|
|
*/
|
|
RESET_SYMBOL_TABLE_FEATURE(ImplPropMap.RESETSYMBOLTABLE, null, null, false,
|
|
null, null, false, false, true, false),
|
|
|
|
/**
|
|
* Feature overrideDefaultParser
|
|
* FSP: not enforced by FSP.
|
|
*/
|
|
JDK_OVERRIDE_PARSER(ImplPropMap.OVERRIDEPARSER, null, null, false,
|
|
null, null, false, false, true, false);
|
|
|
|
private final ImplPropMap implMap;
|
|
private final String name;
|
|
private final String nameSP;
|
|
private final boolean differ;
|
|
private final String nameOld;
|
|
private final String nameOldSP;
|
|
private final boolean valueDefault;
|
|
private final boolean valueEnforced;
|
|
private final boolean hasSystem;
|
|
private final boolean enforced;
|
|
|
|
/**
|
|
* Constructs an XmlFeature instance.
|
|
* @param implMap the Implementation specific properties map. When the
|
|
* map is specified, there is no need to repeat or enter other name
|
|
* parameters.
|
|
* @param name the name of the feature
|
|
* @param nameSP the name of the System Property
|
|
* @param nameOld the name of the corresponding legacy property
|
|
* @param nameOldSP the system property of the legacy property
|
|
* @param value the value of the feature
|
|
* @param hasSystem a flag to indicate whether the feature is supported
|
|
* @param enforced a flag indicating whether the feature is
|
|
* FSP (Feature_Secure_Processing) enforced
|
|
* with a System property
|
|
*/
|
|
XmlFeature(ImplPropMap implMap, String name, String nameSP, boolean differ,
|
|
String nameOld, String nameOldSP, boolean value, boolean valueEnforced,
|
|
boolean hasSystem, boolean enforced) {
|
|
this.implMap = implMap;
|
|
if (implMap != null) {
|
|
this.name = implMap.qName();
|
|
this.nameSP = implMap.systemProperty();
|
|
this.nameOld = implMap.qNameOld();
|
|
this.nameOldSP = implMap.systemPropertyOld();
|
|
} else {
|
|
this.name = name;
|
|
this.nameSP = nameSP;
|
|
this.nameOld = nameOld;
|
|
this.nameOldSP = nameOldSP;
|
|
}
|
|
this.differ = differ;
|
|
this.valueDefault = value;
|
|
this.valueEnforced = valueEnforced;
|
|
this.hasSystem = hasSystem;
|
|
this.enforced = enforced;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the specified property is equal to the current property.
|
|
* @param propertyName the name of a property
|
|
* @return true if the specified property is the current property, false
|
|
* otherwise
|
|
*/
|
|
boolean equalsPropertyName(String propertyName) {
|
|
if (implMap != null) {
|
|
return implMap.is(propertyName);
|
|
}
|
|
return name.equals(propertyName) ||
|
|
(nameOld != null && nameOld.equals(propertyName));
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the property.
|
|
*
|
|
* @return the name of the property
|
|
*/
|
|
public String apiProperty() {
|
|
return name;
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the corresponding System Property.
|
|
*
|
|
* @return the name of the System Property
|
|
*/
|
|
String systemProperty() {
|
|
return nameSP;
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the legacy System Property.
|
|
*
|
|
* @return the name of the legacy System Property
|
|
*/
|
|
String systemPropertyOld() {
|
|
return nameOldSP;
|
|
}
|
|
|
|
/**
|
|
* Returns the default value of the property.
|
|
* @return the default value of the property
|
|
*/
|
|
public boolean defaultValue() {
|
|
return valueDefault;
|
|
}
|
|
|
|
/**
|
|
* Returns the FSP-enforced value.
|
|
* @return the FSP-enforced value
|
|
*/
|
|
public boolean enforcedValue() {
|
|
return valueEnforced;
|
|
}
|
|
|
|
/**
|
|
* Checks whether System property is supported for the feature.
|
|
* @return true it is supported, false otherwise
|
|
*/
|
|
boolean hasSystemProperty() {
|
|
return hasSystem;
|
|
}
|
|
|
|
/**
|
|
* Checks whether the property is enforced by FSP
|
|
* @return true it is, false otherwise
|
|
*/
|
|
boolean enforced() {
|
|
return enforced;
|
|
}
|
|
|
|
/**
|
|
* Returns the state of a property name. By the specification as of JDK 17,
|
|
* the "jdk.xml." prefixed System property name is also the current API
|
|
* name. Both the URI-based qName and old name if any are legacy.
|
|
*
|
|
* @param name the property name
|
|
* @return the state of the property name, null if no match
|
|
*/
|
|
public State getState(String name) {
|
|
if (implMap != null) {
|
|
return implMap.getState(name);
|
|
} else if (this.name.equals(name)) {
|
|
return State.APIPROPERTY;
|
|
}
|
|
return null;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Values of the features
|
|
*/
|
|
private boolean[] featureValues;
|
|
|
|
/**
|
|
* States of the settings for each property
|
|
*/
|
|
private State[] states;
|
|
|
|
/**
|
|
* Flag indicating if secure processing is set
|
|
*/
|
|
boolean secureProcessing;
|
|
|
|
/**
|
|
* Instantiate JdkXmlFeatures and initialize the fields
|
|
* @param secureProcessing
|
|
*/
|
|
public JdkXmlFeatures(boolean secureProcessing) {
|
|
featureValues = new boolean[XmlFeature.values().length];
|
|
states = new State[XmlFeature.values().length];
|
|
this.secureProcessing = secureProcessing;
|
|
for (XmlFeature f : XmlFeature.values()) {
|
|
if (secureProcessing && f.enforced()) {
|
|
featureValues[f.ordinal()] = f.enforcedValue();
|
|
states[f.ordinal()] = State.FSP;
|
|
} else {
|
|
featureValues[f.ordinal()] = f.defaultValue();
|
|
states[f.ordinal()] = State.DEFAULT;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a copy of the JdkXmlFeatures.
|
|
* @return a copy of the JdkXmlFeatures
|
|
*/
|
|
public JdkXmlFeatures clone() {
|
|
try {
|
|
JdkXmlFeatures copy = (JdkXmlFeatures) super.clone();
|
|
copy.featureValues = this.featureValues.clone();
|
|
copy.states = this.states.clone();
|
|
return copy;
|
|
} catch (CloneNotSupportedException e) {
|
|
// shouldn't happen as this class is Cloneable
|
|
throw new InternalError(e);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a copy of the JdkXmlFeatures that is updated with the
|
|
* current System Properties.
|
|
* @return a copy of the JdkXmlFeatures
|
|
*/
|
|
public JdkXmlFeatures cloneAndUpdate() {
|
|
JdkXmlFeatures copy = clone();
|
|
copy.readSystemProperties();
|
|
return copy;
|
|
}
|
|
|
|
/**
|
|
* Updates the JdkXmlFeatures instance by reading the system properties again.
|
|
* This will become necessary in case the system properties are set after
|
|
* the instance has been created.
|
|
*/
|
|
public void update() {
|
|
readSystemProperties();
|
|
}
|
|
|
|
/**
|
|
* Set feature by property name and state
|
|
* @param propertyName property name
|
|
* @param state the state of the property
|
|
* @param value the value of the property
|
|
* @return true if the property is managed by the JdkXmlFeatures instance;
|
|
* false otherwise.
|
|
*/
|
|
public boolean setFeature(String propertyName, State state, Object value) {
|
|
State pState = state;
|
|
XmlFeature f = findByName(propertyName);
|
|
// if the feature is managed by JdkXmlFeatures
|
|
if (f != null) {
|
|
// if it's set from an API, get the correct state
|
|
if (state == State.APIPROPERTY) {
|
|
pState = f.getState(propertyName);
|
|
}
|
|
if (pState != null) {
|
|
setFeature(f.ordinal(), pState, value);
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Set the value for a specific feature.
|
|
*
|
|
* @param feature the feature
|
|
* @param state the state of the property
|
|
* @param value the value of the property
|
|
*/
|
|
public void setFeature(XmlFeature feature, State state, boolean value) {
|
|
setFeature(feature.ordinal(), state, value);
|
|
}
|
|
|
|
/**
|
|
* Return the value of the specified property
|
|
*
|
|
* @param feature the property
|
|
* @return the value of the property
|
|
*/
|
|
public boolean getFeature(XmlFeature feature) {
|
|
return featureValues[feature.ordinal()];
|
|
}
|
|
|
|
/**
|
|
* Return the value of a feature by its index (the Feature's ordinal)
|
|
* @param index the index of a feature
|
|
* @return value of a feature
|
|
*/
|
|
public boolean getFeature(int index) {
|
|
return featureValues[index];
|
|
}
|
|
|
|
/**
|
|
* Set the value of a property by its index
|
|
*
|
|
* @param index the index of the property
|
|
* @param state the state of the property
|
|
* @param value the value of the property
|
|
*/
|
|
public void setFeature(int index, State state, Object value) {
|
|
boolean temp;
|
|
if (value instanceof Boolean) {
|
|
temp = (Boolean)value;
|
|
} else {
|
|
temp = Boolean.parseBoolean((String) value);
|
|
}
|
|
setFeature(index, state, temp);
|
|
}
|
|
|
|
/**
|
|
* Set the value of a property by its index
|
|
*
|
|
* @param index the index of the property
|
|
* @param state the state of the property
|
|
* @param value the value of the property
|
|
*/
|
|
public void setFeature(int index, State state, boolean value) {
|
|
//only update if it shall override
|
|
if (state.compareTo(states[index]) >= 0) {
|
|
featureValues[index] = value;
|
|
states[index] = state;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Finds the feature by string name.
|
|
*
|
|
* @param propertyName property name
|
|
* @return the feature if found; null otherwise
|
|
*/
|
|
public XmlFeature findByName(String propertyName) {
|
|
for (XmlFeature feature : XmlFeature.values()) {
|
|
if (feature.equalsPropertyName(propertyName)) {
|
|
return feature;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get the index by property name
|
|
*
|
|
* @param propertyName property name
|
|
* @return the index of the property if found; return -1 if not
|
|
*/
|
|
public int getIndex(String propertyName) {
|
|
for (XmlFeature feature : XmlFeature.values()) {
|
|
if (feature.equalsPropertyName(propertyName)) {
|
|
//internally, ordinal is used as index
|
|
return feature.ordinal();
|
|
}
|
|
}
|
|
return -1;
|
|
}
|
|
|
|
/**
|
|
* Read from system properties, or those in jaxp.properties
|
|
*/
|
|
private void readSystemProperties() {
|
|
for (XmlFeature feature : XmlFeature.values()) {
|
|
getSystemProperty(feature, feature.systemProperty());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Read the system property, or the setting in the Jaxp Configuration File
|
|
* corresponding to the XmlFeature.
|
|
*
|
|
* @param feature the XmlFeature
|
|
* @param sysPropertyName the corresponding system property
|
|
* @return true if the system property is found, false otherwise
|
|
*/
|
|
private boolean getSystemProperty(XmlFeature feature, String sysPropertyName) {
|
|
String value = System.getProperty(sysPropertyName);
|
|
if (value == null && feature.systemPropertyOld() != null) {
|
|
// legacy system property
|
|
value = System.getProperty(feature.systemPropertyOld());
|
|
}
|
|
|
|
if (value != null && !value.isEmpty()) {
|
|
setFeature(feature, State.SYSTEMPROPERTY, Boolean.parseBoolean(value));
|
|
return true;
|
|
}
|
|
|
|
value = SecuritySupport.readConfig(sysPropertyName);
|
|
if (value != null && !value.isEmpty()) {
|
|
setFeature(feature, State.JAXPDOTPROPERTIES, Boolean.parseBoolean(value));
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
}
|