View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.config.properties;
18  
19  import java.io.IOException;
20  import java.io.InputStream;
21  import java.util.Properties;
22  
23  import org.apache.logging.log4j.core.LoggerContext;
24  import org.apache.logging.log4j.core.config.ConfigurationException;
25  import org.apache.logging.log4j.core.config.ConfigurationFactory;
26  import org.apache.logging.log4j.core.config.ConfigurationSource;
27  import org.apache.logging.log4j.core.config.Order;
28  import org.apache.logging.log4j.core.config.plugins.Plugin;
29  
30  /**
31   * Creates a PropertiesConfiguration from a properties file.
32   *
33   * @since 2.4
34   */
35  @Plugin(name = "PropertiesConfigurationFactory", category = ConfigurationFactory.CATEGORY)
36  @Order(8)
37  public class PropertiesConfigurationFactory extends ConfigurationFactory {
38  
39      @Override
40      protected String[] getSupportedTypes() {
41          return new String[] {".properties"};
42      }
43  
44      @Override
45      public PropertiesConfiguration getConfiguration(final LoggerContext loggerContext, final ConfigurationSource source) {
46          final Properties properties = new Properties();
47          try (final InputStream configStream = source.getInputStream()) {
48              properties.load(configStream);
49          } catch (final IOException ioe) {
50              throw new ConfigurationException("Unable to load " + source.toString(), ioe);
51          }
52          return new PropertiesConfigurationBuilder()
53                  .setConfigurationSource(source)
54                  .setRootProperties(properties)
55                  .setLoggerContext(loggerContext)
56                  .build();
57      }
58  }