blob: b545a0d1098ab3b69c47d4e9132cd5534afb2712 [file] [log] [blame]
<!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.util;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.Objects;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Properties;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * PropertySource backed by the current system properties. Other than having a<a name="line.23"></a>
<span class="sourceLineNo">024</span> * higher priority over normal properties, this follows the same rules as<a name="line.24"></a>
<span class="sourceLineNo">025</span> * {@link PropertiesPropertySource}.<a name="line.25"></a>
<span class="sourceLineNo">026</span> *<a name="line.26"></a>
<span class="sourceLineNo">027</span> * @since 2.10.0<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>public class SystemPropertiesPropertySource implements PropertySource {<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span> private static final int DEFAULT_PRIORITY = 100;<a name="line.31"></a>
<span class="sourceLineNo">032</span> private static final String PREFIX = "log4j2.";<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span> @Override<a name="line.34"></a>
<span class="sourceLineNo">035</span> public int getPriority() {<a name="line.35"></a>
<span class="sourceLineNo">036</span> return DEFAULT_PRIORITY;<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> @Override<a name="line.39"></a>
<span class="sourceLineNo">040</span> public void forEach(final BiConsumer&lt;String, String&gt; action) {<a name="line.40"></a>
<span class="sourceLineNo">041</span> Properties properties;<a name="line.41"></a>
<span class="sourceLineNo">042</span> try {<a name="line.42"></a>
<span class="sourceLineNo">043</span> properties = System.getProperties();<a name="line.43"></a>
<span class="sourceLineNo">044</span> } catch (final SecurityException e) {<a name="line.44"></a>
<span class="sourceLineNo">045</span> // (1) There is no status logger.<a name="line.45"></a>
<span class="sourceLineNo">046</span> // (2) LowLevelLogUtil also consults system properties ("line.separator") to<a name="line.46"></a>
<span class="sourceLineNo">047</span> // open a BufferedWriter, so this may fail as well. Just having a hard reference<a name="line.47"></a>
<span class="sourceLineNo">048</span> // in this code to LowLevelLogUtil would cause a problem.<a name="line.48"></a>
<span class="sourceLineNo">049</span> // (3) We could log to System.err (nah) or just be quiet as we do now.<a name="line.49"></a>
<span class="sourceLineNo">050</span> return;<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span> // Lock properties only long enough to get a thread-safe SAFE snapshot of its<a name="line.52"></a>
<span class="sourceLineNo">053</span> // current keys, an array.<a name="line.53"></a>
<span class="sourceLineNo">054</span> final Object[] keySet;<a name="line.54"></a>
<span class="sourceLineNo">055</span> synchronized (properties) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> keySet = properties.keySet().toArray();<a name="line.56"></a>
<span class="sourceLineNo">057</span> }<a name="line.57"></a>
<span class="sourceLineNo">058</span> // Then traverse for an unknown amount of time.<a name="line.58"></a>
<span class="sourceLineNo">059</span> // Some keys may now be absent, in which case, the value is null.<a name="line.59"></a>
<span class="sourceLineNo">060</span> for (final Object key : keySet) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> final String keyStr = Objects.toString(key, null);<a name="line.61"></a>
<span class="sourceLineNo">062</span> action.accept(keyStr, properties.getProperty(keyStr));<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><a name="line.65"></a>
<span class="sourceLineNo">066</span> @Override<a name="line.66"></a>
<span class="sourceLineNo">067</span> public CharSequence getNormalForm(final Iterable&lt;? extends CharSequence&gt; tokens) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> return PREFIX + Util.joinAsCamelCase(tokens);<a name="line.68"></a>
<span class="sourceLineNo">069</span> }<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>}<a name="line.71"></a>
</pre>
</div>
</body>
</html>