| <!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>ConsoleAppender xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/appender/ConsoleAppender.html">View Javadoc</a></div><pre> |
| |
| <a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em> |
| <a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em> |
| <a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em> |
| <a class="jxr_linenumber" name="5" href="#5">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="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em> |
| <a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em> |
| <a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em> |
| <a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em> |
| <a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em> |
| <a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em> |
| <a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.appender; |
| <a class="jxr_linenumber" name="18" href="#18">18</a> |
| <a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Filter; |
| <a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Layout; |
| <a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.Plugin; |
| <a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginAttr; |
| <a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginElement; |
| <a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.plugins.PluginFactory; |
| <a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.layout.PatternLayout; |
| <a class="jxr_linenumber" name="26" href="#26">26</a> |
| <a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.io.OutputStream; |
| <a class="jxr_linenumber" name="28" href="#28">28</a> |
| <a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * ConsoleAppender appends log events to <code>System.out</code> or</em> |
| <a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <code>System.err</code> using a layout specified by the user. The</em> |
| <a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * default target is <code>System.out</code>.</em> |
| <a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @doubt accessing System.out or .err as a byte stream instead of a writer</em> |
| <a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * bypasses the JVM's knowledge of the proper encoding. (RG) Encoding</em> |
| <a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * is handled within the Layout. Typically, a Layout will generate a String</em> |
| <a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * and then call getBytes which may use a configured encoding or the system</em> |
| <a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * default. OTOH, a Writer cannot print byte streams.</em> |
| <a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="39" href="#39">39</a> @Plugin(name = <span class="jxr_string">"Console"</span>, type = <span class="jxr_string">"Core"</span>, elementType = <span class="jxr_string">"appender"</span>, printObject = <strong class="jxr_keyword">true</strong>) |
| <a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">ConsoleAppender</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamAppender.html">OutputStreamAppender</a> { |
| <a class="jxr_linenumber" name="41" href="#41">41</a> |
| <a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ManagerFactory.html">ManagerFactory</a> factory = <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">ConsoleManagerFactory</a>(); |
| <a class="jxr_linenumber" name="43" href="#43">43</a> |
| <a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Enumeration of console destinations.</em> |
| <a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> enum <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">Target</a> { |
| <a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Standard output. */</em> |
| <a class="jxr_linenumber" name="49" href="#49">49</a> SYSTEM_OUT, |
| <a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Standard error output. */</em> |
| <a class="jxr_linenumber" name="51" href="#51">51</a> SYSTEM_ERR |
| <a class="jxr_linenumber" name="52" href="#52">52</a> } |
| <a class="jxr_linenumber" name="53" href="#53">53</a> |
| <a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">ConsoleAppender</a>(String name, <a href="../../../../../../org/apache/logging/log4j/core/Layout.html">Layout</a> layout, <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter, <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html">OutputStreamManager</a> manager, |
| <a class="jxr_linenumber" name="55" href="#55">55</a> <strong class="jxr_keyword">boolean</strong> handleExceptions) { |
| <a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">super</strong>(name, layout, filter, handleExceptions, <strong class="jxr_keyword">true</strong>, manager); |
| <a class="jxr_linenumber" name="57" href="#57">57</a> } |
| <a class="jxr_linenumber" name="58" href="#58">58</a> |
| <a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * Create a Console Appender.</em> |
| <a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param layout The layout to use (required).</em> |
| <a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param filter The Filter or null.</em> |
| <a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @param t The target ("SYSTEM_OUT" or "SYSTEM_ERR"). The default is "SYSTEM_OUT".</em> |
| <a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @param name The name of the Appender (required).</em> |
| <a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @param suppress "true" if exceptions should be hidden from the application, "false" otherwise.</em> |
| <a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * The default is "true".</em> |
| <a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @return The ConsoleAppender.</em> |
| <a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="69" href="#69">69</a> @PluginFactory |
| <a class="jxr_linenumber" name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">ConsoleAppender</a> createAppender(@PluginElement(<span class="jxr_string">"layout"</span>) <a href="../../../../../../org/apache/logging/log4j/core/Layout.html">Layout</a> layout, |
| <a class="jxr_linenumber" name="71" href="#71">71</a> @PluginElement(<span class="jxr_string">"filters"</span>) <a href="../../../../../../org/apache/logging/log4j/core/Filter.html">Filter</a> filter, |
| <a class="jxr_linenumber" name="72" href="#72">72</a> @PluginAttr(<span class="jxr_string">"target"</span>) String t, |
| <a class="jxr_linenumber" name="73" href="#73">73</a> @PluginAttr(<span class="jxr_string">"name"</span>) String name, |
| <a class="jxr_linenumber" name="74" href="#74">74</a> @PluginAttr(<span class="jxr_string">"suppressExceptions"</span>) String suppress) { |
| <a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">if</strong> (name == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="76" href="#76">76</a> LOGGER.error(<span class="jxr_string">"No name provided for ConsoleAppender"</span>); |
| <a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="78" href="#78">78</a> } |
| <a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">if</strong> (layout == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="80" href="#80">80</a> layout = PatternLayout.createLayout(<strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="81" href="#81">81</a> } |
| <a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">boolean</strong> handleExceptions = suppress == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">true</strong> : Boolean.valueOf(suppress); |
| <a class="jxr_linenumber" name="83" href="#83">83</a> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">Target</a> target = t == <strong class="jxr_keyword">null</strong> ? Target.SYSTEM_OUT : Target.valueOf(t); |
| <a class="jxr_linenumber" name="84" href="#84">84</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">ConsoleAppender</a>(name, layout, filter, getManager(target), handleExceptions); |
| <a class="jxr_linenumber" name="85" href="#85">85</a> } |
| <a class="jxr_linenumber" name="86" href="#86">86</a> |
| <a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html">OutputStreamManager</a> getManager(<a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">Target</a> target) { |
| <a class="jxr_linenumber" name="88" href="#88">88</a> String type = target.name(); |
| <a class="jxr_linenumber" name="89" href="#89">89</a> OutputStream os = target == Target.SYSTEM_OUT ? System.out : System.err; |
| <a class="jxr_linenumber" name="90" href="#90">90</a> <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html">OutputStreamManager</a> manager = OutputStreamManager.getManager(target.name(), factory, |
| <a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FactoryData</a>(os, type)); |
| <a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> manager; |
| <a class="jxr_linenumber" name="93" href="#93">93</a> } |
| <a class="jxr_linenumber" name="94" href="#94">94</a> |
| <a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Data to pass to factory method.</em> |
| <a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FactoryData</a> { |
| <a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">private</strong> OutputStream os; |
| <a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">private</strong> String type; |
| <a class="jxr_linenumber" name="101" href="#101">101</a> |
| <a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * Constructor.</em> |
| <a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param os The OutputStream.</em> |
| <a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param type The name of the target.</em> |
| <a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FactoryData</a>(OutputStream os, String type) { |
| <a class="jxr_linenumber" name="108" href="#108">108</a> <strong class="jxr_keyword">this</strong>.os = os; |
| <a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">this</strong>.type = type; |
| <a class="jxr_linenumber" name="110" href="#110">110</a> } |
| <a class="jxr_linenumber" name="111" href="#111">111</a> } |
| <a class="jxr_linenumber" name="112" href="#112">112</a> |
| <a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * Factory to create the Appender.</em> |
| <a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="116" href="#116">116</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/ConsoleAppender.html">ConsoleManagerFactory</a> <strong class="jxr_keyword">implements</strong> ManagerFactory<OutputStreamManager, FactoryData> { |
| <a class="jxr_linenumber" name="117" href="#117">117</a> |
| <a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * Create an OutputStreamManager.</em> |
| <a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> * @param name The name of the entity to manage.</em> |
| <a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @param data The data required to create the entity.</em> |
| <a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * @return The OutputStreamManager</em> |
| <a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html">OutputStreamManager</a> createManager(String name, <a href="../../../../../../org/apache/logging/log4j/core/appender/FileManager.html">FactoryData</a> data) { |
| <a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/logging/log4j/core/appender/OutputStreamManager.html">OutputStreamManager</a>(data.os, data.type); |
| <a class="jxr_linenumber" name="126" href="#126">126</a> } |
| <a class="jxr_linenumber" name="127" href="#127">127</a> } |
| <a class="jxr_linenumber" name="128" href="#128">128</a> |
| <a class="jxr_linenumber" name="129" href="#129">129</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
