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.lookup;
018    
019    import org.apache.logging.log4j.core.LogEvent;
020    import org.apache.logging.log4j.core.config.plugins.Plugin;
021    
022    /**
023     * Looks up keys from system properties.
024     */
025    @Plugin(name = "sys", category = "Lookup")
026    public class SystemPropertiesLookup implements StrLookup {
027    
028        /**
029         * Looks up the value for the key.
030         * @param key  the key to be looked up, may be null
031         * @return The value for the key.
032         */
033        @Override
034        public String lookup(final String key) {
035            try {
036                return System.getProperty(key);
037            } catch (final Exception ex) {
038                // Should this be logged?
039                return null;
040            }
041        }
042    
043        /**
044         * Looks up the value for the key using the data in the LogEvent.
045         * @param event The current LogEvent.
046         * @param key  the key to be looked up, may be null
047         * @return The value associated with the key.
048         */
049        @Override
050        public String lookup(final LogEvent event, final String key) {
051            try {
052                return System.getProperty(key);
053            } catch (final Exception ex) {
054                // Should this be logged?
055                return null;
056            }
057        }
058    }