Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-appserver / apidocs / src-html / org / apache / logging / log4j / appserver / tomcat / TomcatLogger.html
blob: 5d7bb14e41e14f1c4b66cda06614ba49c71488cf [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.appserver.tomcat;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.net.URI;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.net.URISyntaxException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.net.URL;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.juli.logging.Log;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.Level;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.LogManager;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.spi.ExtendedLogger;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.spi.LoggerContext;<a name="line.27"></a>
<span class="sourceLineNo">028</span><a name="line.28"></a>
<span class="sourceLineNo">029</span>/**<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Implements the Log interface from Tomcat 8.5 and greater.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * In order to use this class to cause Tomcat to use Log4j for logging, the jar containing this class as well as the<a name="line.32"></a>
<span class="sourceLineNo">033</span> * log4j-api and log4j-core jars must be added to Tomcat's boot classpath. This is most easily accomplished by<a name="line.33"></a>
<span class="sourceLineNo">034</span> * placing these jars in a directory and then adding the contents of that directory to the CLASSPATH<a name="line.34"></a>
<span class="sourceLineNo">035</span> * environment variable in setenv.sh in Tomcat's bin directory.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * The Log4j configuration file must also be present on the classpath. This implementation will use the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * first file it finds with one of the following file names: log4j2-tomcat.xml, log4j2-tomcat.json,<a name="line.38"></a>
<span class="sourceLineNo">039</span> * log4j2-tomcat.yaml, log4j2-tomcat.yml, log4j2-tomcat.properties. Again, this can be accomplished by adding<a name="line.39"></a>
<span class="sourceLineNo">040</span> * this file to a directory and then adding that directory to the CLASSPATH environment variable in setenv.sh.<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @since 2.10.0<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>public class TomcatLogger implements Log {<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> private static final long serialVersionUID = 1L;<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static final String FQCN = TomcatLogger.class.getName();<a name="line.47"></a>
<span class="sourceLineNo">048</span> private static final String[] FILE_NAMES = {<a name="line.48"></a>
<span class="sourceLineNo">049</span> "log4j2-tomcat.xml", "log4j2-tomcat.json", "log4j2-tomcat.yaml", "log4j2-tomcat.yml",<a name="line.49"></a>
<span class="sourceLineNo">050</span> "log4j2-tomcat.properties"<a name="line.50"></a>
<span class="sourceLineNo">051</span> };<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private final ExtendedLogger logger;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * This constructor is used by ServiceLoader to load an instance of the class.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> public TomcatLogger() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> logger = null;<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> * This constructor is used by LogFactory to create a new Logger.<a name="line.63"></a>
<span class="sourceLineNo">064</span> * @param name The name of the Logger.<a name="line.64"></a>
<span class="sourceLineNo">065</span> */<a name="line.65"></a>
<span class="sourceLineNo">066</span> public TomcatLogger(final String name) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> this.logger = PrivateManager.getLogger(name);<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> @Override<a name="line.70"></a>
<span class="sourceLineNo">071</span> public boolean isDebugEnabled() {<a name="line.71"></a>
<span class="sourceLineNo">072</span> return logger.isDebugEnabled();<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public boolean isErrorEnabled() {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return logger.isErrorEnabled();<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> @Override<a name="line.80"></a>
<span class="sourceLineNo">081</span> public boolean isFatalEnabled() {<a name="line.81"></a>
<span class="sourceLineNo">082</span> return logger.isFatalEnabled();<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> @Override<a name="line.85"></a>
<span class="sourceLineNo">086</span> public boolean isInfoEnabled() {<a name="line.86"></a>
<span class="sourceLineNo">087</span> return logger.isInfoEnabled();<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> @Override<a name="line.90"></a>
<span class="sourceLineNo">091</span> public boolean isTraceEnabled() {<a name="line.91"></a>
<span class="sourceLineNo">092</span> return logger.isTraceEnabled();<a name="line.92"></a>
<span class="sourceLineNo">093</span> }<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> @Override<a name="line.95"></a>
<span class="sourceLineNo">096</span> public boolean isWarnEnabled() {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return logger.isWarnEnabled();<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> @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span> public void trace(final Object o) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> logger.logIfEnabled(FQCN, Level.TRACE, null, o, null);<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> @Override<a name="line.105"></a>
<span class="sourceLineNo">106</span> public void trace(final Object o, final Throwable throwable) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> logger.logIfEnabled(FQCN, Level.TRACE, null, o, throwable);<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> @Override<a name="line.110"></a>
<span class="sourceLineNo">111</span> public void debug(final Object o) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> logger.logIfEnabled(FQCN, Level.DEBUG, null, o, null);<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> @Override<a name="line.115"></a>
<span class="sourceLineNo">116</span> public void debug(final Object o, final Throwable throwable) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> logger.logIfEnabled(FQCN, Level.DEBUG, null, o, throwable);<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> @Override<a name="line.120"></a>
<span class="sourceLineNo">121</span> public void info(final Object o) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> logger.logIfEnabled(FQCN, Level.INFO, null, o, null);<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> @Override<a name="line.125"></a>
<span class="sourceLineNo">126</span> public void info(final Object o, final Throwable throwable) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> logger.logIfEnabled(FQCN, Level.INFO, null, o, throwable);<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> @Override<a name="line.130"></a>
<span class="sourceLineNo">131</span> public void warn(final Object o) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> logger.logIfEnabled(FQCN, Level.WARN, null, o, null);<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> @Override<a name="line.135"></a>
<span class="sourceLineNo">136</span> public void warn(final Object o, final Throwable throwable) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> logger.logIfEnabled(FQCN, Level.WARN, null, o, throwable);<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> @Override<a name="line.140"></a>
<span class="sourceLineNo">141</span> public void error(final Object o) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> logger.logIfEnabled(FQCN, Level.ERROR, null, o, null);<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span> @Override<a name="line.145"></a>
<span class="sourceLineNo">146</span> public void error(final Object o, final Throwable throwable) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> logger.logIfEnabled(FQCN, Level.ERROR, null, o, throwable);<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> @Override<a name="line.150"></a>
<span class="sourceLineNo">151</span> public void fatal(final Object o) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> logger.logIfEnabled(FQCN, Level.FATAL, null, o, null);<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span><a name="line.154"></a>
<span class="sourceLineNo">155</span> @Override<a name="line.155"></a>
<span class="sourceLineNo">156</span> public void fatal(final Object o, final Throwable throwable) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> logger.logIfEnabled(FQCN, Level.FATAL, null, o, throwable);<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span><a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * Internal LogManager.<a name="line.161"></a>
<span class="sourceLineNo">162</span> */<a name="line.162"></a>
<span class="sourceLineNo">163</span> private static class PrivateManager extends LogManager {<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> public static LoggerContext getContext() {<a name="line.165"></a>
<span class="sourceLineNo">166</span> final ClassLoader cl = TomcatLogger.class.getClassLoader();<a name="line.166"></a>
<span class="sourceLineNo">167</span> URI uri = null;<a name="line.167"></a>
<span class="sourceLineNo">168</span> for (final String fileName : FILE_NAMES) {<a name="line.168"></a>
<span class="sourceLineNo">169</span> try {<a name="line.169"></a>
<span class="sourceLineNo">170</span> final URL url = cl.getResource(fileName);<a name="line.170"></a>
<span class="sourceLineNo">171</span> if (url != null) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> uri = url.toURI();<a name="line.172"></a>
<span class="sourceLineNo">173</span> break;<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> } catch (final URISyntaxException ex) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> // Ignore the exception.<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> if (uri == null) {<a name="line.179"></a>
<span class="sourceLineNo">180</span> return getContext(FQCN, cl, false);<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> return getContext(FQCN, cl, false, uri, "Tomcat");<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> public static ExtendedLogger getLogger(final String name) {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return getContext().getLogger(name);<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>
<span class="sourceLineNo">189</span>}<a name="line.189"></a>
</pre>
</div>
</body>
</html>