| <!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.Map;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * A map-based lookup for main arguments.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> *<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * See {@link #setMainArguments(String[])}.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> *<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * @since 2.4<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>@Plugin(name = "main", category = StrLookup.CATEGORY)<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>public class MainMapLookup extends MapLookup {<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span> /**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * A singleton used by a main method to save its arguments.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> static final MapLookup MAIN_SINGLETON = new MapLookup(MapLookup.newMap(0));<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Constructor when used directly as a plugin.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> public MainMapLookup() {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> // no-init<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> public MainMapLookup(final Map<String, String> map) {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> super(map);<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> }<a name="line.48"></a> |
| <span class="sourceLineNo">049</span><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> /**<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * An application's {@code public static main(String[])} method calls this method to make its main arguments<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * available for lookup with the prefix {@code main}.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * The map provides two kinds of access: First by index, starting at {@code "0"}, {@code "1"} and so on. For<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * example, the command line {@code --file path/file.txt -x 2} can be accessed from a configuration file with:<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * </p><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * <ul><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <li>{@code "main:0"} = {@code "--file"}</li><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <li>{@code "main:1"} = {@code "path/file.txt"}</li><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * <li>{@code "main:2"} = {@code "-x"}</li><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <li>{@code "main:3"} = {@code "2"}</li><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * </ul><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * <p><a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Second using the argument at position n as the key to access the value at n+1.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * </p><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <ul><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * <li>{@code "main:\--file"} = {@code "path/file.txt"}</li><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * <li>{@code "main:\-x"} = {@code "2"}</li><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * </ul><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> *<p>Note: Many applications use leading dashes to identify command arguments. Specifying {@code "main:--file}<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * would result in the lookup failing because it would look for a variable named "main" with a default<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * value of "-file". To avoid this the ":" separating the Lookup name from the key must be followed by<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * a backslash as an escape character.</p><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> *<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * @param args<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * An application's {@code public static main(String[])} arguments.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public static void setMainArguments(final String... args) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> if (args == null) {<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> return;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> }<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> initMap(args, MainMapLookup.MAIN_SINGLETON.getMap());<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> @Override<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public String lookup(final LogEvent event, final String key) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> return MAIN_SINGLETON.getMap().get(key);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> @Override<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public String lookup(final String key) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return MAIN_SINGLETON.getMap().get(key);<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span>}<a name="line.95"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |