Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.2 / log4j-core / xref / org / apache / logging / log4j / core / appender / db / AbstractDatabaseManager.html
blob: 7cc4cc675d29f6e13c05ce3b2f8fcb317fddeeae [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>AbstractDatabaseManager 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/db/AbstractDatabaseManager.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>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.appender.db;
<a class="jxr_linenumber" name="L19" href="#L19">19</a>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">import</strong> java.io.Flushable;
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.TimeUnit;
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.Layout;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.LogEvent;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.AbstractManager;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.appender.ManagerFactory;
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Manager that allows database appenders to have their configuration reloaded without losing events.</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.html">AbstractDatabaseManager</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/AbstractManager.html">AbstractManager</a> <strong class="jxr_keyword">implements</strong> Flushable {
<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"> * Implementations should extend this class for passing data between the getManager method and the manager factory</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * class.</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> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.html">AbstractFactoryData</a> {
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Layout&lt;? <strong class="jxr_keyword">extends</strong> Serializable&gt; layout;
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Constructs the base factory data.</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"> * @param bufferSize The size of the buffer.</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param bufferSize The appender-level layout</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.html">AbstractFactoryData</a>(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize, <strong class="jxr_keyword">final</strong> Layout&lt;? <strong class="jxr_keyword">extends</strong> Serializable&gt; layout) {
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">this</strong>.bufferSize = bufferSize;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">this</strong>.layout = layout;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Gets the buffer size.</em>
<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"> * @return the buffer size.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getBufferSize() {
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">return</strong> bufferSize;
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> * Gets the layout.</em>
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @return the layout.</em>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> Layout&lt;? <strong class="jxr_keyword">extends</strong> Serializable&gt; getLayout() {
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">return</strong> layout;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Implementations should define their own getManager method and call this method from that to create or get</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * existing managers.</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * @param name The manager name, which should include any configuration details that one might want to be able to</em>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * reconfigure at runtime, such as database name, username, (hashed) password, etc.</em>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param data The concrete instance of {@link AbstractFactoryData} appropriate for the given manager.</em>
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param factory A factory instance for creating the appropriate manager.</em>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @param &lt;M&gt; The concrete manager type.</em>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @param &lt;T&gt; The concrete {@link AbstractFactoryData} type.</em>
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * @return a new or existing manager of the specified type and name.</em>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> &lt;M <strong class="jxr_keyword">extends</strong> AbstractDatabaseManager, T <strong class="jxr_keyword">extends</strong> AbstractFactoryData&gt; M getManager(
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> T data, <strong class="jxr_keyword">final</strong> ManagerFactory&lt;M, T&gt; factory
<a class="jxr_linenumber" name="L86" href="#L86">86</a> ) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">return</strong> AbstractManager.getManager(name, factory, data);
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ArrayList&lt;LogEvent&gt; buffer;
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize;
<a class="jxr_linenumber" name="L91" href="#L91">91</a>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Layout&lt;? <strong class="jxr_keyword">extends</strong> Serializable&gt; layout;
<a class="jxr_linenumber" name="L93" href="#L93">93</a>
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> running;
<a class="jxr_linenumber" name="L95" href="#L95">95</a>
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Instantiates the base manager.</em>
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @param name The manager name, which should include any configuration details that one might want to be able to</em>
<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * reconfigure at runtime, such as database name, username, (hashed) password, etc.</em>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @param bufferSize The size of the log event buffer.</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.html">AbstractDatabaseManager</a>(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize) {
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>(name, bufferSize, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<a class="jxr_linenumber" name="L106" href="#L106">106</a>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Instantiates the base manager.</em>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @param name The manager name, which should include any configuration details that one might want to be able to</em>
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * reconfigure at runtime, such as database name, username, (hashed) password, etc.</em>
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @param layout the Appender-level layout.</em>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * @param bufferSize The size of the log event buffer.</em>
<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../../org/apache/logging/log4j/core/appender/db/AbstractDatabaseManager.html">AbstractDatabaseManager</a>(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> bufferSize, <strong class="jxr_keyword">final</strong> Layout&lt;? <strong class="jxr_keyword">extends</strong> Serializable&gt; layout) {
<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">super</strong>(<strong class="jxr_keyword">null</strong>, name);
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">this</strong>.bufferSize = bufferSize;
<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">this</strong>.buffer = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;(bufferSize + 1);
<a class="jxr_linenumber" name="L119" href="#L119">119</a> <strong class="jxr_keyword">this</strong>.layout = layout;
<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
<a class="jxr_linenumber" name="L121" href="#L121">121</a>
<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> buffer(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">this</strong>.buffer.add(event.toImmutable());
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.buffer.size() &gt;= <strong class="jxr_keyword">this</strong>.bufferSize || event.isEndOfBatch()) {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">this</strong>.flush();
<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a>
<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> * Commits any active transaction (if applicable) and disconnects from the database (returns the connection to the</em>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * connection pool). With buffering enabled, this is called when flushing the buffer completes, after the last call</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * to {@link #writeInternal}. With buffering disabled, this is called immediately after every invocation of</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * {@link #writeInternal}.</em>
<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> * @return true if all resources were closed normally, false otherwise.</em>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> commitAndClose();
<a class="jxr_linenumber" name="L137" href="#L137">137</a>
<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * Connects to the database and starts a transaction (if applicable). With buffering enabled, this is called when</em>
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * flushing the buffer begins, before the first call to {@link #writeInternal}. With buffering disabled, this is</em>
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * called immediately before every invocation of {@link #writeInternal}.</em>
<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> connectAndStart();
<a class="jxr_linenumber" name="L144" href="#L144">144</a>
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * This method is called automatically when the buffer size reaches its maximum or at the beginning of a call to</em>
<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * {@link #shutdown()}. It can also be called manually to flush events to the database.</em>
<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L149" href="#L149">149</a> @Override
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> flush() {
<a class="jxr_linenumber" name="L151" href="#L151">151</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isRunning() &amp;&amp; isBuffered()) {
<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">this</strong>.connectAndStart();
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">final</strong> LogEvent event : <strong class="jxr_keyword">this</strong>.buffer) {
<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">this</strong>.writeInternal(event, layout != <strong class="jxr_keyword">null</strong> ? layout.toSerializable(event) : <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
<a class="jxr_linenumber" name="L157" href="#L157">157</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">this</strong>.commitAndClose();
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_comment">// not sure if this should be done when writing the events failed</em>
<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">this</strong>.buffer.clear();
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a> }
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isBuffered() {
<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.bufferSize &gt; 0;
<a class="jxr_linenumber" name="L167" href="#L167">167</a> }
<a class="jxr_linenumber" name="L168" href="#L168">168</a>
<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em class="jxr_javadoccomment"> * Indicates whether the manager is currently connected {@link #startup()} has been called and {@link #shutdown()}</em>
<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em class="jxr_javadoccomment"> * has not been called).</em>
<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment"> * @return {@code true} if the manager is connected.</em>
<a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isRunning() {
<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.running;
<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
<a class="jxr_linenumber" name="L178" href="#L178">178</a>
<a class="jxr_linenumber" name="L179" href="#L179">179</a> @Override
<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> releaseSub(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> timeout, <strong class="jxr_keyword">final</strong> TimeUnit timeUnit) {
<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.shutdown();
<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
<a class="jxr_linenumber" name="L183" href="#L183">183</a>
<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em class="jxr_javadoccomment"> * This method is called from the {@link #close()} method when the appender is stopped or the appender's manager</em>
<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_javadoccomment"> * is replaced. If it has not already been called, it calls {@link #shutdownInternal()} and catches any exceptions</em>
<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em class="jxr_javadoccomment"> * it might throw.</em>
<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em class="jxr_javadoccomment"> * @return true if all resources were closed normally, false otherwise.</em>
<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L190" href="#L190">190</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">boolean</strong> shutdown() {
<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">boolean</strong> closed = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L192" href="#L192">192</a> <strong class="jxr_keyword">this</strong>.flush();
<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.isRunning()) {
<a class="jxr_linenumber" name="L194" href="#L194">194</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L195" href="#L195">195</a> closed &amp;= <strong class="jxr_keyword">this</strong>.shutdownInternal();
<a class="jxr_linenumber" name="L196" href="#L196">196</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) {
<a class="jxr_linenumber" name="L197" href="#L197">197</a> logWarn(<span class="jxr_string">"Caught exception while performing database shutdown operations"</span>, e);
<a class="jxr_linenumber" name="L198" href="#L198">198</a> closed = false;
<a class="jxr_linenumber" name="L199" href="#L199">199</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">this</strong>.running = false;
<a class="jxr_linenumber" name="L201" href="#L201">201</a> }
<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
<a class="jxr_linenumber" name="L203" href="#L203">203</a> <strong class="jxr_keyword">return</strong> closed;
<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
<a class="jxr_linenumber" name="L205" href="#L205">205</a>
<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * Implementations should implement this method to perform any proprietary disconnection / shutdown operations. This</em>
<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> * method will never be called twice on the same instance, and it will only be called &lt;em&gt;after&lt;/em&gt;</em>
<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * {@link #startupInternal()}. It is safe to throw any exceptions from this method. This method does not</em>
<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * necessarily disconnect from the database for the same reasons outlined in {@link #startupInternal()}.</em>
<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * @return true if all resources were closed normally, false otherwise.</em>
<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> shutdownInternal() <strong class="jxr_keyword">throws</strong> Exception;
<a class="jxr_linenumber" name="L214" href="#L214">214</a>
<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> * This method is called within the appender when the appender is started. If it has not already been called, it</em>
<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * calls {@link #startupInternal()} and catches any exceptions it might throw.</em>
<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> startup() {
<a class="jxr_linenumber" name="L220" href="#L220">220</a> <strong class="jxr_keyword">if</strong> (!<strong class="jxr_keyword">this</strong>.isRunning()) {
<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L222" href="#L222">222</a> <strong class="jxr_keyword">this</strong>.startupInternal();
<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">this</strong>.running = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L224" href="#L224">224</a> } <strong class="jxr_keyword">catch</strong> (<strong class="jxr_keyword">final</strong> Exception e) {
<a class="jxr_linenumber" name="L225" href="#L225">225</a> logError(<span class="jxr_string">"Could not perform database startup operations"</span>, e);
<a class="jxr_linenumber" name="L226" href="#L226">226</a> }
<a class="jxr_linenumber" name="L227" href="#L227">227</a> }
<a class="jxr_linenumber" name="L228" href="#L228">228</a> }
<a class="jxr_linenumber" name="L229" href="#L229">229</a>
<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * Implementations should implement this method to perform any proprietary startup operations. This method will</em>
<a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * never be called twice on the same instance. It is safe to throw any exceptions from this method. This method</em>
<a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * does not necessarily connect to the database, as it is generally unreliable to connect once and use the same</em>
<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> * connection for hours.</em>
<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> startupInternal() <strong class="jxr_keyword">throws</strong> Exception;
<a class="jxr_linenumber" name="L237" href="#L237">237</a>
<a class="jxr_linenumber" name="L238" href="#L238">238</a> @Override
<a class="jxr_linenumber" name="L239" href="#L239">239</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> String toString() {
<a class="jxr_linenumber" name="L240" href="#L240">240</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.getName();
<a class="jxr_linenumber" name="L241" href="#L241">241</a> }
<a class="jxr_linenumber" name="L242" href="#L242">242</a>
<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * This method manages buffering and writing of events.</em>
<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> * @param event The event to write to the database.</em>
<a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_javadoccomment"> * @deprecated since 2.11.0 Use {@link #write(LogEvent, Serializable)}.</em>
<a class="jxr_linenumber" name="L248" href="#L248">248</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L249" href="#L249">249</a> @Deprecated
<a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="L251" href="#L251">251</a> write(event, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L252" href="#L252">252</a> }
<a class="jxr_linenumber" name="L253" href="#L253">253</a>
<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * This method manages buffering and writing of events.</em>
<a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * @param event The event to write to the database.</em>
<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * @param serializable Serializable event</em>
<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L260" href="#L260">260</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> write(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event, <strong class="jxr_keyword">final</strong> Serializable serializable) {
<a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">if</strong> (isBuffered()) {
<a class="jxr_linenumber" name="L262" href="#L262">262</a> buffer(event);
<a class="jxr_linenumber" name="L263" href="#L263">263</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L264" href="#L264">264</a> writeThrough(event, serializable);
<a class="jxr_linenumber" name="L265" href="#L265">265</a> }
<a class="jxr_linenumber" name="L266" href="#L266">266</a> }
<a class="jxr_linenumber" name="L267" href="#L267">267</a>
<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em class="jxr_javadoccomment"> * Performs the actual writing of the event in an implementation-specific way. This method is called immediately</em>
<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em class="jxr_javadoccomment"> * from {@link #write(LogEvent, Serializable)} if buffering is off, or from {@link #flush()} if the buffer has reached its limit.</em>
<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em class="jxr_javadoccomment"> * @param event The event to write to the database.</em>
<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em class="jxr_javadoccomment"> * @deprecated Use {@link #writeInternal(LogEvent, Serializable)}.</em>
<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L275" href="#L275">275</a> @Deprecated
<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> writeInternal(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event) {
<a class="jxr_linenumber" name="L277" href="#L277">277</a> writeInternal(event, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L278" href="#L278">278</a> }
<a class="jxr_linenumber" name="L279" href="#L279">279</a>
<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_javadoccomment"> * Performs the actual writing of the event in an implementation-specific way. This method is called immediately</em>
<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em class="jxr_javadoccomment"> * from {@link #write(LogEvent, Serializable)} if buffering is off, or from {@link #flush()} if the buffer has reached its limit.</em>
<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L284" href="#L284">284</a> <em class="jxr_javadoccomment"> * @param event The event to write to the database.</em>
<a class="jxr_linenumber" name="L285" href="#L285">285</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong> writeInternal(<a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event, Serializable serializable);
<a class="jxr_linenumber" name="L287" href="#L287">287</a>
<a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> writeThrough(<strong class="jxr_keyword">final</strong> <a href="../../../../../../../org/apache/logging/log4j/core/LogEvent.html">LogEvent</a> event, <strong class="jxr_keyword">final</strong> Serializable serializable) {
<a class="jxr_linenumber" name="L289" href="#L289">289</a> <strong class="jxr_keyword">this</strong>.connectAndStart();
<a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L291" href="#L291">291</a> <strong class="jxr_keyword">this</strong>.writeInternal(event, serializable);
<a class="jxr_linenumber" name="L292" href="#L292">292</a> } <strong class="jxr_keyword">finally</strong> {
<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">this</strong>.commitAndClose();
<a class="jxr_linenumber" name="L294" href="#L294">294</a> }
<a class="jxr_linenumber" name="L295" href="#L295">295</a> }
<a class="jxr_linenumber" name="L296" href="#L296">296</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>