com.hazelcast.config.FileSystemXmlConfig 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.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;
import java.util.Properties;
import static com.hazelcast.internal.util.Preconditions.checkTrue;
/**
* A {@link Config} which includes functionality for loading itself from an
* XML configuration file.
*
* Unlike {@link Config#loadFromFile(File)} and its variants, a configuration constructed via
* {@code FileSystemXmlConfig} does not apply overrides found in environment variables/system properties.
*/
public class FileSystemXmlConfig extends Config {
private static final ILogger LOGGER = Logger.getLogger(FileSystemXmlConfig.class);
/**
* Creates a Config based on a Hazelcast xml file and uses the System.properties to resolve
* variables in the XML.
*
* @param configFilename the path of the Hazelcast xml configuration file
* @throws NullPointerException if configFilename is {@code null}
* @throws FileNotFoundException if the file is not found
* @throws InvalidConfigurationException if the XML content is invalid
*/
public FileSystemXmlConfig(String configFilename) throws FileNotFoundException {
this(configFilename, System.getProperties());
}
/**
* Creates a Config based on a Hazelcast XML file.
*
* @param configFilename the path of the Hazelcast XML configuration file
* @param properties the Properties to resolve variables in the XML
* @throws FileNotFoundException if the file is not found
* @throws NullPointerException if configFilename is {@code null}
* @throws IllegalArgumentException if properties is {@code null}
* @throws InvalidConfigurationException if the XML content is invalid
*/
public FileSystemXmlConfig(String configFilename, Properties properties) throws FileNotFoundException {
this(new File(configFilename), properties);
}
/**
* Creates a Config based on a Hazelcast xml file and uses the System.properties to resolve
* variables in the XML.
*
* @param configFile the path of the Hazelcast XML configuration file
* @throws FileNotFoundException if the file doesn't exist
* @throws InvalidConfigurationException if the XML content is invalid
*/
public FileSystemXmlConfig(File configFile) throws FileNotFoundException {
this(configFile, System.getProperties());
}
/**
* Creates a Config based on a Hazelcast XML file.
*
* @param configFile the path of the Hazelcast xml configuration file
* @param properties the Properties to resolve variables in the XML
* @throws IllegalArgumentException if configFile or properties is {@code null}
* @throws FileNotFoundException if the file doesn't exist
* @throws InvalidConfigurationException if the XML content is invalid
*/
public FileSystemXmlConfig(File configFile, Properties properties) throws FileNotFoundException {
checkTrue(configFile != null, "configFile can't be null");
checkTrue(properties != null, "properties can't be null");
LOGGER.info("Configuring Hazelcast from '" + configFile.getAbsolutePath() + "'.");
InputStream in = new FileInputStream(configFile);
new XmlConfigBuilder(in).setProperties(properties).build(this);
}
}