| <!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.util;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import org.apache.logging.log4j.core.time.PreciseClock;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.util.PropertiesUtil;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.util.Supplier;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.HashMap;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * Factory for {@code Clock} objects.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> */<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>public final class ClockFactory {<a name="line.30"></a> |
| <span class="sourceLineNo">031</span><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> /**<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Name of the system property that can be used to specify a {@code Clock}<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * implementation class. The value of this property is {@value}.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> */<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> public static final String PROPERTY_NAME = "log4j.Clock";<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> private static final StatusLogger LOGGER = StatusLogger.getLogger();<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> // private static final Clock clock = createClock();<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private ClockFactory() {<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> * Returns a {@code Clock} instance depending on the value of system<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * property {@link #PROPERTY_NAME}.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * <p><a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * If system property {@code log4j.Clock=CachedClock} is specified,<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * this method returns an instance of {@link CachedClock}. If system<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * property {@code log4j.Clock=CoarseCachedClock} is specified, this<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * method returns an instance of {@link CoarseCachedClock}.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * <p><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * If another value is specified, this value is taken as the fully qualified<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * class name of a class that implements the {@code Clock} interface. An<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * object of this class is instantiated and returned.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * </p><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * <p><a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * If no value is specified, or if the specified value could not correctly<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * be instantiated or did not implement the {@code Clock} interface, then an<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * instance of {@link SystemClock} is returned.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * </p><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> *<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * @return a {@code Clock} instance<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> */<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> public static Clock getClock() {<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> return createClock();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> }<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> private static Map<String, Supplier<Clock>> aliases() {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> final Map<String, Supplier<Clock>> result = new HashMap<>();<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> result.put("SystemClock", new Supplier<Clock>() { @Override public Clock get() { return new SystemClock(); } });<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> result.put("SystemMillisClock", new Supplier<Clock>() { @Override public Clock get() { return new SystemMillisClock(); } });<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> result.put("CachedClock", new Supplier<Clock>() { @Override public Clock get() { return CachedClock.instance(); } });<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> result.put("CoarseCachedClock", new Supplier<Clock>() { @Override public Clock get() { return CoarseCachedClock.instance(); } });<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> result.put("org.apache.logging.log4j.core.util.CachedClock", new Supplier<Clock>() { @Override public Clock get() { return CachedClock.instance(); } });<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> result.put("org.apache.logging.log4j.core.util.CoarseCachedClock", new Supplier<Clock>() { @Override public Clock get() { return CoarseCachedClock.instance(); } });<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> return result;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> }<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private static Clock createClock() {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> final String userRequest = PropertiesUtil.getProperties().getStringProperty(PROPERTY_NAME);<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> if (userRequest == null) {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> LOGGER.trace("Using default SystemClock for timestamps.");<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> return logSupportedPrecision(new SystemClock());<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> }<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> final Supplier<Clock> specified = aliases().get(userRequest);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> if (specified != null) {<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> LOGGER.trace("Using specified {} for timestamps.", userRequest);<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> return logSupportedPrecision(specified.get());<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> }<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> try {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> final Clock result = Loader.newCheckedInstanceOf(userRequest, Clock.class);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> LOGGER.trace("Using {} for timestamps.", result.getClass().getName());<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> return logSupportedPrecision(result);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> } catch (final Exception e) {<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> final String fmt = "Could not create {}: {}, using default SystemClock for timestamps.";<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> LOGGER.error(fmt, userRequest, e);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return logSupportedPrecision(new SystemClock());<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><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> private static Clock logSupportedPrecision(final Clock clock) {<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> final String support = clock instanceof PreciseClock ? "supports" : "does not support";<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> LOGGER.debug("{} {} precise timestamps.", clock.getClass().getName(), support);<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return clock;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span>}<a name="line.108"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
