| <!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>CsvParameterLayout xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/layout/CsvParameterLayout.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.core.layout; |
| <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.nio.charset.Charset; |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.commons.csv.CSVFormat; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.commons.csv.QuoteMode; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Layout; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Node; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttribute; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginConfiguration; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.message.Message; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * A Comma-Separated Value (CSV) layout to log event parameters.</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * The event message is currently ignored.</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * Best used with:</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * {@code logger.debug(new ObjectArrayMessage(1, 2, "Bob"));}</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Depends on Apache Commons CSV 1.4.</em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @since 2.4</em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> @Plugin(name = <span class="jxr_string">"CsvParameterLayout"</span>, category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/CsvParameterLayout.html">CsvParameterLayout</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">AbstractCsvLayout</a> { |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">AbstractCsvLayout</a> createDefaultLayout() { |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/CsvParameterLayout.html">CsvParameterLayout</a>(<strong class="jxr_keyword">null</strong>, Charset.forName(DEFAULT_CHARSET), CSVFormat.valueOf(DEFAULT_FORMAT), <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> } |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">AbstractCsvLayout</a> createLayout(<strong class="jxr_keyword">final</strong> CSVFormat format) { |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/CsvParameterLayout.html">CsvParameterLayout</a>(<strong class="jxr_keyword">null</strong>, Charset.forName(DEFAULT_CHARSET), format, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> } |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> @PluginFactory |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">AbstractCsvLayout</a> createLayout( |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_comment">// @formatter:off</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> @PluginConfiguration <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> @PluginAttribute(value = <span class="jxr_string">"format"</span>, defaultString = DEFAULT_FORMAT) <strong class="jxr_keyword">final</strong> String format, |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> @PluginAttribute(<span class="jxr_string">"delimiter"</span>) <strong class="jxr_keyword">final</strong> Character delimiter, |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> @PluginAttribute(<span class="jxr_string">"escape"</span>) <strong class="jxr_keyword">final</strong> Character escape, |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> @PluginAttribute(<span class="jxr_string">"quote"</span>) <strong class="jxr_keyword">final</strong> Character quote, |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> @PluginAttribute(<span class="jxr_string">"quoteMode"</span>) <strong class="jxr_keyword">final</strong> QuoteMode quoteMode, |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> @PluginAttribute(<span class="jxr_string">"nullString"</span>) <strong class="jxr_keyword">final</strong> String nullString, |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> @PluginAttribute(<span class="jxr_string">"recordSeparator"</span>) <strong class="jxr_keyword">final</strong> String recordSeparator, |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> @PluginAttribute(value = <span class="jxr_string">"charset"</span>, defaultString = DEFAULT_CHARSET) <strong class="jxr_keyword">final</strong> Charset charset, |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> @PluginAttribute(<span class="jxr_string">"header"</span>) <strong class="jxr_keyword">final</strong> String header, |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> @PluginAttribute(<span class="jxr_string">"footer"</span>) <strong class="jxr_keyword">final</strong> String footer) |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_comment">// @formatter:on</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> { |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">final</strong> CSVFormat csvFormat = createFormat(format, delimiter, escape, quote, quoteMode, nullString, recordSeparator); |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/CsvParameterLayout.html">CsvParameterLayout</a>(config, charset, csvFormat, header, footer); |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> } |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/CsvParameterLayout.html">CsvParameterLayout</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, <strong class="jxr_keyword">final</strong> Charset charset, <strong class="jxr_keyword">final</strong> CSVFormat csvFormat, <strong class="jxr_keyword">final</strong> String header, <strong class="jxr_keyword">final</strong> String footer) { |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">super</strong>(config, charset, csvFormat, header, footer); |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> } |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> @Override |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">public</strong> String toSerializable(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) { |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">final</strong> Message message = event.getMessage(); |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">final</strong> Object[] parameters = message.getParameters(); |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">final</strong> StringBuilder buffer = getStringBuilder(); |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> getFormat().printRecord(buffer, parameters); |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">return</strong> buffer.toString(); |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> IOException e) { |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> StatusLogger.getLogger().error(message, e); |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">return</strong> getFormat().getCommentMarker() + <span class="jxr_string">" "</span> + e; |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> } |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> } |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 1999–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
