[java-opensaml] 03/03: OSJ-386: Update ConfigurationPropertiesSource to return a custom type
Brent Putman
putmanb at georgetown.edu
Fri Aug 25 03:15:33 UTC 2023
This is an automated email from the git hooks/post-receive script.
putmanb pushed a commit to branch main
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=3f83bdf47c9fe9bd43dd97244530cfee4c3bf1a3
commit 3f83bdf47c9fe9bd43dd97244530cfee4c3bf1a3
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Thu Aug 24 22:45:22 2023 -0400
OSJ-386: Update ConfigurationPropertiesSource to return a custom type
With the new ConfigurationProperties type, change contract to non-null
so is nicer for callers.
---
.../opensaml/core/config/ConfigurationService.java | 23 ++++++------
.../provider/EmptyConfigurationProperties.java | 41 ++++++++++++++++++++++
.../core/xml/io/AbstractXMLObjectUnmarshaller.java | 4 +--
.../GlobalNamedCurveRegistryInitializer.java | 5 ++-
.../config/impl/ApacheXMLSecurityInitializer.java | 5 ++-
.../DefaultSecurityConfigurationBootstrap.java | 3 +-
.../impl/JavaCryptoValidationInitializer.java | 5 ++-
.../impl/provider/ApacheSantuarioXMLParser.java | 6 ++--
8 files changed, 65 insertions(+), 27 deletions(-)
diff --git a/opensaml-core-api/src/main/java/org/opensaml/core/config/ConfigurationService.java b/opensaml-core-api/src/main/java/org/opensaml/core/config/ConfigurationService.java
index 21777ae6d..3b0bb975e 100644
--- a/opensaml-core-api/src/main/java/org/opensaml/core/config/ConfigurationService.java
+++ b/opensaml-core-api/src/main/java/org/opensaml/core/config/ConfigurationService.java
@@ -15,12 +15,15 @@
package org.opensaml.core.config;
import java.util.Iterator;
+import java.util.Properties;
import java.util.ServiceLoader;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
+import org.opensaml.core.config.provider.EmptyConfigurationProperties;
import org.opensaml.core.config.provider.MapBasedConfiguration;
+import org.opensaml.core.config.provider.PropertiesAdapter;
import org.opensaml.core.config.provider.SystemPropertyConfigurationPropertiesSource;
import org.slf4j.Logger;
@@ -165,7 +168,10 @@ public class ConfigurationService {
* <p>
* If properties sources are configured via the Java Services API, then those are
* evaluated in order, and the first non-null properties set returned is used.
- * If no configured sources return a properties set, then null is returned.
+ * </p>
+ *
+ * <p>
+ * If no configured sources return a properties set, then an empty properties set is returned.
* </p>
*
* <p>
@@ -175,7 +181,7 @@ public class ConfigurationService {
*
* @return the set of configuration meta-properties
*/
- @Nullable public static ConfigurationProperties getConfigurationProperties() {
+ @Nonnull public static ConfigurationProperties getConfigurationProperties() {
final ConfigurationPropertiesSource defaultSource = defaultConfigurationPropertiesSource;
if (defaultSource != null) {
final ConfigurationProperties props = defaultSource.getProperties();
@@ -195,7 +201,9 @@ public class ConfigurationService {
if (!iter.hasNext()) {
LOG.trace("No ConfigurationPropertiesSources are configured, defaulting to system properties");
- return new SystemPropertyConfigurationPropertiesSource().getProperties();
+ // This shouldn't happen but have to satisfy the non-null contract.
+ final Properties systemProps = System.getProperties();
+ return systemProps != null ? new PropertiesAdapter(systemProps) : new EmptyConfigurationProperties();
}
while (iter.hasNext()) {
@@ -209,7 +217,7 @@ public class ConfigurationService {
}
}
LOG.trace("Unable to resolve non-null configuration properties from any ConfigurationPropertiesSource");
- return null;
+ return new EmptyConfigurationProperties();
}
/**
@@ -272,12 +280,7 @@ public class ConfigurationService {
*/
@Nonnull @NotEmpty protected static String getPartitionName() {
final ConfigurationProperties configProperties = getConfigurationProperties();
- String partitionName = null;
- if (configProperties != null) {
- partitionName = configProperties.getProperty(PROPERTY_PARTITION_NAME, DEFAULT_PARTITION_NAME);
- } else {
- partitionName = DEFAULT_PARTITION_NAME;
- }
+ String partitionName = configProperties.getProperty(PROPERTY_PARTITION_NAME, DEFAULT_PARTITION_NAME);
LOG.trace("Resolved effective configuration partition name '{}'", partitionName);
return partitionName;
}
diff --git a/opensaml-core-api/src/main/java/org/opensaml/core/config/provider/EmptyConfigurationProperties.java b/opensaml-core-api/src/main/java/org/opensaml/core/config/provider/EmptyConfigurationProperties.java
new file mode 100644
index 000000000..3510dc4a6
--- /dev/null
+++ b/opensaml-core-api/src/main/java/org/opensaml/core/config/provider/EmptyConfigurationProperties.java
@@ -0,0 +1,41 @@
+/*
+ * 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 org.opensaml.core.config.provider;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import org.opensaml.core.config.ConfigurationProperties;
+
+/**
+ * An implementation of {@link ConfigurationProperties} that is empty.
+ */
+public class EmptyConfigurationProperties implements ConfigurationProperties {
+
+ /** {@inheritDoc} */
+ @Override
+ @Nullable
+ public String getProperty(@Nonnull final String key) {
+ return null;
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ @Nonnull
+ public String getProperty(@Nonnull final String key, @Nonnull final String defaultValue) {
+ return defaultValue;
+ }
+
+}
diff --git a/opensaml-core-api/src/main/java/org/opensaml/core/xml/io/AbstractXMLObjectUnmarshaller.java b/opensaml-core-api/src/main/java/org/opensaml/core/xml/io/AbstractXMLObjectUnmarshaller.java
index 2ce203f24..85d5dd019 100644
--- a/opensaml-core-api/src/main/java/org/opensaml/core/xml/io/AbstractXMLObjectUnmarshaller.java
+++ b/opensaml-core-api/src/main/java/org/opensaml/core/xml/io/AbstractXMLObjectUnmarshaller.java
@@ -102,8 +102,8 @@ public abstract class AbstractXMLObjectUnmarshaller implements Unmarshaller {
unmarshallerFactory = XMLObjectProviderRegistrySupport.getUnmarshallerFactory();
final ConfigurationProperties props = ConfigurationService.getConfigurationProperties();
- strictMode = (props != null) ? Boolean.parseBoolean(props.getProperty(CONFIG_PROPERTY_XML_STRICT_MODE, "true"))
- : true;
+ strictMode = Boolean.parseBoolean(props.getProperty(CONFIG_PROPERTY_XML_STRICT_MODE, "true"));
+
}
/** {@inheritDoc} */
diff --git a/opensaml-security-api/src/main/java/org/opensaml/security/config/GlobalNamedCurveRegistryInitializer.java b/opensaml-security-api/src/main/java/org/opensaml/security/config/GlobalNamedCurveRegistryInitializer.java
index d8ca68133..c9db76dc7 100644
--- a/opensaml-security-api/src/main/java/org/opensaml/security/config/GlobalNamedCurveRegistryInitializer.java
+++ b/opensaml-security-api/src/main/java/org/opensaml/security/config/GlobalNamedCurveRegistryInitializer.java
@@ -70,9 +70,8 @@ public class GlobalNamedCurveRegistryInitializer implements Initializer {
}
final ConfigurationProperties props = ConfigurationService.getConfigurationProperties();
- final boolean registerBCCurves =
- (props != null) ? Boolean.parseBoolean(props.getProperty(CONFIG_PROPERTY_REGISTER_BOUNCY_CASTLE_CURVES))
- : false;
+ final boolean registerBCCurves = Boolean.parseBoolean(
+ props.getProperty(CONFIG_PROPERTY_REGISTER_BOUNCY_CASTLE_CURVES));
if (registerBCCurves) {
// Don't register if already done above. Use the OID as the canonical unique identifier. Names may differ.
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/ApacheXMLSecurityInitializer.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/ApacheXMLSecurityInitializer.java
index b7f66dbc8..483c5d35b 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/ApacheXMLSecurityInitializer.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/ApacheXMLSecurityInitializer.java
@@ -48,9 +48,8 @@ public class ApacheXMLSecurityInitializer implements Initializer {
}
final ConfigurationProperties props = ConfigurationService.getConfigurationProperties();
- final boolean enableXMLParser =
- (props != null) ? Boolean.parseBoolean(props.getProperty(CONFIG_PROPERTY_XML_PARSER_ENABLE, "true"))
- : true;
+ final boolean enableXMLParser = Boolean.parseBoolean(
+ props.getProperty(CONFIG_PROPERTY_XML_PARSER_ENABLE, "true"));
if (enableXMLParser) {
final String xmlParserPropName = "org.apache.xml.security.XMLParser";
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/DefaultSecurityConfigurationBootstrap.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/DefaultSecurityConfigurationBootstrap.java
index 576c95f2d..ff0f930c4 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/DefaultSecurityConfigurationBootstrap.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/DefaultSecurityConfigurationBootstrap.java
@@ -146,8 +146,7 @@ public class DefaultSecurityConfigurationBootstrap {
final KeyAgreementEncryptionConfiguration ecConfig = new KeyAgreementEncryptionConfiguration();
ecConfig.setAlgorithm(EncryptionConstants.ALGO_ID_KEYAGREEMENT_ECDH_ES);
- final String ecKDF =
- props != null ? props.getProperty(CONFIG_PROPERTY_ECDH_DEFAULT_KDF, CONCATKDF) : CONCATKDF;
+ final String ecKDF = props.getProperty(CONFIG_PROPERTY_ECDH_DEFAULT_KDF, CONCATKDF);
if (CONCATKDF.equals(ecKDF)) {
final ConcatKDF ecConcatKDF = new ConcatKDF();
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/JavaCryptoValidationInitializer.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/JavaCryptoValidationInitializer.java
index 23cb92e06..2b91b9ea1 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/JavaCryptoValidationInitializer.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/config/impl/JavaCryptoValidationInitializer.java
@@ -80,9 +80,8 @@ public class JavaCryptoValidationInitializer implements Initializer {
if (!valid) {
final ConfigurationProperties props = ConfigurationService.getConfigurationProperties();
- final String isFatal =
- (props != null) ? props.getProperty(CONFIG_PROPERTY_FAIL_IS_FATAL, "false") : "false";
- if ("true".equalsIgnoreCase(isFatal) || "1".equals(isFatal)) {
+ final Boolean isFatal = Boolean.parseBoolean(props.getProperty(CONFIG_PROPERTY_FAIL_IS_FATAL, "false"));
+ if (isFatal) {
log.warn("Configuration indicates an invalid crypto configuration should be fatal");
throw new InitializationException(
"A fatal error was encountered validating required crypto capabilities");
diff --git a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/provider/ApacheSantuarioXMLParser.java b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/provider/ApacheSantuarioXMLParser.java
index ccbeb0138..f9df3eaa3 100644
--- a/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/provider/ApacheSantuarioXMLParser.java
+++ b/opensaml-xmlsec-impl/src/main/java/org/opensaml/xmlsec/impl/provider/ApacheSantuarioXMLParser.java
@@ -84,10 +84,8 @@ public class ApacheSantuarioXMLParser implements XMLParser {
} else {
try {
final ConfigurationProperties props = ConfigurationService.getConfigurationProperties();
- final int maxPoolSize =
- (props != null) ? Integer.parseUnsignedInt(
- props.getProperty(CONFIG_PROPERTY_MAX_POOL_SIZE, "50"))
- : 50;
+ final int maxPoolSize = Integer.parseUnsignedInt(
+ props.getProperty(CONFIG_PROPERTY_MAX_POOL_SIZE, "50"));
final BasicParserPool basicPool = new BasicParserPool();
basicPool.setMaxPoolSize(maxPoolSize);
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list