blob: 3c6b03d1d8eb7d07f9a3f0e1a17fd25b7abf28f1 [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.core.config.plugins.convert;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.lang.reflect.ParameterizedType;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.reflect.Type;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Collection;<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.UnknownFormatConversionException;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.concurrent.ConcurrentHashMap;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.ConcurrentMap;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.Logger;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.util.PluginManager;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.util.ReflectionUtil;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.TypeUtil;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.status.StatusLogger;<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> * Registry for {@link TypeConverter} plugins.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @since 2.1<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public class TypeConverterRegistry {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.42"></a>
<span class="sourceLineNo">043</span> private static volatile TypeConverterRegistry INSTANCE;<a name="line.43"></a>
<span class="sourceLineNo">044</span> private static final Object INSTANCE_LOCK = new Object();<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private final ConcurrentMap&lt;Type, TypeConverter&lt;?&gt;&gt; registry = new ConcurrentHashMap&lt;&gt;();<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> * Gets the singleton instance of the TypeConverterRegistry.<a name="line.49"></a>
<span class="sourceLineNo">050</span> *<a name="line.50"></a>
<span class="sourceLineNo">051</span> * @return the singleton instance.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> public static TypeConverterRegistry getInstance() {<a name="line.53"></a>
<span class="sourceLineNo">054</span> TypeConverterRegistry result = INSTANCE;<a name="line.54"></a>
<span class="sourceLineNo">055</span> if (result == null) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> synchronized (INSTANCE_LOCK) {<a name="line.56"></a>
<span class="sourceLineNo">057</span> result = INSTANCE;<a name="line.57"></a>
<span class="sourceLineNo">058</span> if (result == null) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> INSTANCE = result = new TypeConverterRegistry();<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> return result;<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> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Finds a {@link TypeConverter} for the given {@link Type}, falling back to an assignment-compatible TypeConverter<a name="line.67"></a>
<span class="sourceLineNo">068</span> * if none exist for the given type. That is, if the given Type does not have a TypeConverter, but another Type<a name="line.68"></a>
<span class="sourceLineNo">069</span> * which can be assigned to the given Type &lt;em&gt;does&lt;/em&gt; have a TypeConverter, then that TypeConverter will be<a name="line.69"></a>
<span class="sourceLineNo">070</span> * used and registered.<a name="line.70"></a>
<span class="sourceLineNo">071</span> *<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @param type the Type to find a TypeConverter for (must not be {@code null}).<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @return a TypeConverter for the given Type.<a name="line.73"></a>
<span class="sourceLineNo">074</span> * @throws UnknownFormatConversionException if no TypeConverter can be found for the given type.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> public TypeConverter&lt;?&gt; findCompatibleConverter(final Type type) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> Objects.requireNonNull(type, "No type was provided");<a name="line.77"></a>
<span class="sourceLineNo">078</span> final TypeConverter&lt;?&gt; primary = registry.get(type);<a name="line.78"></a>
<span class="sourceLineNo">079</span> // cached type converters<a name="line.79"></a>
<span class="sourceLineNo">080</span> if (primary != null) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> return primary;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> // dynamic enum support<a name="line.83"></a>
<span class="sourceLineNo">084</span> if (type instanceof Class&lt;?&gt;) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> final Class&lt;?&gt; clazz = (Class&lt;?&gt;) type;<a name="line.85"></a>
<span class="sourceLineNo">086</span> if (clazz.isEnum()) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> @SuppressWarnings({"unchecked","rawtypes"})<a name="line.87"></a>
<span class="sourceLineNo">088</span> final EnumConverter&lt;? extends Enum&gt; converter = new EnumConverter(clazz.asSubclass(Enum.class));<a name="line.88"></a>
<span class="sourceLineNo">089</span> registry.putIfAbsent(type, converter);<a name="line.89"></a>
<span class="sourceLineNo">090</span> return converter;<a name="line.90"></a>
<span class="sourceLineNo">091</span> }<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span> // look for compatible converters<a name="line.93"></a>
<span class="sourceLineNo">094</span> for (final Map.Entry&lt;Type, TypeConverter&lt;?&gt;&gt; entry : registry.entrySet()) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> final Type key = entry.getKey();<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (TypeUtil.isAssignable(type, key)) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> LOGGER.debug("Found compatible TypeConverter&lt;{}&gt; for type [{}].", key, type);<a name="line.97"></a>
<span class="sourceLineNo">098</span> final TypeConverter&lt;?&gt; value = entry.getValue();<a name="line.98"></a>
<span class="sourceLineNo">099</span> registry.putIfAbsent(type, value);<a name="line.99"></a>
<span class="sourceLineNo">100</span> return value;<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span> }<a name="line.102"></a>
<span class="sourceLineNo">103</span> throw new UnknownFormatConversionException(type.toString());<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> private TypeConverterRegistry() {<a name="line.106"></a>
<span class="sourceLineNo">107</span> LOGGER.trace("TypeConverterRegistry initializing.");<a name="line.107"></a>
<span class="sourceLineNo">108</span> final PluginManager manager = new PluginManager(TypeConverters.CATEGORY);<a name="line.108"></a>
<span class="sourceLineNo">109</span> manager.collectPlugins();<a name="line.109"></a>
<span class="sourceLineNo">110</span> loadKnownTypeConverters(manager.getPlugins().values());<a name="line.110"></a>
<span class="sourceLineNo">111</span> registerPrimitiveTypes();<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> private void loadKnownTypeConverters(final Collection&lt;PluginType&lt;?&gt;&gt; knownTypes) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> for (final PluginType&lt;?&gt; knownType : knownTypes) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> final Class&lt;?&gt; clazz = knownType.getPluginClass();<a name="line.116"></a>
<span class="sourceLineNo">117</span> if (TypeConverter.class.isAssignableFrom(clazz)) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> @SuppressWarnings("rawtypes")<a name="line.118"></a>
<span class="sourceLineNo">119</span> final Class&lt;? extends TypeConverter&gt; pluginClass = clazz.asSubclass(TypeConverter.class);<a name="line.119"></a>
<span class="sourceLineNo">120</span> final Type conversionType = getTypeConverterSupportedType(pluginClass);<a name="line.120"></a>
<span class="sourceLineNo">121</span> final TypeConverter&lt;?&gt; converter = ReflectionUtil.instantiate(pluginClass);<a name="line.121"></a>
<span class="sourceLineNo">122</span> if (registry.putIfAbsent(conversionType, converter) != null) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> LOGGER.warn("Found a TypeConverter [{}] for type [{}] that already exists.", converter,<a name="line.123"></a>
<span class="sourceLineNo">124</span> conversionType);<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<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> private static Type getTypeConverterSupportedType(@SuppressWarnings("rawtypes") final Class&lt;? extends TypeConverter&gt; typeConverterClass) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> for (final Type type : typeConverterClass.getGenericInterfaces()) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (type instanceof ParameterizedType) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> final ParameterizedType pType = (ParameterizedType) type;<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (TypeConverter.class.equals(pType.getRawType())) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> // TypeConverter&lt;T&gt; has only one type argument (T), so return that<a name="line.135"></a>
<span class="sourceLineNo">136</span> return pType.getActualTypeArguments()[0];<a name="line.136"></a>
<span class="sourceLineNo">137</span> }<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> return Void.TYPE;<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> private void registerPrimitiveTypes() {<a name="line.143"></a>
<span class="sourceLineNo">144</span> registerTypeAlias(Boolean.class, Boolean.TYPE);<a name="line.144"></a>
<span class="sourceLineNo">145</span> registerTypeAlias(Byte.class, Byte.TYPE);<a name="line.145"></a>
<span class="sourceLineNo">146</span> registerTypeAlias(Character.class, Character.TYPE);<a name="line.146"></a>
<span class="sourceLineNo">147</span> registerTypeAlias(Double.class, Double.TYPE);<a name="line.147"></a>
<span class="sourceLineNo">148</span> registerTypeAlias(Float.class, Float.TYPE);<a name="line.148"></a>
<span class="sourceLineNo">149</span> registerTypeAlias(Integer.class, Integer.TYPE);<a name="line.149"></a>
<span class="sourceLineNo">150</span> registerTypeAlias(Long.class, Long.TYPE);<a name="line.150"></a>
<span class="sourceLineNo">151</span> registerTypeAlias(Short.class, Short.TYPE);<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>
<span class="sourceLineNo">154</span> private void registerTypeAlias(final Type knownType, final Type aliasType) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> registry.putIfAbsent(aliasType, registry.get(knownType));<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span>}<a name="line.158"></a>
</pre>
</div>
</body>
</html>