| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.lookup;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.HashMap;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.List;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Map;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.message.MapMessage;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * A map-based lookup.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>@Plugin(name = "map", category = StrLookup.CATEGORY)<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>public class MapLookup implements StrLookup {<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Map keys are variable names and value.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private final Map<String, String> map;<a name="line.36"></a> |
| <span class="sourceLineNo">037</span><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Constructor when used directly as a plugin.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> public MapLookup() {<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> this.map = null;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> }<a name="line.43"></a> |
| <span class="sourceLineNo">044</span><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> /**<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Creates a new instance backed by a Map. Used by the default lookup.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * @param map<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * the map of keys to values, may be null<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> public MapLookup(final Map<String, String> map) {<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> this.map = map;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> }<a name="line.53"></a> |
| <span class="sourceLineNo">054</span><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> static Map<String, String> initMap(final String[] srcArgs, final Map<String, String> destMap) {<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> for (int i = 0; i < srcArgs.length; i++) {<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> final int next = i + 1;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> final String value = srcArgs[i];<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> destMap.put(Integer.toString(i), value);<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> destMap.put(value, next < srcArgs.length ? srcArgs[next] : null);<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> }<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> return destMap;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> }<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> static HashMap<String, String> newMap(final int initialCapacity) {<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> return new HashMap<>(initialCapacity);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> }<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * An application's {@code public static main(String[])} method calls this method to make its main arguments<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * available for lookup with the prefix {@code main}.<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <p><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * The map provides two kinds of access: First by index, starting at {@code "0"}, {@code "1"} and so on. For<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * example, the command line {@code --file path/file.txt -x 2} can be accessed from a configuration file with:<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * </p><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * <ul><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * <li>{@code "main:0"} = {@code "--file"}</li><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <li>{@code "main:1"} = {@code "path/file.txt"}</li><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <li>{@code "main:2"} = {@code "-x"}</li><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <li>{@code "main:3"} = {@code "2"}</li><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * </ul><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <p><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Second using the argument at position n as the key to access the value at n+1.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * </p><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <ul><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <li>{@code "main:--file"} = {@code "path/file.txt"}</li><a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * <li>{@code "main:-x"} = {@code "2"}</li><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * </ul><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> *<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param args<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * An application's {@code public static main(String[])} arguments.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @since 2.1<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @deprecated As of 2.4, use {@link MainMapLookup#setMainArguments(String[])}<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> @Deprecated<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> public static void setMainArguments(final String... args) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> MainMapLookup.setMainArguments(args);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span><a name="line.99"></a> |
| <span class="sourceLineNo">100</span> static Map<String, String> toMap(final List<String> args) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> if (args == null) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> return null;<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> }<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> final int size = args.size();<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> return initMap(args.toArray(new String[size]), newMap(size));<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> }<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> static Map<String, String> toMap(final String[] args) {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> if (args == null) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return null;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> return initMap(args, newMap(args.length));<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> protected Map<String, String> getMap() {<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> return map;<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> }<a name="line.117"></a> |
| <span class="sourceLineNo">118</span><a name="line.118"></a> |
| <span class="sourceLineNo">119</span> @Override<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> public String lookup(final LogEvent event, final String key) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> final boolean isMapMessage = event != null && event.getMessage() instanceof MapMessage;<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> if (map == null && !isMapMessage) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> return null;<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> if (map != null && map.containsKey(key)) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> final String obj = map.get(key);<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> if (obj != null) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return obj;<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> if (isMapMessage) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return ((MapMessage) event.getMessage()).get(key);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return null;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> /**<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * Looks up a String key to a String value using the map.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * <p><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * If the map is null, then null is returned. The map result object is converted to a string using toString().<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * </p><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> *<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param key<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * the key to be looked up, may be null<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return the matching value, null if no match<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> @Override<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> public String lookup(final String key) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> if (map == null) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> return null;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> return map.get(key);<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> }<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span>}<a name="line.155"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
