| <!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="../../../../../../javadoc.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 contributor license agreements. See the NOTICE file *<a name="line.2"></a> |
| <span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a> |
| <span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> |
| <span class="sourceLineNo">006</span>// * *<a name="line.6"></a> |
| <span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> |
| <span class="sourceLineNo">008</span>// * *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a> |
| <span class="sourceLineNo">013</span>package org.apache.juneau.rest.logging;<a name="line.13"></a> |
| <span class="sourceLineNo">014</span><a name="line.14"></a> |
| <span class="sourceLineNo">015</span>import static org.apache.juneau.collections.JsonMap.*;<a name="line.15"></a> |
| <span class="sourceLineNo">016</span>import static org.apache.juneau.internal.ObjectUtils.*;<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>import static org.apache.juneau.internal.StringUtils.*;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>import static org.apache.juneau.rest.logging.RestLoggingDetail.*;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.util.function.*;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.logging.*;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import javax.servlet.http.*;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.juneau.*;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.juneau.cp.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.juneau.internal.*;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.juneau.rest.annotation.*;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.juneau.rest.stats.*;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.juneau.rest.util.*;<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> * Basic implementation of a {@link RestLogger} for logging HTTP requests.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <p><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Provides the following capabilities:<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * <ul><a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <li>Allows incoming HTTP requests to be logged at various {@link Enablement detail levels}.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * <li>Allows rules to be defined to handle request logging differently depending on the resulting status code.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <li>Allows use of stack trace hashing to eliminate duplication of stack traces in log files.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <li>Allows customization of handling of where requests are logged to.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * <li>Allows configuration via system properties or environment variables.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> *<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * <p><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * The following is an example of a logger that logs errors only when debugging is not enabled, and everything when<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * logging is enabled.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * <h5 class='section'>Example:</h5><a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p class='bjava'><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * RestLogger <jv>logger</jv> = RestLogger<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * .<jsm>create</jsm>()<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * .logger(<js>"MyLogger"</js>) <jc>// Use MyLogger Java logger.</jc><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * .normalRules( <jc>// Rules when debugging is not enabled.</jc><a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * <jsm>createRule</jsm>() <jc>// Log 500+ errors with status-line and header information.</jc><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * .statusFilter(x -&gt; x &gt;= 500)<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * .level(<jsf>SEVERE</jsf>)<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * .requestDetail(<jsf>HEADER</jsf>)<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * .responseDetail<jsf>(HEADER</jsf>)<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * .build(),<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * <jsm>createRule</jsm>() <jc>// Log 400-500 errors with just status-line information.</jc><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * .statusFilter(x -&gt; x &gt;= 400)<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * .level(<jsf>WARNING</jsf>)<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * .requestDetail(<jsf>STATUS_LINE</jsf>)<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * .responseDetail(<jsf>STATUS_LINE</jsf>)<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * .build()<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * )<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * .debugRules( <jc>// Rules when debugging is enabled.</jc><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <jsm>createRule</jsm>() <jc>// Log everything with full details.</jc><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * .level(<jsf>SEVERE</jsf>)<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * .requestDetail(<jsf>ENTITY</jsf>)<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * .responseDetail(<jsf>ENTITY</jsf>)<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * .build()<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * )<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * .build()<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * ;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * </p><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * <ul class='seealso'><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#callLogger()}<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#debugEnablement()}<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * <li class='jm'>{@link org.apache.juneau.rest.RestContext.Builder#debugOn(String)}<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * <li class='ja'>{@link Rest#debug}<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * <li class='ja'>{@link RestOp#debug}<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * <li class='link'>{@doc jrs.LoggingAndDebugging}<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * <li class='extlink'>{@source}<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * </ul><a name="line.87"></a> |
| <span class="sourceLineNo">088</span> */<a name="line.88"></a> |
| <span class="sourceLineNo">089</span>public class BasicRestLogger implements RestLogger {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> private static final RestLoggerRule DEFAULT_RULE = RestLoggerRule.create(BeanStore.INSTANCE).build();<a name="line.91"></a> |
| <span class="sourceLineNo">092</span><a name="line.92"></a> |
| <span class="sourceLineNo">093</span> private final Logger logger;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> private final ThrownStore thrownStore;<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> private final RestLoggerRule[] normalRules, debugRules;<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> private final Enablement enabled;<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> private final Predicate<HttpServletRequest> enabledTest;<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> private final Level level;<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> private final RestLoggingDetail requestDetail, responseDetail;<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> * Constructor.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> *<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * @param builder The builder object.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> */<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public BasicRestLogger(RestLogger.Builder builder) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> this.logger = builder.logger;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> this.thrownStore = builder.thrownStore;<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> this.normalRules = builder.normalRules.toArray(new RestLoggerRule[builder.normalRules.size()]);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> this.debugRules = builder.debugRules.toArray(new RestLoggerRule[builder.debugRules.size()]);<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> this.enabled = builder.enabled;<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> this.enabledTest = builder.enabledTest;<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> this.requestDetail = builder.requestDetail;<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> this.responseDetail = builder.responseDetail;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> this.level = builder.level;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> /**<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * Called at the end of a servlet request to log the request.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> *<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * @param req The servlet request.<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * @param res The servlet response.<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> */<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> @Override /* RestLogger */<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> public void log(HttpServletRequest req, HttpServletResponse res) {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> RestLoggerRule rule = getRule(req, res);<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> if (! isEnabled(rule, req))<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> return;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> Level level = firstNonNull(rule.getLevel(), this.level);<a name="line.132"></a> |
| <span class="sourceLineNo">133</span><a name="line.133"></a> |
| <span class="sourceLineNo">134</span> if (level == Level.OFF)<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> return;<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> Throwable e = castOrNull(req.getAttribute("Exception"), Throwable.class);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> Long execTime = castOrNull(req.getAttribute("ExecTime"), Long.class);<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> RestLoggingDetail reqd = firstNonNull(rule.getRequestDetail(), requestDetail);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> RestLoggingDetail resd = firstNonNull(rule.getResponseDetail(), responseDetail);<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> String method = req.getMethod();<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> int status = res.getStatus();<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> String uri = req.getRequestURI();<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> byte[] reqContent = getRequestContent(req);<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> byte[] resContent = getResponseContent(req, res);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> StringBuilder sb = new StringBuilder();<a name="line.149"></a> |
| <span class="sourceLineNo">150</span><a name="line.150"></a> |
| <span class="sourceLineNo">151</span> if (reqd != STATUS_LINE || resd != STATUS_LINE)<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> sb.append("\n=== HTTP Call (incoming) ======================================================\n");<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> ThrownStats sti = getThrownStats(e);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span><a name="line.155"></a> |
| <span class="sourceLineNo">156</span> sb.append('[').append(status);<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> if (sti != null) {<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> int count = sti.getCount();<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> sb.append(',').append(StringUtils.toHex8(sti.getHash())).append('.').append(count);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> if (count > 1)<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> e = null;<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> sb.append("] ");<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> sb.append("HTTP ").append(method).append(' ').append(uri);<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> if (reqd != STATUS_LINE || resd != STATUS_LINE) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> if (reqd.isOneOf(HEADER, ENTITY)) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> String qs = req.getQueryString();<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> if (qs != null)<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> sb.append('?').append(qs);<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> if (reqContent != null && reqd.isOneOf(HEADER ,ENTITY))<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> sb.append("\n\tRequest length: ").append(reqContent.length).append(" bytes");<a name="line.178"></a> |
| <span class="sourceLineNo">179</span><a name="line.179"></a> |
| <span class="sourceLineNo">180</span> if (resd.isOneOf(HEADER, ENTITY))<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> sb.append("\n\tResponse code: ").append(status);<a name="line.181"></a> |
| <span class="sourceLineNo">182</span><a name="line.182"></a> |
| <span class="sourceLineNo">183</span> if (resContent != null && resd.isOneOf(HEADER, ENTITY))<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> sb.append("\n\tResponse length: ").append(resContent.length).append(" bytes");<a name="line.184"></a> |
| <span class="sourceLineNo">185</span><a name="line.185"></a> |
| <span class="sourceLineNo">186</span> if (execTime != null && resd.isOneOf(HEADER, ENTITY))<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> sb.append("\n\tExec time: ").append(execTime).append("ms");<a name="line.187"></a> |
| <span class="sourceLineNo">188</span><a name="line.188"></a> |
| <span class="sourceLineNo">189</span> if (reqd.isOneOf(HEADER, ENTITY)) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> Enumeration<String> hh = req.getHeaderNames();<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> if (hh.hasMoreElements()) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> sb.append("\n---Request Headers---");<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> while (hh.hasMoreElements()) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> String h = hh.nextElement();<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> sb.append("\n\t").append(h).append(": ").append(req.getHeader(h));<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> }<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> if (resd.isOneOf(HEADER, ENTITY)) {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> Collection<String> hh = res.getHeaderNames();<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> if (hh.size() > 0) {<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> sb.append("\n---Response Headers---");<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> for (String h : hh) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> sb.append("\n\t").append(h).append(": ").append(res.getHeader(h));<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> if (reqContent != null && reqContent.length > 0 && reqd == ENTITY) {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> try {<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> sb.append("\n---Request Content UTF-8---");<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> sb.append("\n").append(new String(reqContent, IOUtils.UTF8));<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> sb.append("\n---Request Content Hex---");<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> sb.append("\n").append(toSpacedHex(reqContent));<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> } catch (Exception e1) {<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> sb.append("\n").append(e1.getLocalizedMessage());<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> }<a name="line.219"></a> |
| <span class="sourceLineNo">220</span><a name="line.220"></a> |
| <span class="sourceLineNo">221</span> if (resContent != null && resContent.length > 0 && resd == ENTITY) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> try {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> sb.append("\n---Response Content UTF-8---");<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> sb.append("\n").append(new String(resContent, IOUtils.UTF8));<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> sb.append("\n---Response Content Hex---");<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> sb.append("\n").append(toSpacedHex(resContent));<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> } catch (Exception e1) {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> sb.append(e1.getLocalizedMessage());<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> }<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> }<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> sb.append("\n=== END ======================================================================");<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> }<a name="line.232"></a> |
| <span class="sourceLineNo">233</span><a name="line.233"></a> |
| <span class="sourceLineNo">234</span> if (rule.isLogStackTrace() && e == null)<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> e = new Throwable("Stacktrace");<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> log(level, sb.toString(), e);<a name="line.237"></a> |
| <span class="sourceLineNo">238</span><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> }<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> /**<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> * Given the specified servlet request/response, find the rule that applies to it.<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> *<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> * <p><a name="line.244"></a> |
| <span class="sourceLineNo">245</span> * This method can be overridden to provide specialized logic for finding rules.<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> *<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> * @param req The servlet request.<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> * @param res The servlet response.<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> * @return The applicable logging rule, or the default rule if not found. Never <jk>null</jk>.<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> */<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> protected RestLoggerRule getRule(HttpServletRequest req, HttpServletResponse res) {<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> for (RestLoggerRule r : isDebug(req) ? debugRules : normalRules)<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> if (r.matches(req, res))<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> return r;<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> return DEFAULT_RULE;<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> }<a name="line.256"></a> |
| <span class="sourceLineNo">257</span><a name="line.257"></a> |
| <span class="sourceLineNo">258</span> /**<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> * Returns <jk>true</jk> if debug is enabled on this request.<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> *<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> * <p><a name="line.261"></a> |
| <span class="sourceLineNo">262</span> * Looks for the request attribute <js>"Debug"</js> to determine whether debug is enabled.<a name="line.262"></a> |
| <span class="sourceLineNo">263</span> *<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> * <p><a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * This method can be overridden to provide specialized logic for determining whether debug mode is enabled on a request.<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> *<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * @param req The HTTP request being logged.<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @return <jk>true</jk> if debug is enabled on this request.<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @see org.apache.juneau.rest.RestContext.Builder#debugEnablement()<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * @see org.apache.juneau.rest.RestContext.Builder#debugOn(String)<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> * @see Rest#debug()<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> * @see RestOp#debug()<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> */<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> protected boolean isDebug(HttpServletRequest req) {<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> return firstNonNull(castOrNull(req.getAttribute("Debug"), Boolean.class), false);<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> /**<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * Returns <jk>true</jk> if logging is enabled for this request.<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> *<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * <p><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * Uses the enabled and enabled-test settings on the matched rule and this logger to determine whether a REST<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * call should be logged.<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> *<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * <p><a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * This method can be overridden to provide specialized logic for determining whether a REST call should be logged.<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> *<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * @param rule The first matching rule. Never <jk>null</jk>.<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * @param req The HTTP request.<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * @return <jk>true</jk> if logging is enabled for this request.<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> */<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> protected boolean isEnabled(RestLoggerRule rule, HttpServletRequest req) {<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> Enablement enabled = firstNonNull(rule.getEnabled(), this.enabled);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> Predicate<HttpServletRequest> enabledTest = firstNonNull(rule.getEnabledTest(), this.enabledTest);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> return enabled.isEnabled(enabledTest.test(req));<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> }<a name="line.296"></a> |
| <span class="sourceLineNo">297</span><a name="line.297"></a> |
| <span class="sourceLineNo">298</span><a name="line.298"></a> |
| <span class="sourceLineNo">299</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> // Other methods<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.301"></a> |
| <span class="sourceLineNo">302</span><a name="line.302"></a> |
| <span class="sourceLineNo">303</span> /**<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> * Returns the logger to use for logging REST calls.<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> *<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * <p><a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * Returns the logger specified in the builder, or {@link Logger#getGlobal()} if it wasn't specified.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> *<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * <p><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * This method can be overridden in subclasses to provide a different logger.<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> *<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * @return The logger to use for logging REST calls.<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> */<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> protected Logger getLogger() {<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> return logger;<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> }<a name="line.316"></a> |
| <span class="sourceLineNo">317</span><a name="line.317"></a> |
| <span class="sourceLineNo">318</span> /**<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * Logs the specified message to the logger.<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> *<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * <p><a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * Subclasses can override this method to capture messages being sent to the logger and handle it differently.<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> *<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> * @param level The log level.<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> * @param msg The log message.<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> * @param e The exception.<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> */<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> protected void log(Level level, String msg, Throwable e) {<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> getLogger().log(level, msg, e);<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> }<a name="line.330"></a> |
| <span class="sourceLineNo">331</span><a name="line.331"></a> |
| <span class="sourceLineNo">332</span> private byte[] getRequestContent(HttpServletRequest req) {<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> if (req instanceof CachingHttpServletRequest)<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> return ((CachingHttpServletRequest)req).getContent();<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> return castOrNull(req.getAttribute("RequestContent"), byte[].class);<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> }<a name="line.336"></a> |
| <span class="sourceLineNo">337</span><a name="line.337"></a> |
| <span class="sourceLineNo">338</span> private byte[] getResponseContent(HttpServletRequest req, HttpServletResponse res) {<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> if (res instanceof CachingHttpServletResponse)<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> return ((CachingHttpServletResponse)res).getContent();<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return castOrNull(req.getAttribute("ResponseContent"), byte[].class);<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> private ThrownStats getThrownStats(Throwable e) {<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> if (e == null || thrownStore == null)<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> return null;<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> return thrownStore.getStats(e).orElse(null);<a name="line.347"></a> |
| <span class="sourceLineNo">348</span> }<a name="line.348"></a> |
| <span class="sourceLineNo">349</span><a name="line.349"></a> |
| <span class="sourceLineNo">350</span> @Override /* Object */<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> public String toString() {<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> return filteredMap()<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> .append("logger", logger)<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> .append("thrownStore", thrownStore)<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> .append("enabled", enabled)<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> .append("level", level)<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> .append("requestDetail", requestDetail)<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> .append("responseDetail", responseDetail)<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> .append("normalRules", normalRules.length == 0 ? null : normalRules)<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> .append("debugRules", debugRules.length == 0 ? null : debugRules)<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> .asReadableString();<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> }<a name="line.362"></a> |
| <span class="sourceLineNo">363</span>}<a name="line.363"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
