001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.config.properties;
018
019import java.io.IOException;
020import java.io.InputStream;
021import java.util.Properties;
022
023import org.apache.logging.log4j.core.LoggerContext;
024import org.apache.logging.log4j.core.config.ConfigurationException;
025import org.apache.logging.log4j.core.config.ConfigurationFactory;
026import org.apache.logging.log4j.core.config.ConfigurationSource;
027import org.apache.logging.log4j.core.config.Order;
028import org.apache.logging.log4j.core.config.plugins.Plugin;
029
030/**
031 * Creates a PropertiesConfiguration from a properties file.
032 *
033 * @since 2.4
034 */
035@Plugin(name = "PropertiesConfigurationFactory", category = ConfigurationFactory.CATEGORY)
036@Order(8)
037public class PropertiesConfigurationFactory extends ConfigurationFactory {
038
039    @Override
040    protected String[] getSupportedTypes() {
041        return new String[] {".properties"};
042    }
043
044    @Override
045    public PropertiesConfiguration getConfiguration(final LoggerContext loggerContext, final ConfigurationSource source) {
046        final Properties properties = new Properties();
047        try (final InputStream configStream = source.getInputStream()) {
048            properties.load(configStream);
049        } catch (final IOException ioe) {
050            throw new ConfigurationException("Unable to load " + source.toString(), ioe);
051        }
052        return new PropertiesConfigurationBuilder()
053                .setConfigurationSource(source)
054                .setRootProperties(properties)
055                .setLoggerContext(loggerContext)
056                .build();
057    }
058}