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