blob: 3827451f1a9e389ae9ccc37f8af5ee59786da544 [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.composite;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.lang.reflect.InvocationTargetException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.URI;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Arrays;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a>
<span class="sourceLineNo">025</span><a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.Level;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.AbstractConfiguration;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.ConfigurationFactory;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.ConfigurationSource;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.Node;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.Reconfigurable;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.util.ResolverUtil;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.status.StatusConfiguration;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.util.Loader;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.util.Patterns;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.logging.log4j.core.util.Source;<a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.logging.log4j.core.util.WatchManager;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.logging.log4j.core.util.Watcher;<a name="line.39"></a>
<span class="sourceLineNo">040</span>import org.apache.logging.log4j.util.PropertiesUtil;<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 Composite Configuration.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span>public class CompositeConfiguration extends AbstractConfiguration implements Reconfigurable {<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> * Allow the ConfigurationFactory class to be specified as a system property.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> public static final String MERGE_STRATEGY_PROPERTY = "log4j.mergeStrategy";<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> private static final String[] VERBOSE_CLASSES = new String[] {ResolverUtil.class.getName()};<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> private final List&lt;? extends AbstractConfiguration&gt; configurations;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> private MergeStrategy mergeStrategy;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * Construct the CompositeConfiguration.<a name="line.59"></a>
<span class="sourceLineNo">060</span> *<a name="line.60"></a>
<span class="sourceLineNo">061</span> * @param configurations The List of Configurations to merge.<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span> public CompositeConfiguration(final List&lt;? extends AbstractConfiguration&gt; configurations) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> super(configurations.get(0).getLoggerContext(), ConfigurationSource.COMPOSITE_SOURCE);<a name="line.64"></a>
<span class="sourceLineNo">065</span> rootNode = configurations.get(0).getRootNode();<a name="line.65"></a>
<span class="sourceLineNo">066</span> this.configurations = configurations;<a name="line.66"></a>
<span class="sourceLineNo">067</span> final String mergeStrategyClassName = PropertiesUtil.getProperties().getStringProperty(MERGE_STRATEGY_PROPERTY,<a name="line.67"></a>
<span class="sourceLineNo">068</span> DefaultMergeStrategy.class.getName());<a name="line.68"></a>
<span class="sourceLineNo">069</span> try {<a name="line.69"></a>
<span class="sourceLineNo">070</span> mergeStrategy = Loader.newInstanceOf(mergeStrategyClassName);<a name="line.70"></a>
<span class="sourceLineNo">071</span> } catch (ClassNotFoundException | IllegalAccessException | NoSuchMethodException | InvocationTargetException |<a name="line.71"></a>
<span class="sourceLineNo">072</span> InstantiationException ex) {<a name="line.72"></a>
<span class="sourceLineNo">073</span> mergeStrategy = new DefaultMergeStrategy();<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> for (final AbstractConfiguration config : configurations) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> mergeStrategy.mergeRootProperties(rootNode, config);<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span> final StatusConfiguration statusConfig = new StatusConfiguration().withVerboseClasses(VERBOSE_CLASSES)<a name="line.78"></a>
<span class="sourceLineNo">079</span> .withStatus(getDefaultStatus());<a name="line.79"></a>
<span class="sourceLineNo">080</span> for (final Map.Entry&lt;String, String&gt; entry : rootNode.getAttributes().entrySet()) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> final String key = entry.getKey();<a name="line.81"></a>
<span class="sourceLineNo">082</span> final String value = getStrSubstitutor().replace(entry.getValue());<a name="line.82"></a>
<span class="sourceLineNo">083</span> if ("status".equalsIgnoreCase(key)) {<a name="line.83"></a>
<span class="sourceLineNo">084</span> statusConfig.withStatus(value.toUpperCase());<a name="line.84"></a>
<span class="sourceLineNo">085</span> } else if ("dest".equalsIgnoreCase(key)) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> statusConfig.withDestination(value);<a name="line.86"></a>
<span class="sourceLineNo">087</span> } else if ("shutdownHook".equalsIgnoreCase(key)) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> isShutdownHookEnabled = !"disable".equalsIgnoreCase(value);<a name="line.88"></a>
<span class="sourceLineNo">089</span> } else if ("shutdownTimeout".equalsIgnoreCase(key)) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> shutdownTimeoutMillis = Long.parseLong(value);<a name="line.90"></a>
<span class="sourceLineNo">091</span> } else if ("verbose".equalsIgnoreCase(key)) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> statusConfig.withVerbosity(value);<a name="line.92"></a>
<span class="sourceLineNo">093</span> } else if ("packages".equalsIgnoreCase(key)) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> pluginPackages.addAll(Arrays.asList(value.split(Patterns.COMMA_SEPARATOR)));<a name="line.94"></a>
<span class="sourceLineNo">095</span> } else if ("name".equalsIgnoreCase(key)) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> setName(value);<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span> }<a name="line.98"></a>
<span class="sourceLineNo">099</span> statusConfig.initialize();<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> @Override<a name="line.102"></a>
<span class="sourceLineNo">103</span> public void setup() {<a name="line.103"></a>
<span class="sourceLineNo">104</span> final AbstractConfiguration targetConfiguration = configurations.get(0);<a name="line.104"></a>
<span class="sourceLineNo">105</span> staffChildConfiguration(targetConfiguration);<a name="line.105"></a>
<span class="sourceLineNo">106</span> final WatchManager watchManager = getWatchManager();<a name="line.106"></a>
<span class="sourceLineNo">107</span> final WatchManager targetWatchManager = targetConfiguration.getWatchManager();<a name="line.107"></a>
<span class="sourceLineNo">108</span> if (targetWatchManager.getIntervalSeconds() &gt; 0) {<a name="line.108"></a>
<span class="sourceLineNo">109</span> watchManager.setIntervalSeconds(targetWatchManager.getIntervalSeconds());<a name="line.109"></a>
<span class="sourceLineNo">110</span> final Map&lt;Source, Watcher&gt; watchers = targetWatchManager.getConfigurationWatchers();<a name="line.110"></a>
<span class="sourceLineNo">111</span> for (final Map.Entry&lt;Source, Watcher&gt; entry : watchers.entrySet()) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> watchManager.watch(entry.getKey(), entry.getValue().newWatcher(this, listeners,<a name="line.112"></a>
<span class="sourceLineNo">113</span> entry.getValue().getLastModified()));<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span> }<a name="line.115"></a>
<span class="sourceLineNo">116</span> for (final AbstractConfiguration sourceConfiguration : configurations.subList(1, configurations.size())) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> staffChildConfiguration(sourceConfiguration);<a name="line.117"></a>
<span class="sourceLineNo">118</span> final Node sourceRoot = sourceConfiguration.getRootNode();<a name="line.118"></a>
<span class="sourceLineNo">119</span> mergeStrategy.mergConfigurations(rootNode, sourceRoot, getPluginManager());<a name="line.119"></a>
<span class="sourceLineNo">120</span> if (LOGGER.isEnabled(Level.ALL)) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> final StringBuilder sb = new StringBuilder();<a name="line.121"></a>
<span class="sourceLineNo">122</span> printNodes("", rootNode, sb);<a name="line.122"></a>
<span class="sourceLineNo">123</span> System.out.println(sb.toString());<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span> final int monitorInterval = sourceConfiguration.getWatchManager().getIntervalSeconds();<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (monitorInterval &gt; 0) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> final int currentInterval = watchManager.getIntervalSeconds();<a name="line.127"></a>
<span class="sourceLineNo">128</span> if (currentInterval &lt;= 0 || monitorInterval &lt; currentInterval) {<a name="line.128"></a>
<span class="sourceLineNo">129</span> watchManager.setIntervalSeconds(monitorInterval);<a name="line.129"></a>
<span class="sourceLineNo">130</span> }<a name="line.130"></a>
<span class="sourceLineNo">131</span> final WatchManager sourceWatchManager = sourceConfiguration.getWatchManager();<a name="line.131"></a>
<span class="sourceLineNo">132</span> final Map&lt;Source, Watcher&gt; watchers = sourceWatchManager.getConfigurationWatchers();<a name="line.132"></a>
<span class="sourceLineNo">133</span> for (final Map.Entry&lt;Source, Watcher&gt; entry : watchers.entrySet()) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> watchManager.watch(entry.getKey(), entry.getValue().newWatcher(this, listeners,<a name="line.134"></a>
<span class="sourceLineNo">135</span> entry.getValue().getLastModified()));<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<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><a name="line.140"></a>
<span class="sourceLineNo">141</span> @Override<a name="line.141"></a>
<span class="sourceLineNo">142</span> public Configuration reconfigure() {<a name="line.142"></a>
<span class="sourceLineNo">143</span> LOGGER.debug("Reconfiguring composite configuration");<a name="line.143"></a>
<span class="sourceLineNo">144</span> final List&lt;AbstractConfiguration&gt; configs = new ArrayList&lt;&gt;();<a name="line.144"></a>
<span class="sourceLineNo">145</span> final ConfigurationFactory factory = ConfigurationFactory.getInstance();<a name="line.145"></a>
<span class="sourceLineNo">146</span> for (final AbstractConfiguration config : configurations) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> final ConfigurationSource source = config.getConfigurationSource();<a name="line.147"></a>
<span class="sourceLineNo">148</span> final URI sourceURI = source.getURI();<a name="line.148"></a>
<span class="sourceLineNo">149</span> Configuration currentConfig = config;<a name="line.149"></a>
<span class="sourceLineNo">150</span> if (sourceURI == null) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> LOGGER.warn("Unable to determine URI for configuration {}, changes to it will be ignored",<a name="line.151"></a>
<span class="sourceLineNo">152</span> config.getName());<a name="line.152"></a>
<span class="sourceLineNo">153</span> } else {<a name="line.153"></a>
<span class="sourceLineNo">154</span> currentConfig = factory.getConfiguration(getLoggerContext(), config.getName(), sourceURI);<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (currentConfig == null) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> LOGGER.warn("Unable to reload configuration {}, changes to it will be ignored", config.getName());<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>
<span class="sourceLineNo">159</span> configs.add((AbstractConfiguration) currentConfig);<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span> return new CompositeConfiguration(configs);<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> private void staffChildConfiguration(final AbstractConfiguration childConfiguration) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> childConfiguration.setPluginManager(pluginManager);<a name="line.167"></a>
<span class="sourceLineNo">168</span> childConfiguration.setScriptManager(scriptManager);<a name="line.168"></a>
<span class="sourceLineNo">169</span> childConfiguration.setup();<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> private void printNodes(final String indent, final Node node, final StringBuilder sb) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> sb.append(indent).append(node.getName()).append(" type: ").append(node.getType()).append("\n");<a name="line.173"></a>
<span class="sourceLineNo">174</span> sb.append(indent).append(node.getAttributes().toString()).append("\n");<a name="line.174"></a>
<span class="sourceLineNo">175</span> for (final Node child : node.getChildren()) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> printNodes(indent + " ", child, sb);<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span> }<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> @Override<a name="line.180"></a>
<span class="sourceLineNo">181</span> public String toString() {<a name="line.181"></a>
<span class="sourceLineNo">182</span> return getClass().getName() + "@" + Integer.toHexString(hashCode()) + " [configurations=" + configurations<a name="line.182"></a>
<span class="sourceLineNo">183</span> + ", mergeStrategy=" + mergeStrategy + ", rootNode=" + rootNode + ", listeners=" + listeners<a name="line.183"></a>
<span class="sourceLineNo">184</span> + ", pluginPackages=" + pluginPackages + ", pluginManager=" + pluginManager + ", isShutdownHookEnabled="<a name="line.184"></a>
<span class="sourceLineNo">185</span> + isShutdownHookEnabled + ", shutdownTimeoutMillis=" + shutdownTimeoutMillis + ", scriptManager="<a name="line.185"></a>
<span class="sourceLineNo">186</span> + scriptManager + "]";<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span>}<a name="line.188"></a>
</pre>
</div>
</body>
</html>