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  
18  package org.apache.log4j.config;
19  
20  import org.apache.logging.log4j.core.LoggerContext;
21  import org.apache.logging.log4j.core.config.Configuration;
22  import org.apache.logging.log4j.core.config.ConfigurationFactory;
23  import org.apache.logging.log4j.core.config.ConfigurationSource;
24  import org.apache.logging.log4j.core.config.Order;
25  import org.apache.logging.log4j.core.config.plugins.Plugin;
26  import org.apache.logging.log4j.util.PropertiesUtil;
27  
28  /**
29   * Configures Log4j from a log4j 1 format properties file.
30   */
31  @Plugin(name = "Log4j1PropertiesConfigurationFactory", category = ConfigurationFactory.CATEGORY)
32  @Order(2)
33  public class PropertiesConfigurationFactory extends ConfigurationFactory {
34  
35      static final String FILE_EXTENSION = ".properties";
36  
37      /**
38       * File name prefix for test configurations.
39       */
40      protected static final String TEST_PREFIX = "log4j-test";
41  
42      /**
43       * File name prefix for standard configurations.
44       */
45      protected static final String DEFAULT_PREFIX = "log4j";
46  
47      @Override
48      protected String[] getSupportedTypes() {
49          if (!PropertiesUtil.getProperties().getBooleanProperty(ConfigurationFactory.LOG4J1_EXPERIMENTAL, Boolean.FALSE)) {
50              return null;
51          }
52          return new String[] { FILE_EXTENSION };
53      }
54  
55      @Override
56      public Configuration getConfiguration(LoggerContext loggerContext, ConfigurationSource source) {
57          int interval = PropertiesUtil.getProperties().getIntegerProperty(Log4j1Configuration.MONITOR_INTERVAL, 0);
58          return new PropertiesConfiguration(loggerContext, source, interval);
59      }
60  
61      @Override
62      protected String getTestPrefix() {
63          return TEST_PREFIX;
64      }
65  
66      @Override
67      protected String getDefaultPrefix() {
68          return DEFAULT_PREFIX;
69      }
70  
71      @Override
72      protected String getVersion() {
73          return LOG4J1_VERSION;
74      }
75  }