blob: fbb860a02c2b5c0c61f1ff1d4c6d9f61c5940ff6 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>RequestContextFilter xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/audit/rest/RequestContextFilter.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.audit.<strong class="jxr_keyword">rest</strong>;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.text.DecimalFormat;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterChain;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterConfig;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletException;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletRequest;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> javax.servlet.ServletResponse;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletResponse;
<a class="jxr_linenumber" name="L31" href="#L31">31</a>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.LogManager;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.ThreadContext;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.audit.request.ChainedMapping;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.audit.request.RequestContextMapping;
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.audit.request.RequestContextMappings;
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Filter to initialize and clear the RequestContext.</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/audit/rest/RequestContextFilter.html">RequestContextFilter</a> <strong class="jxr_keyword">implements</strong> Filter {
<a class="jxr_linenumber" name="L43" href="#L43">43</a>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger logger = LogManager.getLogger(RequestContextFilter.<strong class="jxr_keyword">class</strong>);
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Class&lt;?&gt; requestContextClass;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/audit/request/RequestContextMappings.html">RequestContextMappings</a> mappings;
<a class="jxr_linenumber" name="L47" href="#L47">47</a>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/audit/rest/RequestContextFilter.html">RequestContextFilter</a>() {
<a class="jxr_linenumber" name="L49" href="#L49">49</a> requestContextClass = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L50" href="#L50">50</a> }
<a class="jxr_linenumber" name="L51" href="#L51">51</a>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/audit/rest/RequestContextFilter.html">RequestContextFilter</a>(Class&lt;?&gt; clazz) {
<a class="jxr_linenumber" name="L53" href="#L53">53</a> requestContextClass = clazz;
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @param filterConfig</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @throws ServletException</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> @Override
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init(FilterConfig filterConfig) <strong class="jxr_keyword">throws</strong> ServletException {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">if</strong> (requestContextClass != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> mappings = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/audit/request/RequestContextMappings.html">RequestContextMappings</a>(requestContextClass);
<a class="jxr_linenumber" name="L64" href="#L64">64</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L65" href="#L65">65</a> String requestContextClassName = filterConfig.getInitParameter(<span class="jxr_string">"requestContextClass"</span>);
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (requestContextClassName == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> logger.error(<span class="jxr_string">"No RequestContext class name was provided"</span>);
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"No RequestContext class name provided"</span>);
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a> mappings = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/audit/request/RequestContextMappings.html">RequestContextMappings</a>(requestContextClassName);
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
<a class="jxr_linenumber" name="L72" href="#L72">72</a> }
<a class="jxr_linenumber" name="L73" href="#L73">73</a>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Manages the initialization and clearing of the RequestContext.</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">throws</strong> IOException, ServletException {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">if</strong> (servletRequest instanceof HttpServletRequest) {
<a class="jxr_linenumber" name="L80" href="#L80">80</a> HttpServletRequest request = (HttpServletRequest) servletRequest;
<a class="jxr_linenumber" name="L81" href="#L81">81</a> HttpServletResponse response = (HttpServletResponse) servletResponse;
<a class="jxr_linenumber" name="L82" href="#L82">82</a> logger.info(<span class="jxr_string">"Starting request {}"</span> + request.getRequestURI());
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L84" href="#L84">84</a> Enumeration headers = request.getHeaderNames();
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">while</strong> (headers.hasMoreElements()) {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> String name = (String) headers.nextElement();
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <a href="../../../../../../org/apache/logging/log4j/audit/request/RequestContextMapping.html">RequestContextMapping</a> mapping = mappings.getMappingByHeader(name);
<a class="jxr_linenumber" name="L88" href="#L88">88</a> logger.debug(<span class="jxr_string">"Got Mapping:{} for Header:{}"</span>, mapping, name);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (mapping != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (mapping.isChained()) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> ThreadContext.put(mapping.getChainKey(), request.getHeader(name));
<a class="jxr_linenumber" name="L92" href="#L92">92</a> logger.debug(<span class="jxr_string">"Setting Context Key:{} with value:{}"</span>, mapping.getChainKey(), request.getHeader(name));
<a class="jxr_linenumber" name="L93" href="#L93">93</a> String value = ((ChainedMapping)mapping).getSupplier().get();
<a class="jxr_linenumber" name="L94" href="#L94">94</a> ThreadContext.put(mapping.getFieldName(), value);
<a class="jxr_linenumber" name="L95" href="#L95">95</a> logger.debug(<span class="jxr_string">"Setting Context Key:{} with value:{}"</span>, mapping.getFieldName(), value);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> ThreadContext.put(mapping.getFieldName(), request.getHeader(name));
<a class="jxr_linenumber" name="L98" href="#L98">98</a> logger.debug(<span class="jxr_string">"Setting Context Key:{} with value:{}"</span>, mapping.getFieldName(), request.getHeader(name));
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a> }
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">long</strong> start = System.nanoTime();
<a class="jxr_linenumber" name="L103" href="#L103">103</a> filterChain.doFilter(servletRequest, servletResponse);
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">long</strong> elapsed = System.nanoTime() - start;
<a class="jxr_linenumber" name="L105" href="#L105">105</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(<span class="jxr_string">"Request "</span>).append(request.getRequestURI()).append(<span class="jxr_string">" completed in "</span>);
<a class="jxr_linenumber" name="L106" href="#L106">106</a> ElapsedUtil.addElapsed(elapsed, sb);
<a class="jxr_linenumber" name="L107" href="#L107">107</a> logger.info(sb.toString());
<a class="jxr_linenumber" name="L108" href="#L108">108</a> } <strong class="jxr_keyword">catch</strong> (Throwable e) {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> logger.error(<span class="jxr_string">"Application cascaded error"</span>, e);
<a class="jxr_linenumber" name="L110" href="#L110">110</a> response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
<a class="jxr_linenumber" name="L111" href="#L111">111</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> ThreadContext.clearMap();
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
<a class="jxr_linenumber" name="L116" href="#L116">116</a>
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> destroy() {
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2016&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>