| <!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.util;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.lang.reflect.AccessibleObject;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.lang.reflect.Constructor;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.lang.reflect.Field;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.lang.reflect.InvocationTargetException;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.lang.reflect.Member;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.lang.reflect.Modifier;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Objects;<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> * Utility class for performing common reflective operations.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> *<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * @since 2.1<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public final class ReflectionUtil {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> private ReflectionUtil() {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> }<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> /**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * Indicates whether or not a {@link Member} is both public and is contained in a public class.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @param <T> type of the object whose accessibility to test<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * @param member the Member to check for public accessibility (must not be {@code null}).<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @return {@code true} if {@code member} is public and contained in a public class.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @throws NullPointerException if {@code member} is {@code null}.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> public static <T extends AccessibleObject & Member> boolean isAccessible(final T member) {<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> Objects.requireNonNull(member, "No member provided");<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> return Modifier.isPublic(member.getModifiers()) && Modifier.isPublic(member.getDeclaringClass().getModifiers());<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> * Makes a {@link Member} {@link AccessibleObject#isAccessible() accessible} if the member is not public.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> *<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @param <T> type of the object to make accessible<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @param member the Member to make accessible (must not be {@code null}).<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @throws NullPointerException if {@code member} is {@code null}.<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> public static <T extends AccessibleObject & Member> void makeAccessible(final T member) {<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> if (!isAccessible(member) && !member.isAccessible()) {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> member.setAccessible(true);<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> /**<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * Makes a {@link Field} {@link AccessibleObject#isAccessible() accessible} if it is not public or if it is final.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * <p>Note that using this method to make a {@code final} field writable will most likely not work very well due to<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * compiler optimizations and the like.</p><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> *<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * @param field the Field to make accessible (must not be {@code null}).<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @throws NullPointerException if {@code field} is {@code null}.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public static void makeAccessible(final Field field) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> Objects.requireNonNull(field, "No field provided");<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> if ((!isAccessible(field) || Modifier.isFinal(field.getModifiers())) && !field.isAccessible()) {<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> field.setAccessible(true);<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> }<a name="line.77"></a> |
| <span class="sourceLineNo">078</span><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> /**<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * Gets the value of a {@link Field}, making it accessible if required.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> *<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param field the Field to obtain a value from (must not be {@code null}).<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * @param instance the instance to obtain the field value from or {@code null} only if the field is static.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @return the value stored by the field.<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * @throws NullPointerException if {@code field} is {@code null}, or if {@code instance} is {@code null} but<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * {@code field} is not {@code static}.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @see Field#get(Object)<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> public static Object getFieldValue(final Field field, final Object instance) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> makeAccessible(field);<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> if (!Modifier.isStatic(field.getModifiers())) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> Objects.requireNonNull(instance, "No instance given for non-static field");<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> }<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> try {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return field.get(instance);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> } catch (final IllegalAccessException e) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> throw new UnsupportedOperationException(e);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> }<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> }<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> /**<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * Gets the value of a static {@link Field}, making it accessible if required.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> *<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param field the Field to obtain a value from (must not be {@code null}).<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * @return the value stored by the static field.<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @throws NullPointerException if {@code field} is {@code null}, or if {@code field} is not {@code static}.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @see Field#get(Object)<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static Object getStaticFieldValue(final Field field) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return getFieldValue(field, null);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<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> * Sets the value of a {@link Field}, making it accessible if required.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> *<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param field the Field to write a value to (must not be {@code null}).<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param instance the instance to write the value to or {@code null} only if the field is static.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param value the (possibly wrapped) value to write to the field.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @throws NullPointerException if {@code field} is {@code null}, or if {@code instance} is {@code null} but<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * {@code field} is not {@code static}.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @see Field#set(Object, Object)<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public static void setFieldValue(final Field field, final Object instance, final Object value) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> makeAccessible(field);<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> if (!Modifier.isStatic(field.getModifiers())) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> Objects.requireNonNull(instance, "No instance given for non-static field");<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> try {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> field.set(instance, value);<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> } catch (final IllegalAccessException e) {<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> throw new UnsupportedOperationException(e);<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> }<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> * Sets the value of a static {@link Field}, making it accessible if required.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> *<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param field the Field to write a value to (must not be {@code null}).<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param value the (possibly wrapped) value to write to the field.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * @throws NullPointerException if {@code field} is {@code null}, or if {@code field} is not {@code static}.<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @see Field#set(Object, Object)<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> */<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> public static void setStaticFieldValue(final Field field, final Object value) {<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> setFieldValue(field, null, value);<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> /**<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * Gets the default (no-arg) constructor for a given class.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> *<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param clazz the class to find a constructor for<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @param <T> the type made by the constructor<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @return the default constructor for the given class<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @throws IllegalStateException if no default constructor can be found<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> */<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> public static <T> Constructor<T> getDefaultConstructor(final Class<T> clazz) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> Objects.requireNonNull(clazz, "No class provided");<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> try {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> final Constructor<T> constructor = clazz.getDeclaredConstructor();<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> makeAccessible(constructor);<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return constructor;<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> } catch (final NoSuchMethodException ignored) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> try {<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> final Constructor<T> constructor = clazz.getConstructor();<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> makeAccessible(constructor);<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return constructor;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> } catch (final NoSuchMethodException e) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> throw new IllegalStateException(e);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> }<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> /**<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * Constructs a new {@code T} object using the default constructor of its class. Any exceptions thrown by the<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * constructor will be rethrown by this method, possibly wrapped in an<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * {@link java.lang.reflect.UndeclaredThrowableException}.<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> *<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @param clazz the class to use for instantiation.<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> * @param <T> the type of the object to construct.<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * @return a new instance of T made from its default constructor.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> * @throws IllegalArgumentException if the given class is abstract, an interface, an array class, a primitive type,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * or void<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @throws IllegalStateException if access is denied to the constructor, or there are no default constructors<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> */<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> public static <T> T instantiate(final Class<T> clazz) {<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> Objects.requireNonNull(clazz, "No class provided");<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> final Constructor<T> constructor = getDefaultConstructor(clazz);<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> try {<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> return constructor.newInstance();<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> } catch (final LinkageError | InstantiationException e) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> // LOG4J2-1051<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> // On platforms like Google App Engine and Android, some JRE classes are not supported: JMX, JNDI, etc.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> throw new IllegalArgumentException(e);<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> } catch (final IllegalAccessException e) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> throw new IllegalStateException(e);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> } catch (final InvocationTargetException e) {<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> Throwables.rethrow(e.getCause());<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> throw new InternalError("Unreachable");<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> }<a name="line.199"></a> |
| <span class="sourceLineNo">200</span>}<a name="line.200"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
