org.apache.logging.log4j.core.lookup

Class JmxRuntimeInputArgumentsLookup

java.lang.Object

org.apache.logging.log4j.core.lookup.MapLookup

org.apache.logging.log4j.core.lookup.JmxRuntimeInputArgumentsLookup

All Implemented Interfaces:

StrLookup

@Plugin(name="jvmrunargs",
        category="Lookup")
public class JmxRuntimeInputArgumentsLookup
extends MapLookup

Maps JVM input arguments (but not main arguments) using JMX to acquire JVM arguments.

Since:

2.1

See Also:

RuntimeMXBean.getInputArguments()

Field Summary

Fields

Modifier and Type	Field and Description
static JmxRuntimeInputArgumentsLookup	JMX_SINGLETON

Fields inherited from interface org.apache.logging.log4j.core.lookup.StrLookup

CATEGORY

Constructor Summary

Constructors

Constructor and Description
JmxRuntimeInputArgumentsLookup() Constructor when used directly as a plugin.
JmxRuntimeInputArgumentsLookup(Map<String,String> map)

Method Summary

Modifier and Type	Method and Description
String	lookup(LogEvent event, String key) Looks up a String key to a String value possibly using the current LogEvent.
String	lookup(String key) Looks up a String key to a String value using the map.

Methods inherited from class org.apache.logging.log4j.core.lookup.MapLookup

getMap, setMainArguments

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.lookup.StrLookup

evaluate, evaluate

Field Detail

JMX_SINGLETON

public static final JmxRuntimeInputArgumentsLookup JMX_SINGLETON

Constructor Detail

JmxRuntimeInputArgumentsLookup

public JmxRuntimeInputArgumentsLookup()

Constructor when used directly as a plugin.

JmxRuntimeInputArgumentsLookup

public JmxRuntimeInputArgumentsLookup(Map<String,String> map)

Method Detail

lookup

public String lookup(LogEvent event,
                     String key)

Description copied from interface: StrLookup

Looks up a String key to a String value possibly using the current LogEvent.

The internal implementation may use any mechanism to return the value. The simplest implementation is to use a Map. However, virtually any implementation is possible.

For example, it would be possible to implement a lookup that used the key as a primary key, and looked up the value on demand from the database Or, a numeric based implementation could be created that treats the key as an integer, increments the value and return the result as a string - converting 1 to 2, 15 to 16 etc.

This method always returns a String, regardless of the underlying data, by converting it as necessary. For example:

 Map<String, Object> map = new HashMap<String, Object>();
 map.put("number", new Integer(2));
 assertEquals("2", StrLookup.mapLookup(map).lookup("number"));
 

Specified by:

lookup in interface StrLookup

Overrides:

lookup in class MapLookup

Parameters:

event - The current LogEvent.

key - the key to be looked up, may be null

Returns:

the matching value, null if no match

lookup

public String lookup(String key)

Description copied from class: MapLookup

Looks up a String key to a String value using the map.

If the map is null, then null is returned. The map result object is converted to a string using toString().

Specified by:

lookup in interface StrLookup

Overrides:

lookup in class MapLookup

Parameters:

key - the key to be looked up, may be null

Returns:

the matching value, null if no match