org.springframework.boot.context.properties.source.ConfigurationPropertyCaching Maven / Gradle / Ivy
/*
* Copyright 2012-2020 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.source;
import java.time.Duration;
import org.springframework.core.env.Environment;
import org.springframework.util.Assert;
/**
* Interface that can be used to control configuration property source caches.
*
* @author Phillip Webb
* @since 2.3.0
*/
public interface ConfigurationPropertyCaching {
/**
* Enable caching with an unlimited time-to-live.
*/
void enable();
/**
* Disable caching.
*/
void disable();
/**
* Set amount of time that an item can live in the cache. Calling this method will
* also enable the cache.
* @param timeToLive the time to live value.
*/
void setTimeToLive(Duration timeToLive);
/**
* Clear the cache and force it to be reloaded on next access.
*/
void clear();
/**
* Get for all configuration property sources in the environment.
* @param environment the spring environment
* @return a caching instance that controls all sources in the environment
*/
static ConfigurationPropertyCaching get(Environment environment) {
return get(environment, null);
}
/**
* Get for a specific configuration property source in the environment.
* @param environment the spring environment
* @param underlyingSource the
* {@link ConfigurationPropertySource#getUnderlyingSource() underlying source} that
* must match
* @return a caching instance that controls the matching source
*/
static ConfigurationPropertyCaching get(Environment environment, Object underlyingSource) {
Iterable sources = ConfigurationPropertySources.get(environment);
return get(sources, underlyingSource);
}
/**
* Get for all specified configuration property sources.
* @param sources the configuration property sources
* @return a caching instance that controls the sources
*/
static ConfigurationPropertyCaching get(Iterable sources) {
return get(sources, null);
}
/**
* Get for a specific configuration property source in the specified configuration
* property sources.
* @param sources the configuration property sources
* @param underlyingSource the
* {@link ConfigurationPropertySource#getUnderlyingSource() underlying source} that
* must match
* @return a caching instance that controls the matching source
*/
static ConfigurationPropertyCaching get(Iterable sources, Object underlyingSource) {
Assert.notNull(sources, "Sources must not be null");
if (underlyingSource == null) {
return new ConfigurationPropertySourcesCaching(sources);
}
for (ConfigurationPropertySource source : sources) {
if (source.getUnderlyingSource() == underlyingSource) {
ConfigurationPropertyCaching caching = CachingConfigurationPropertySource.find(source);
if (caching != null) {
return caching;
}
}
}
throw new IllegalStateException("Unable to find cache from configuration property sources");
}
}