| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.config.plugins.visitors;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.lang.annotation.Annotation;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.lang.reflect.Member;<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><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.logging.log4j.Logger;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.convert.TypeConverters;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.util.Strings;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * Base class for PluginVisitor implementations. Provides convenience methods as well as all method implementations<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * other than the {@code visit} method.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @param <A> the Plugin annotation type.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public abstract class AbstractPluginVisitor<A extends Annotation> implements PluginVisitor<A> {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /** Status logger. */<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><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> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> protected final Class<A> clazz;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> protected A annotation;<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> */<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> protected String[] aliases;<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> protected Class<?> conversionType;<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> *<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> protected StrSubstitutor substitutor;<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<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> protected Member member;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * This constructor must be overridden by implementation classes as a no-arg constructor.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @param clazz the annotation class this PluginVisitor is for.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> protected AbstractPluginVisitor(final Class<A> clazz) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> this.clazz = clazz;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> @SuppressWarnings("unchecked")<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> @Override<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> public PluginVisitor<A> setAnnotation(final Annotation anAnnotation) {<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> final Annotation a = Objects.requireNonNull(anAnnotation, "No annotation was provided");<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> if (this.clazz.isInstance(a)) {<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> this.annotation = (A) a;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> }<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> return this;<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> @Override<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> public PluginVisitor<A> setAliases(final String... someAliases) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> this.aliases = someAliases;<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> return this;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> @Override<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public PluginVisitor<A> setConversionType(final Class<?> aConversionType) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> this.conversionType = Objects.requireNonNull(aConversionType, "No conversion type class was provided");<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return this;<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> @Override<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> public PluginVisitor<A> setStrSubstitutor(final StrSubstitutor aSubstitutor) {<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> this.substitutor = Objects.requireNonNull(aSubstitutor, "No StrSubstitutor was provided");<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return this;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> @Override<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public PluginVisitor<A> setMember(final Member aMember) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.member = aMember;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return this;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Removes an Entry from a given Map using a key name and aliases for that key. Keys are case-insensitive.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> *<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param attributes the Map to remove an Entry from.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param name the key name to look up.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param aliases optional aliases of the key name to look up.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @return the value corresponding to the given key or {@code null} if nonexistent.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> protected static String removeAttributeValue(final Map<String, String> attributes,<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> final String name,<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> final String... aliases) {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> for (final Map.Entry<String, String> entry : attributes.entrySet()) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> final String key = entry.getKey();<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> final String value = entry.getValue();<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> if (key.equalsIgnoreCase(name)) {<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> attributes.remove(key);<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> return value;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> if (aliases != null) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> for (final String alias : aliases) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> if (key.equalsIgnoreCase(alias)) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> attributes.remove(key);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return value;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> }<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> }<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> return null;<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Converts the given value into the configured type falling back to the provided default value.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> *<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param value the value to convert.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * @param defaultValue the fallback value to use in case of no value or an error.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return the converted value whether that be based on the given value or the default value.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> protected Object convert(final String value, final Object defaultValue) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> if (defaultValue instanceof String) {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> return TypeConverters.convert(value, this.conversionType, Strings.trimToNull((String) defaultValue));<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> }<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> return TypeConverters.convert(value, this.conversionType, defaultValue);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span>}<a name="line.153"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |