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