1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.lookup;
18
19 import java.util.HashMap;
20 import java.util.List;
21 import java.util.Map;
22
23 import org.apache.logging.log4j.Logger;
24 import org.apache.logging.log4j.core.LogEvent;
25 import org.apache.logging.log4j.core.config.plugins.util.PluginManager;
26 import org.apache.logging.log4j.core.config.plugins.util.PluginType;
27 import org.apache.logging.log4j.core.net.JndiManager;
28 import org.apache.logging.log4j.core.util.Loader;
29 import org.apache.logging.log4j.core.util.ReflectionUtil;
30 import org.apache.logging.log4j.status.StatusLogger;
31
32
33
34
35 public class Interpolator extends AbstractLookup {
36
37 private static final Logger LOGGER = StatusLogger.getLogger();
38
39
40 static final char PREFIX_SEPARATOR = ':';
41
42 private final Map<String, StrLookup> lookups = new HashMap<String, StrLookup>();
43
44 private final StrLookup defaultLookup;
45
46 public Interpolator(final StrLookup defaultLookup) {
47 this(defaultLookup, null);
48 }
49
50
51
52
53
54
55
56
57 public Interpolator(final StrLookup defaultLookup, final List<String> pluginPackages) {
58 this.defaultLookup = defaultLookup == null ? new MapLookup(new HashMap<String, String>()) : defaultLookup;
59 final PluginManager manager = new PluginManager(CATEGORY);
60 manager.collectPlugins(pluginPackages);
61 final Map<String, PluginType<?>> plugins = manager.getPlugins();
62
63 for (final Map.Entry<String, PluginType<?>> entry : plugins.entrySet()) {
64 try {
65 final Class<? extends StrLookup> clazz = entry.getValue().getPluginClass().asSubclass(StrLookup.class);
66 if (!clazz.getName().equals("org.apache.logging.log4j.core.lookup.JndiLookup")
67 || JndiManager.isJndiLookupEnabled()) {
68 lookups.put(entry.getKey().toLowerCase(), ReflectionUtil.instantiate(clazz));
69 }
70 } catch (final Exception ex) {
71 LOGGER.error("Unable to create Lookup for {}", entry.getKey(), ex);
72 }
73 }
74 }
75
76
77
78
79 public Interpolator() {
80 this((Map<String, String>) null);
81 }
82
83
84
85
86 public Interpolator(final Map<String, String> properties) {
87 this.defaultLookup = new MapLookup(properties == null ? new HashMap<String, String>() : properties);
88
89 lookups.put("sys", new SystemPropertiesLookup());
90 lookups.put("env", new EnvironmentLookup());
91 lookups.put("main", MapLookup.MAIN_SINGLETON);
92 lookups.put("java", new JavaLookup());
93
94 if (JndiManager.isJndiLookupEnabled()) {
95 try {
96
97 lookups.put("jndi", Loader.newCheckedInstanceOf("org.apache.logging.log4j.core.lookup.JndiLookup", StrLookup.class));
98 } catch (final Throwable e) {
99
100 LOGGER.warn(
101 "JNDI lookup class is not available because this JRE does not support JNDI. JNDI string lookups will not be available, continuing configuration.",
102 e);
103 }
104 }
105
106 try {
107
108 lookups.put("jvmrunargs",
109 Loader.newCheckedInstanceOf("org.apache.logging.log4j.core.lookup.JmxRuntimeInputArgumentsLookup", StrLookup.class));
110 } catch (final Throwable e) {
111
112 LOGGER.warn(
113 "JMX runtime input lookup class is not available because this JRE does not support JMX. JMX lookups will not be available, continuing configuration.",
114 e);
115 }
116 lookups.put("date", new DateLookup());
117 lookups.put("ctx", new ContextMapLookup());
118 if (Loader.isClassAvailable("javax.servlet.ServletContext")) {
119 try {
120 lookups.put("web",
121 Loader.newCheckedInstanceOf("org.apache.logging.log4j.web.WebLookup", StrLookup.class));
122 } catch (final Exception ignored) {
123 LOGGER.info("Log4j appears to be running in a Servlet environment, but there's no log4j-web module " +
124 "available. If you want better web container support, please add the log4j-web JAR to your " +
125 "web archive or server lib directory.");
126 }
127 } else {
128 LOGGER.debug("Not in a ServletContext environment, thus not loading WebLookup plugin.");
129 }
130 }
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145 @Override
146 public String lookup(final LogEvent event, String var) {
147 if (var == null) {
148 return null;
149 }
150
151 final int prefixPos = var.indexOf(PREFIX_SEPARATOR);
152 if (prefixPos >= 0) {
153 final String prefix = var.substring(0, prefixPos);
154 final String name = var.substring(prefixPos + 1);
155 final StrLookup lookup = lookups.get(prefix);
156 String value = null;
157 if (lookup != null) {
158 value = event == null ? lookup.lookup(name) : lookup.lookup(event, name);
159 }
160
161 if (value != null) {
162 return value;
163 }
164 var = var.substring(prefixPos + 1);
165 }
166 if (defaultLookup != null) {
167 return event == null ? defaultLookup.lookup(var) : defaultLookup.lookup(event, var);
168 }
169 return null;
170 }
171
172 @Override
173 public String toString() {
174 final StringBuilder sb = new StringBuilder();
175 for (final String name : lookups.keySet()) {
176 if (sb.length() == 0) {
177 sb.append('{');
178 } else {
179 sb.append(", ");
180 }
181
182 sb.append(name);
183 }
184 if (sb.length() > 0) {
185 sb.append('}');
186 }
187 return sb.toString();
188 }
189 }