org.springframework.boot.context.properties.bind.handler.NoUnboundElementsBindHandler Maven / Gradle / Ivy
/*
* Copyright 2012-2019 the original author or authors.
*
* 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
*
* https://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.springframework.boot.context.properties.bind.handler;
import java.util.HashSet;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Function;
import org.springframework.boot.context.properties.bind.AbstractBindHandler;
import org.springframework.boot.context.properties.bind.BindContext;
import org.springframework.boot.context.properties.bind.BindHandler;
import org.springframework.boot.context.properties.bind.Bindable;
import org.springframework.boot.context.properties.bind.UnboundConfigurationPropertiesException;
import org.springframework.boot.context.properties.source.ConfigurationProperty;
import org.springframework.boot.context.properties.source.ConfigurationPropertyName;
import org.springframework.boot.context.properties.source.ConfigurationPropertySource;
import org.springframework.boot.context.properties.source.IterableConfigurationPropertySource;
/**
* {@link BindHandler} to enforce that all configuration properties under the root name
* have been bound.
*
* @author Phillip Webb
* @author Madhura Bhave
* @since 2.0.0
*/
public class NoUnboundElementsBindHandler extends AbstractBindHandler {
private final Set boundNames = new HashSet<>();
private final Function filter;
NoUnboundElementsBindHandler() {
this(BindHandler.DEFAULT, (configurationPropertySource) -> true);
}
public NoUnboundElementsBindHandler(BindHandler parent) {
this(parent, (configurationPropertySource) -> true);
}
public NoUnboundElementsBindHandler(BindHandler parent,
Function filter) {
super(parent);
this.filter = filter;
}
@Override
public Object onSuccess(ConfigurationPropertyName name, Bindable target,
BindContext context, Object result) {
this.boundNames.add(name);
return super.onSuccess(name, target, context, result);
}
@Override
public void onFinish(ConfigurationPropertyName name, Bindable target,
BindContext context, Object result) throws Exception {
if (context.getDepth() == 0) {
checkNoUnboundElements(name, context);
}
}
private void checkNoUnboundElements(ConfigurationPropertyName name,
BindContext context) {
Set unbound = new TreeSet<>();
for (ConfigurationPropertySource source : context.getSources()) {
if (source instanceof IterableConfigurationPropertySource
&& this.filter.apply(source)) {
collectUnbound(name, unbound,
(IterableConfigurationPropertySource) source);
}
}
if (!unbound.isEmpty()) {
throw new UnboundConfigurationPropertiesException(unbound);
}
}
private void collectUnbound(ConfigurationPropertyName name,
Set unbound,
IterableConfigurationPropertySource source) {
IterableConfigurationPropertySource filtered = source
.filter((candidate) -> isUnbound(name, candidate));
for (ConfigurationPropertyName unboundName : filtered) {
try {
unbound.add(source.filter((candidate) -> isUnbound(name, candidate))
.getConfigurationProperty(unboundName));
}
catch (Exception ex) {
}
}
}
private boolean isUnbound(ConfigurationPropertyName name,
ConfigurationPropertyName candidate) {
if (name.isAncestorOf(candidate)) {
if (!this.boundNames.contains(candidate)
&& !isOverriddenCollectionElement(candidate)) {
return true;
}
}
return false;
}
private boolean isOverriddenCollectionElement(ConfigurationPropertyName candidate) {
int length = candidate.getNumberOfElements();
if (candidate.isNumericIndex(length - 1)) {
ConfigurationPropertyName propertyName = candidate
.chop(candidate.getNumberOfElements() - 1);
return this.boundNames.contains(propertyName);
}
return false;
}
}