com.hazelcast.config.ClasspathYamlConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.config;
import com.hazelcast.logging.ILogger;
import com.hazelcast.logging.Logger;
import java.io.InputStream;
import java.util.Properties;
import static com.hazelcast.internal.util.Preconditions.checkTrue;
/**
* A {@link Config} which is initialized by loading a YAML configuration file from the classpath.
*
* Unlike {@link Config#loadFromClasspath(ClassLoader, String)} and its variants, a configuration constructed via
* {@code ClasspathYamlConfig} does not apply overrides found in environment variables/system properties.
*
* @see FileSystemYamlConfig
*/
public class ClasspathYamlConfig extends Config {
private static final ILogger LOGGER = Logger.getLogger(ClasspathYamlConfig.class);
/**
* Creates a config which is loaded from a classpath resource using the
* {@link Thread#currentThread} contextClassLoader. The System.properties are used to resolve variables
* in the YAML.
*
* @param resource the resource, a YAML configuration file from the classpath,
* without the "classpath:" prefix
* @throws IllegalArgumentException if the resource could not be found
* @throws InvalidConfigurationException if the YAML content is invalid
*/
public ClasspathYamlConfig(String resource) {
this(resource, System.getProperties());
}
/**
* Creates a config which is loaded from a classpath resource using the
* {@link Thread#currentThread} contextClassLoader.
*
* @param resource the resource, a YAML configuration file from the classpath,
* without the "classpath:" prefix
* @param properties the Properties to resolve variables in the YAML
* @throws IllegalArgumentException if the resource could not be found or if properties is {@code null}
* @throws InvalidConfigurationException if the YAML content is invalid
*/
public ClasspathYamlConfig(String resource, Properties properties) {
this(Thread.currentThread().getContextClassLoader(), resource, properties);
}
/**
* Creates a config which is loaded from a classpath resource. The System.properties are used to
* resolve variables in the YAML.
*
* @param classLoader the ClassLoader used to load the resource
* @param resource the resource, a YAML configuration file from the classpath,
* without the "classpath:" prefix
* @throws IllegalArgumentException if classLoader or resource is {@code null}, or if the resource is not found
* @throws InvalidConfigurationException if the YAML content is invalid
*/
public ClasspathYamlConfig(ClassLoader classLoader, String resource) {
this(classLoader, resource, System.getProperties());
}
/**
* Creates a config which is loaded from a classpath resource.
*
* @param classLoader the ClassLoader used to load the resource
* @param resource the resource, a YAML configuration file from the classpath,
* without the "classpath:" prefix
* @param properties the properties used to resolve variables in the YAML
* @throws IllegalArgumentException if classLoader or resource is {@code null}, or if the resource is not found
* @throws InvalidConfigurationException if the YAML content is invalid
*/
public ClasspathYamlConfig(ClassLoader classLoader, String resource, Properties properties) {
checkTrue(classLoader != null, "classLoader can't be null");
checkTrue(resource != null, "resource can't be null");
checkTrue(properties != null, "properties can't be null");
LOGGER.info("Configuring Hazelcast from '" + resource + "'.");
InputStream in = classLoader.getResourceAsStream(resource);
checkTrue(in != null, "Specified resource '" + resource + "' could not be found!");
new YamlConfigBuilder(in).setProperties(properties).build(this);
}
}