001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements. See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache license, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License. You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the license for the specific language governing permissions and
015     * limitations under the license.
016     */
017    package org.apache.logging.log4j.core.config.plugins;
018    
019    import org.apache.logging.log4j.core.config.Configuration;
020    import org.apache.logging.log4j.core.config.Property;
021    import org.apache.logging.log4j.core.lookup.Interpolator;
022    import org.apache.logging.log4j.core.lookup.MapLookup;
023    import org.apache.logging.log4j.core.lookup.StrLookup;
024    
025    import java.util.HashMap;
026    import java.util.Map;
027    
028    /**
029     * Handles properties defined in the configuration.
030     */
031    @Plugin(name = "properties", type = "Core", printObject = true)
032    public final class PropertiesPlugin {
033    
034        private PropertiesPlugin() {
035        }
036    
037        /**
038         * Create the Properties component.
039         * @param properties An array of Property elements.
040         * @param config The Configuration.
041         * @return An Interpolator that includes the configuration properties.
042         */
043        @PluginFactory
044        public static StrLookup configureSubstitutor(@PluginElement("properties") final Property[] properties,
045                                                     @PluginConfiguration final Configuration config) {
046            if (properties == null) {
047                return new Interpolator(null);
048            }
049            final Map<String, String> map = new HashMap<String, String>(config.getProperties());
050    
051            for (final Property prop : properties) {
052                map.put(prop.getName(), prop.getValue());
053            }
054    
055            return new Interpolator(new MapLookup(map));
056        }
057    }