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 */
017package org.apache.logging.log4j.core.lookup;
018
019import java.lang.management.ManagementFactory;
020import java.util.List;
021import java.util.Map;
022
023import org.apache.logging.log4j.core.LogEvent;
024import org.apache.logging.log4j.core.config.plugins.Plugin;
025
026/**
027 * Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.
028 *
029 * @see java.lang.management.RuntimeMXBean#getInputArguments()
030 * @since 2.1
031 */
032@Plugin(name = "jvmrunargs", category = StrLookup.CATEGORY)
033public class JmxRuntimeInputArgumentsLookup extends MapLookup {
034
035    static {
036        final List<String> argsList = ManagementFactory.getRuntimeMXBean().getInputArguments();
037        JMX_SINGLETON = new JmxRuntimeInputArgumentsLookup(MapLookup.toMap(argsList));
038    }
039
040    public static final JmxRuntimeInputArgumentsLookup JMX_SINGLETON;
041
042    /**
043     * Constructor when used directly as a plugin.
044     */
045    public JmxRuntimeInputArgumentsLookup() {
046    }
047
048    public JmxRuntimeInputArgumentsLookup(final Map<String, String> map) {
049        super(map);
050    }
051
052    @Override
053    public String lookup(final LogEvent event, final String key) {
054        return lookup(key);
055    }
056
057    @Override
058    public String lookup(final String key) {
059        if (key == null) {
060            return null;
061        }
062        Map<String, String> map = getMap();
063        return map == null ? null : map.get(key);
064    }
065}