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.plugins;
18  
19  import java.util.HashMap;
20  import java.util.Map;
21  
22  import org.apache.logging.log4j.core.config.Configuration;
23  import org.apache.logging.log4j.core.config.Property;
24  import org.apache.logging.log4j.core.lookup.Interpolator;
25  import org.apache.logging.log4j.core.lookup.MapLookup;
26  import org.apache.logging.log4j.core.lookup.StrLookup;
27  
28  /**
29   * Handles properties defined in the configuration.
30   */
31  @Plugin(name = "properties", category = "Core", printObject = true)
32  public final class PropertiesPlugin {
33  
34      private PropertiesPlugin() {
35      }
36  
37      /**
38       * Create the Properties component.
39       * @param properties An array of Property elements.
40       * @param config The Configuration.
41       * @return An Interpolator that includes the configuration properties.
42       */
43      @PluginFactory
44      public static StrLookup configureSubstitutor(@PluginElement("Properties") final Property[] properties,
45                                                   @PluginConfiguration final Configuration config) {
46          if (properties == null) {
47              return new Interpolator(config.getProperties());
48          }
49          final Map<String, String> map = new HashMap<String, String>(config.getProperties());
50  
51          for (final Property prop : properties) {
52              map.put(prop.getName(), prop.getValue());
53          }
54  
55          return new Interpolator(new MapLookup(map));
56      }
57  }