blob: ed6bdedf875d250b32a5c5e8bff712333a7524a4 [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.io.Serializable;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.ArrayList;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.List;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Objects;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.regex.Matcher;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.regex.Pattern;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * A source for global configuration properties.<a name="line.29"></a>
<span class="sourceLineNo">030</span> *<a name="line.30"></a>
<span class="sourceLineNo">031</span> * @since 2.10.0<a name="line.31"></a>
<span class="sourceLineNo">032</span> */<a name="line.32"></a>
<span class="sourceLineNo">033</span>public interface PropertySource {<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Returns the order in which this PropertySource has priority. A higher value means that the source will be<a name="line.36"></a>
<span class="sourceLineNo">037</span> * applied later so as to take precedence over other property sources.<a name="line.37"></a>
<span class="sourceLineNo">038</span> *<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @return priority value<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span> int getPriority();<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
<span class="sourceLineNo">044</span> * Iterates over all properties and performs an action for each key/value pair.<a name="line.44"></a>
<span class="sourceLineNo">045</span> *<a name="line.45"></a>
<span class="sourceLineNo">046</span> * @param action action to perform on each key/value pair<a name="line.46"></a>
<span class="sourceLineNo">047</span> */<a name="line.47"></a>
<span class="sourceLineNo">048</span> default void forEach(BiConsumer&lt;String, String&gt; action) {<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> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Converts a list of property name tokens into a normal form. For example, a list of tokens such as<a name="line.52"></a>
<span class="sourceLineNo">053</span> * "foo", "bar", "baz", might be normalized into the property name "log4j2.fooBarBaz".<a name="line.53"></a>
<span class="sourceLineNo">054</span> *<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param tokens list of property name tokens<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @return a normalized property name using the given tokens<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> default CharSequence getNormalForm(Iterable&lt;? extends CharSequence&gt; tokens) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> return null;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
<span class="sourceLineNo">063</span> * For PropertySources that cannot iterate over all the potential properties this provides a direct lookup.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param key The key to search for.<a name="line.64"></a>
<span class="sourceLineNo">065</span> * @return The value or null;<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @since 2.13.0<a name="line.66"></a>
<span class="sourceLineNo">067</span> */<a name="line.67"></a>
<span class="sourceLineNo">068</span> default String getProperty(String key) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> return null;<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>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * For PropertySources that cannot iterate over all the potential properties this provides a direct lookup.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param key The key to search for.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @return The value or null;<a name="line.76"></a>
<span class="sourceLineNo">077</span> * @since 2.13.0<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> default boolean containsProperty(String key) {<a name="line.79"></a>
<span class="sourceLineNo">080</span> return false;<a name="line.80"></a>
<span class="sourceLineNo">081</span> }<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span> /**<a name="line.83"></a>
<span class="sourceLineNo">084</span> * Comparator for ordering PropertySource instances by priority.<a name="line.84"></a>
<span class="sourceLineNo">085</span> *<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @since 2.10.0<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> class Comparator implements java.util.Comparator&lt;PropertySource&gt;, Serializable {<a name="line.88"></a>
<span class="sourceLineNo">089</span> private static final long serialVersionUID = 1L;<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> @Override<a name="line.91"></a>
<span class="sourceLineNo">092</span> public int compare(final PropertySource o1, final PropertySource o2) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> return Integer.compare(Objects.requireNonNull(o1).getPriority(), Objects.requireNonNull(o2).getPriority());<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>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span> /**<a name="line.97"></a>
<span class="sourceLineNo">098</span> * Utility methods useful for PropertySource implementations.<a name="line.98"></a>
<span class="sourceLineNo">099</span> *<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @since 2.10.0<a name="line.100"></a>
<span class="sourceLineNo">101</span> */<a name="line.101"></a>
<span class="sourceLineNo">102</span> final class Util {<a name="line.102"></a>
<span class="sourceLineNo">103</span> private static final String PREFIXES = "(?i:^log4j2?[-._/]?|^org\\.apache\\.logging\\.log4j\\.)?";<a name="line.103"></a>
<span class="sourceLineNo">104</span> private static final Pattern PROPERTY_TOKENIZER = Pattern.compile(PREFIXES + "([A-Z]*[a-z0-9]+|[A-Z0-9]+)[-._/]?");<a name="line.104"></a>
<span class="sourceLineNo">105</span> private static final Map&lt;CharSequence, List&lt;CharSequence&gt;&gt; CACHE = new ConcurrentHashMap&lt;&gt;();<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> * Converts a property name string into a list of tokens. This will strip a prefix of {@code log4j},<a name="line.108"></a>
<span class="sourceLineNo">109</span> * {@code log4j2}, {@code Log4j}, or {@code org.apache.logging.log4j}, along with separators of<a name="line.109"></a>
<span class="sourceLineNo">110</span> * dash {@code -}, dot {@code .}, underscore {@code _}, and slash {@code /}. Tokens can also be separated<a name="line.110"></a>
<span class="sourceLineNo">111</span> * by camel case conventions without needing a separator character in between.<a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param value property name<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @return the property broken into lower case tokens<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public static List&lt;CharSequence&gt; tokenize(final CharSequence value) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (CACHE.containsKey(value)) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> return CACHE.get(value);<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> final List&lt;CharSequence&gt; tokens = new ArrayList&lt;&gt;();<a name="line.120"></a>
<span class="sourceLineNo">121</span> final Matcher matcher = PROPERTY_TOKENIZER.matcher(value);<a name="line.121"></a>
<span class="sourceLineNo">122</span> while (matcher.find()) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> tokens.add(matcher.group(1).toLowerCase());<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> CACHE.put(value, tokens);<a name="line.125"></a>
<span class="sourceLineNo">126</span> return tokens;<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * Joins a list of strings using camelCaseConventions.<a name="line.130"></a>
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @param tokens tokens to convert<a name="line.132"></a>
<span class="sourceLineNo">133</span> * @return tokensAsCamelCase<a name="line.133"></a>
<span class="sourceLineNo">134</span> */<a name="line.134"></a>
<span class="sourceLineNo">135</span> public static CharSequence joinAsCamelCase(final Iterable&lt;? extends CharSequence&gt; tokens) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> final StringBuilder sb = new StringBuilder();<a name="line.136"></a>
<span class="sourceLineNo">137</span> boolean first = true;<a name="line.137"></a>
<span class="sourceLineNo">138</span> for (final CharSequence token : tokens) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> if (first) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> sb.append(token);<a name="line.140"></a>
<span class="sourceLineNo">141</span> } else {<a name="line.141"></a>
<span class="sourceLineNo">142</span> sb.append(Character.toUpperCase(token.charAt(0)));<a name="line.142"></a>
<span class="sourceLineNo">143</span> if (token.length() &gt; 1) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> sb.append(token.subSequence(1, token.length()));<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span> first = false;<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span> return sb.toString();<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> private Util() {<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>