blob: 1cb9c78abc4482c5eee6a83b65e20366a3b6b56f [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.builder.impl;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.IOException;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.InputStream;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.Arrays;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.List;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.LoggerContext;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.AbstractConfiguration;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.ConfigurationSource;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.Node;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.Reconfigurable;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.builder.api.Component;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.util.PluginManager;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.util.ResolverUtil;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.status.StatusConfiguration;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.util.Patterns;<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> * This is the general version of the Configuration created by the Builder. It may be extended to<a name="line.37"></a>
<span class="sourceLineNo">038</span> * enhance its functionality.<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * @since 2.4<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>public class BuiltConfiguration extends AbstractConfiguration {<a name="line.42"></a>
<span class="sourceLineNo">043</span> private static final String[] VERBOSE_CLASSES = new String[] { ResolverUtil.class.getName() };<a name="line.43"></a>
<span class="sourceLineNo">044</span> private final StatusConfiguration statusConfig;<a name="line.44"></a>
<span class="sourceLineNo">045</span> protected Component rootComponent;<a name="line.45"></a>
<span class="sourceLineNo">046</span> private Component loggersComponent;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private Component appendersComponent;<a name="line.47"></a>
<span class="sourceLineNo">048</span> private Component filtersComponent;<a name="line.48"></a>
<span class="sourceLineNo">049</span> private Component propertiesComponent;<a name="line.49"></a>
<span class="sourceLineNo">050</span> private Component customLevelsComponent;<a name="line.50"></a>
<span class="sourceLineNo">051</span> private Component scriptsComponent;<a name="line.51"></a>
<span class="sourceLineNo">052</span> private String contentType = "text";<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> public BuiltConfiguration(final LoggerContext loggerContext, final ConfigurationSource source, final Component rootComponent) {<a name="line.54"></a>
<span class="sourceLineNo">055</span> super(loggerContext, source);<a name="line.55"></a>
<span class="sourceLineNo">056</span> statusConfig = new StatusConfiguration().withVerboseClasses(VERBOSE_CLASSES).withStatus(getDefaultStatus());<a name="line.56"></a>
<span class="sourceLineNo">057</span> for (final Component component : rootComponent.getComponents()) {<a name="line.57"></a>
<span class="sourceLineNo">058</span> switch (component.getPluginType()) {<a name="line.58"></a>
<span class="sourceLineNo">059</span> case "Scripts": {<a name="line.59"></a>
<span class="sourceLineNo">060</span> scriptsComponent = component;<a name="line.60"></a>
<span class="sourceLineNo">061</span> break;<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span> case "Loggers": {<a name="line.63"></a>
<span class="sourceLineNo">064</span> loggersComponent = component;<a name="line.64"></a>
<span class="sourceLineNo">065</span> break;<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span> case "Appenders": {<a name="line.67"></a>
<span class="sourceLineNo">068</span> appendersComponent = component;<a name="line.68"></a>
<span class="sourceLineNo">069</span> break;<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> case "Filters": {<a name="line.71"></a>
<span class="sourceLineNo">072</span> filtersComponent = component;<a name="line.72"></a>
<span class="sourceLineNo">073</span> break;<a name="line.73"></a>
<span class="sourceLineNo">074</span> }<a name="line.74"></a>
<span class="sourceLineNo">075</span> case "Properties": {<a name="line.75"></a>
<span class="sourceLineNo">076</span> propertiesComponent = component;<a name="line.76"></a>
<span class="sourceLineNo">077</span> break;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> case "CustomLevels": {<a name="line.79"></a>
<span class="sourceLineNo">080</span> customLevelsComponent = component;<a name="line.80"></a>
<span class="sourceLineNo">081</span> break;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> this.rootComponent = rootComponent;<a name="line.85"></a>
<span class="sourceLineNo">086</span> }<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> @Override<a name="line.88"></a>
<span class="sourceLineNo">089</span> public void setup() {<a name="line.89"></a>
<span class="sourceLineNo">090</span> final List&lt;Node&gt; children = rootNode.getChildren();<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (propertiesComponent.getComponents().size() &gt; 0) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> children.add(convertToNode(rootNode, propertiesComponent));<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span> if (scriptsComponent.getComponents().size() &gt; 0) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> children.add(convertToNode(rootNode, scriptsComponent));<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span> if (customLevelsComponent.getComponents().size() &gt; 0) {<a name="line.97"></a>
<span class="sourceLineNo">098</span> children.add(convertToNode(rootNode, customLevelsComponent));<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span> children.add(convertToNode(rootNode, loggersComponent));<a name="line.100"></a>
<span class="sourceLineNo">101</span> children.add(convertToNode(rootNode, appendersComponent));<a name="line.101"></a>
<span class="sourceLineNo">102</span> if (filtersComponent.getComponents().size() &gt; 0) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> if (filtersComponent.getComponents().size() == 1) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> children.add(convertToNode(rootNode, filtersComponent.getComponents().get(0)));<a name="line.104"></a>
<span class="sourceLineNo">105</span> } else {<a name="line.105"></a>
<span class="sourceLineNo">106</span> children.add(convertToNode(rootNode, filtersComponent));<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>
<span class="sourceLineNo">109</span> rootComponent = null;<a name="line.109"></a>
<span class="sourceLineNo">110</span> }<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span> public String getContentType() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return this.contentType;<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> public void setContentType(final String contentType) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> this.contentType = contentType;<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> public void createAdvertiser(final String advertiserString, final ConfigurationSource configSource) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> byte[] buffer = null;<a name="line.121"></a>
<span class="sourceLineNo">122</span> try {<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (configSource != null) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> final InputStream is = configSource.getInputStream();<a name="line.124"></a>
<span class="sourceLineNo">125</span> if (is != null) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> buffer = toByteArray(is);<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> } catch (final IOException ioe) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> LOGGER.warn("Unable to read configuration source " + configSource.toString());<a name="line.130"></a>
<span class="sourceLineNo">131</span> }<a name="line.131"></a>
<span class="sourceLineNo">132</span> super.createAdvertiser(advertiserString, configSource, buffer, contentType);<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> public StatusConfiguration getStatusConfiguration() {<a name="line.135"></a>
<span class="sourceLineNo">136</span> return statusConfig;<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> public void setPluginPackages(final String packages) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> pluginPackages.addAll(Arrays.asList(packages.split(Patterns.COMMA_SEPARATOR)));<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> public void setShutdownHook(final String flag) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> isShutdownHookEnabled = !"disable".equalsIgnoreCase(flag);<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> public void setShutdownTimeoutMillis(final long shutdownTimeoutMillis) {<a name="line.147"></a>
<span class="sourceLineNo">148</span> this.shutdownTimeoutMillis = shutdownTimeoutMillis;<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> public void setMonitorInterval(final int intervalSeconds) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> if (this instanceof Reconfigurable &amp;&amp; intervalSeconds &gt; 0) {<a name="line.152"></a>
<span class="sourceLineNo">153</span> initializeWatchers((Reconfigurable) this, getConfigurationSource(), intervalSeconds);<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> }<a name="line.155"></a>
<span class="sourceLineNo">156</span><a name="line.156"></a>
<span class="sourceLineNo">157</span> @Override<a name="line.157"></a>
<span class="sourceLineNo">158</span> public PluginManager getPluginManager() {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return pluginManager;<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> protected Node convertToNode(final Node parent, final Component component) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> final String name = component.getPluginType();<a name="line.163"></a>
<span class="sourceLineNo">164</span> final PluginType&lt;?&gt; pluginType = pluginManager.getPluginType(name);<a name="line.164"></a>
<span class="sourceLineNo">165</span> final Node node = new Node(parent, name, pluginType);<a name="line.165"></a>
<span class="sourceLineNo">166</span> node.getAttributes().putAll(component.getAttributes());<a name="line.166"></a>
<span class="sourceLineNo">167</span> node.setValue(component.getValue());<a name="line.167"></a>
<span class="sourceLineNo">168</span> final List&lt;Node&gt; children = node.getChildren();<a name="line.168"></a>
<span class="sourceLineNo">169</span> for (final Component child : component.getComponents()) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> children.add(convertToNode(node, child));<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> return node;<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span>}<a name="line.174"></a>
</pre>
</div>
</body>
</html>