Modified: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html?rev=570911&r1=570910&r2=570911&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html (original) +++ logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNode13.html Wed Aug 29 12:46:25 2007 @@ -36,252 +36,254 @@ <a name="27" href="#27">27</a> <strong>import</strong> java.util.List; <a name="28" href="#28">28</a> <a name="29" href="#29">29</a> <strong>import</strong> org.apache.log4j.Logger; -<a name="30" href="#30">30</a> <strong>import</strong> org.apache.log4j.plugins.Pauseable; -<a name="31" href="#31">31</a> <strong>import</strong> org.apache.log4j.plugins.Receiver; -<a name="32" href="#32">32</a> <strong>import</strong> org.apache.log4j.spi.ComponentBase; -<a name="33" href="#33">33</a> <strong>import</strong> org.apache.log4j.spi.LoggerRepository; -<a name="34" href="#34">34</a> <strong>import</strong> org.apache.log4j.spi.LoggingEvent; -<a name="35" href="#35">35</a> +<a name="30" href="#30">30</a> <strong>import</strong> org.apache.log4j.helpers.Constants; +<a name="31" href="#31">31</a> <strong>import</strong> org.apache.log4j.plugins.Pauseable; +<a name="32" href="#32">32</a> <strong>import</strong> org.apache.log4j.plugins.Receiver; +<a name="33" href="#33">33</a> <strong>import</strong> org.apache.log4j.spi.ComponentBase; +<a name="34" href="#34">34</a> <strong>import</strong> org.apache.log4j.spi.LoggerRepository; +<a name="35" href="#35">35</a> <strong>import</strong> org.apache.log4j.spi.LoggingEvent; <a name="36" href="#36">36</a> -<a name="37" href="#37">37</a> <em class="comment">// Contributors: Moses Hohman <[EMAIL PROTECTED]></em> -<a name="38" href="#38">38</a> -<a name="39" href="#39">39</a> <em>/**<em>*</em></em> -<a name="40" href="#40">40</a> <em> Read [EMAIL PROTECTED] LoggingEvent} objects sent from a remote client using</em> -<a name="41" href="#41">41</a> <em> Sockets (TCP). These logging events are logged according to local</em> -<a name="42" href="#42">42</a> <em> policy, as if they were generated locally.</em> -<a name="43" href="#43">43</a> -<a name="44" href="#44">44</a> <em> <p>For example, the socket node might decide to log events to a</em> -<a name="45" href="#45">45</a> <em> local file and also resent them to a second socket node.</em> -<a name="46" href="#46">46</a> -<a name="47" href="#47">47</a> <em> Implementation lifted from org.apache.log4j.net.SocketNode</em> -<a name="48" href="#48">48</a> <em> in log4j 1.3 and renamed to prevent collision with</em> -<a name="49" href="#49">49</a> <em> log4j 1.2 implementation.</em> -<a name="50" href="#50">50</a> -<a name="51" href="#51">51</a> <em> @author Ceki G&uuml;lc&uuml;</em> -<a name="52" href="#52">52</a> <em> @author Paul Smith ([EMAIL PROTECTED])</em> -<a name="53" href="#53">53</a> +<a name="37" href="#37">37</a> +<a name="38" href="#38">38</a> <em class="comment">// Contributors: Moses Hohman <[EMAIL PROTECTED]></em> +<a name="39" href="#39">39</a> +<a name="40" href="#40">40</a> <em>/**<em>*</em></em> +<a name="41" href="#41">41</a> <em> Read [EMAIL PROTECTED] LoggingEvent} objects sent from a remote client using</em> +<a name="42" href="#42">42</a> <em> Sockets (TCP). These logging events are logged according to local</em> +<a name="43" href="#43">43</a> <em> policy, as if they were generated locally.</em> +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em> <p>For example, the socket node might decide to log events to a</em> +<a name="46" href="#46">46</a> <em> local file and also resent them to a second socket node.</em> +<a name="47" href="#47">47</a> +<a name="48" href="#48">48</a> <em> Implementation lifted from org.apache.log4j.net.SocketNode</em> +<a name="49" href="#49">49</a> <em> in log4j 1.3 and renamed to prevent collision with</em> +<a name="50" href="#50">50</a> <em> log4j 1.2 implementation.</em> +<a name="51" href="#51">51</a> +<a name="52" href="#52">52</a> <em> @author Ceki G&uuml;lc&uuml;</em> +<a name="53" href="#53">53</a> <em> @author Paul Smith ([EMAIL PROTECTED])</em> <a name="54" href="#54">54</a> -<a name="55" href="#55">55</a> <em>*/</em> -<a name="56" href="#56">56</a> <strong>public</strong> <strong>class</strong> SocketNode13 <strong>extends</strong> ComponentBase implements Runnable, Pauseable { -<a name="57" href="#57">57</a> -<a name="58" href="#58">58</a> <em>/**<em>*</em></em> -<a name="59" href="#59">59</a> <em> * Paused state.</em> -<a name="60" href="#60">60</a> <em> */</em> -<a name="61" href="#61">61</a> <strong>private</strong> <strong>boolean</strong> paused; -<a name="62" href="#62">62</a> <em>/**<em>*</em></em> -<a name="63" href="#63">63</a> <em> * Socket.</em> -<a name="64" href="#64">64</a> <em> */</em> -<a name="65" href="#65">65</a> <strong>private</strong> Socket socket; -<a name="66" href="#66">66</a> <em>/**<em>*</em></em> -<a name="67" href="#67">67</a> <em> * Receiver.</em> -<a name="68" href="#68">68</a> <em> */</em> -<a name="69" href="#69">69</a> <strong>private</strong> Receiver receiver; -<a name="70" href="#70">70</a> <em>/**<em>*</em></em> -<a name="71" href="#71">71</a> <em> * List of listeners.</em> -<a name="72" href="#72">72</a> <em> */</em> -<a name="73" href="#73">73</a> <strong>private</strong> List listenerList = Collections.synchronizedList(<strong>new</strong> ArrayList()); -<a name="74" href="#74">74</a> +<a name="55" href="#55">55</a> +<a name="56" href="#56">56</a> <em>*/</em> +<a name="57" href="#57">57</a> <strong>public</strong> <strong>class</strong> SocketNode13 <strong>extends</strong> ComponentBase implements Runnable, Pauseable { +<a name="58" href="#58">58</a> +<a name="59" href="#59">59</a> <em>/**<em>*</em></em> +<a name="60" href="#60">60</a> <em> * Paused state.</em> +<a name="61" href="#61">61</a> <em> */</em> +<a name="62" href="#62">62</a> <strong>private</strong> <strong>boolean</strong> paused; +<a name="63" href="#63">63</a> <em>/**<em>*</em></em> +<a name="64" href="#64">64</a> <em> * Socket.</em> +<a name="65" href="#65">65</a> <em> */</em> +<a name="66" href="#66">66</a> <strong>private</strong> Socket socket; +<a name="67" href="#67">67</a> <em>/**<em>*</em></em> +<a name="68" href="#68">68</a> <em> * Receiver.</em> +<a name="69" href="#69">69</a> <em> */</em> +<a name="70" href="#70">70</a> <strong>private</strong> Receiver receiver; +<a name="71" href="#71">71</a> <em>/**<em>*</em></em> +<a name="72" href="#72">72</a> <em> * List of listeners.</em> +<a name="73" href="#73">73</a> <em> */</em> +<a name="74" href="#74">74</a> <strong>private</strong> List listenerList = Collections.synchronizedList(<strong>new</strong> ArrayList()); <a name="75" href="#75">75</a> <a name="76" href="#76">76</a> -<a name="77" href="#77">77</a> <em>/**<em>*</em></em> -<a name="78" href="#78">78</a> <em> Constructor for socket and logger repository.</em> -<a name="79" href="#79">79</a> <em> @param s socket</em> -<a name="80" href="#80">80</a> <em> @param hierarchy logger repository</em> -<a name="81" href="#81">81</a> <em> */</em> -<a name="82" href="#82">82</a> <strong>public</strong> SocketNode13(<strong>final</strong> Socket s, -<a name="83" href="#83">83</a> <strong>final</strong> LoggerRepository hierarchy) { -<a name="84" href="#84">84</a> <strong>super</strong>(); -<a name="85" href="#85">85</a> <strong>this</strong>.socket = s; -<a name="86" href="#86">86</a> <strong>this</strong>.repository = hierarchy; -<a name="87" href="#87">87</a> } -<a name="88" href="#88">88</a> -<a name="89" href="#89">89</a> <em>/**<em>*</em></em> -<a name="90" href="#90">90</a> <em> Constructor for socket and receiver.</em> -<a name="91" href="#91">91</a> <em> @param s socket</em> -<a name="92" href="#92">92</a> <em> @param r receiver</em> -<a name="93" href="#93">93</a> <em> */</em> -<a name="94" href="#94">94</a> <strong>public</strong> SocketNode13(<strong>final</strong> Socket s, <strong>final</strong> Receiver r) { -<a name="95" href="#95">95</a> <strong>super</strong>(); -<a name="96" href="#96">96</a> <strong>this</strong>.socket = s; -<a name="97" href="#97">97</a> <strong>this</strong>.receiver = r; -<a name="98" href="#98">98</a> } -<a name="99" href="#99">99</a> -<a name="100" href="#100">100</a> <em>/**<em>*</em></em> -<a name="101" href="#101">101</a> <em> * Set the event listener on this node.</em> -<a name="102" href="#102">102</a> <em> *</em> -<a name="103" href="#103">103</a> <em> * @deprecated Now supports mutliple listeners, this method</em> -<a name="104" href="#104">104</a> <em> * simply invokes the removeSocketNodeEventListener() to remove</em> -<a name="105" href="#105">105</a> <em> * the listener, and then readds it.</em> -<a name="106" href="#106">106</a> <em> * @param l listener</em> -<a name="107" href="#107">107</a> <em> */</em> -<a name="108" href="#108">108</a> <strong>public</strong> <strong>void</strong> setListener(<strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> l) { -<a name="109" href="#109">109</a> removeSocketNodeEventListener(l); -<a name="110" href="#110">110</a> addSocketNodeEventListener(l); -<a name="111" href="#111">111</a> } -<a name="112" href="#112">112</a> -<a name="113" href="#113">113</a> <em>/**<em>*</em></em> -<a name="114" href="#114">114</a> <em> * Adds the listener to the list of listeners to be notified of the</em> -<a name="115" href="#115">115</a> <em> * respective event.</em> -<a name="116" href="#116">116</a> <em> * @param listener the listener to add to the list</em> -<a name="117" href="#117">117</a> <em> */</em> -<a name="118" href="#118">118</a> <strong>public</strong> <strong>void</strong> addSocketNodeEventListener( -<a name="119" href="#119">119</a> <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener) { -<a name="120" href="#120">120</a> listenerList.add(listener); -<a name="121" href="#121">121</a> } -<a name="122" href="#122">122</a> -<a name="123" href="#123">123</a> <em>/**<em>*</em></em> -<a name="124" href="#124">124</a> <em> * Removes the registered Listener from this instances list of</em> -<a name="125" href="#125">125</a> <em> * listeners. If the listener has not been registered, then invoking</em> -<a name="126" href="#126">126</a> <em> * this method has no effect.</em> -<a name="127" href="#127">127</a> <em> *</em> -<a name="128" href="#128">128</a> <em> * @param listener the SocketNodeEventListener to remove</em> -<a name="129" href="#129">129</a> <em> */</em> -<a name="130" href="#130">130</a> <strong>public</strong> <strong>void</strong> removeSocketNodeEventListener( -<a name="131" href="#131">131</a> <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener) { -<a name="132" href="#132">132</a> listenerList.remove(listener); -<a name="133" href="#133">133</a> } -<a name="134" href="#134">134</a> +<a name="77" href="#77">77</a> +<a name="78" href="#78">78</a> <em>/**<em>*</em></em> +<a name="79" href="#79">79</a> <em> Constructor for socket and logger repository.</em> +<a name="80" href="#80">80</a> <em> @param s socket</em> +<a name="81" href="#81">81</a> <em> @param hierarchy logger repository</em> +<a name="82" href="#82">82</a> <em> */</em> +<a name="83" href="#83">83</a> <strong>public</strong> SocketNode13(<strong>final</strong> Socket s, +<a name="84" href="#84">84</a> <strong>final</strong> LoggerRepository hierarchy) { +<a name="85" href="#85">85</a> <strong>super</strong>(); +<a name="86" href="#86">86</a> <strong>this</strong>.socket = s; +<a name="87" href="#87">87</a> <strong>this</strong>.repository = hierarchy; +<a name="88" href="#88">88</a> } +<a name="89" href="#89">89</a> +<a name="90" href="#90">90</a> <em>/**<em>*</em></em> +<a name="91" href="#91">91</a> <em> Constructor for socket and receiver.</em> +<a name="92" href="#92">92</a> <em> @param s socket</em> +<a name="93" href="#93">93</a> <em> @param r receiver</em> +<a name="94" href="#94">94</a> <em> */</em> +<a name="95" href="#95">95</a> <strong>public</strong> SocketNode13(<strong>final</strong> Socket s, <strong>final</strong> Receiver r) { +<a name="96" href="#96">96</a> <strong>super</strong>(); +<a name="97" href="#97">97</a> <strong>this</strong>.socket = s; +<a name="98" href="#98">98</a> <strong>this</strong>.receiver = r; +<a name="99" href="#99">99</a> } +<a name="100" href="#100">100</a> +<a name="101" href="#101">101</a> <em>/**<em>*</em></em> +<a name="102" href="#102">102</a> <em> * Set the event listener on this node.</em> +<a name="103" href="#103">103</a> <em> *</em> +<a name="104" href="#104">104</a> <em> * @deprecated Now supports mutliple listeners, this method</em> +<a name="105" href="#105">105</a> <em> * simply invokes the removeSocketNodeEventListener() to remove</em> +<a name="106" href="#106">106</a> <em> * the listener, and then readds it.</em> +<a name="107" href="#107">107</a> <em> * @param l listener</em> +<a name="108" href="#108">108</a> <em> */</em> +<a name="109" href="#109">109</a> <strong>public</strong> <strong>void</strong> setListener(<strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> l) { +<a name="110" href="#110">110</a> removeSocketNodeEventListener(l); +<a name="111" href="#111">111</a> addSocketNodeEventListener(l); +<a name="112" href="#112">112</a> } +<a name="113" href="#113">113</a> +<a name="114" href="#114">114</a> <em>/**<em>*</em></em> +<a name="115" href="#115">115</a> <em> * Adds the listener to the list of listeners to be notified of the</em> +<a name="116" href="#116">116</a> <em> * respective event.</em> +<a name="117" href="#117">117</a> <em> * @param listener the listener to add to the list</em> +<a name="118" href="#118">118</a> <em> */</em> +<a name="119" href="#119">119</a> <strong>public</strong> <strong>void</strong> addSocketNodeEventListener( +<a name="120" href="#120">120</a> <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener) { +<a name="121" href="#121">121</a> listenerList.add(listener); +<a name="122" href="#122">122</a> } +<a name="123" href="#123">123</a> +<a name="124" href="#124">124</a> <em>/**<em>*</em></em> +<a name="125" href="#125">125</a> <em> * Removes the registered Listener from this instances list of</em> +<a name="126" href="#126">126</a> <em> * listeners. If the listener has not been registered, then invoking</em> +<a name="127" href="#127">127</a> <em> * this method has no effect.</em> +<a name="128" href="#128">128</a> <em> *</em> +<a name="129" href="#129">129</a> <em> * @param listener the SocketNodeEventListener to remove</em> +<a name="130" href="#130">130</a> <em> */</em> +<a name="131" href="#131">131</a> <strong>public</strong> <strong>void</strong> removeSocketNodeEventListener( +<a name="132" href="#132">132</a> <strong>final</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> listener) { +<a name="133" href="#133">133</a> listenerList.remove(listener); +<a name="134" href="#134">134</a> } <a name="135" href="#135">135</a> -<a name="136" href="#136">136</a> <em>/**<em>*</em></em> -<a name="137" href="#137">137</a> <em> * Deserialize events from socket until interrupted.</em> -<a name="138" href="#138">138</a> <em> */</em> -<a name="139" href="#139">139</a> <strong>public</strong> <strong>void</strong> run() { -<a name="140" href="#140">140</a> LoggingEvent event; -<a name="141" href="#141">141</a> Logger remoteLogger; -<a name="142" href="#142">142</a> Exception listenerException = <strong>null</strong>; -<a name="143" href="#143">143</a> ObjectInputStream ois = <strong>null</strong>; -<a name="144" href="#144">144</a> -<a name="145" href="#145">145</a> <strong>try</strong> { -<a name="146" href="#146">146</a> ois = -<a name="147" href="#147">147</a> <strong>new</strong> ObjectInputStream( -<a name="148" href="#148">148</a> <strong>new</strong> BufferedInputStream(socket.getInputStream())); -<a name="149" href="#149">149</a> } <strong>catch</strong> (Exception e) { -<a name="150" href="#150">150</a> ois = <strong>null</strong>; -<a name="151" href="#151">151</a> listenerException = e; -<a name="152" href="#152">152</a> getLogger().error(<span class="string">"Exception opening ObjectInputStream to "</span> + socket, e); -<a name="153" href="#153">153</a> } -<a name="154" href="#154">154</a> -<a name="155" href="#155">155</a> <strong>if</strong> (ois != <strong>null</strong>) { -<a name="156" href="#156">156</a> String remoteInfo = -<a name="157" href="#157">157</a> socket.getInetAddress().getHostName() + <span class="string">":"</span> + socket.getPort(); -<a name="158" href="#158">158</a> -<a name="159" href="#159">159</a> <em>/**<em>*</em></em> -<a name="160" href="#160">160</a> <em> * notify the listener that the socket has been</em> -<a name="161" href="#161">161</a> <em> * opened and this SocketNode is ready and waiting</em> -<a name="162" href="#162">162</a> <em> */</em> -<a name="163" href="#163">163</a> fireSocketOpened(remoteInfo); -<a name="164" href="#164">164</a> -<a name="165" href="#165">165</a> <strong>try</strong> { -<a name="166" href="#166">166</a> <strong>while</strong> (<strong>true</strong>) { -<a name="167" href="#167">167</a> <em class="comment">// read an event from the wire</em> -<a name="168" href="#168">168</a> event = (LoggingEvent) ois.readObject(); -<a name="169" href="#169">169</a> -<a name="170" href="#170">170</a> <em class="comment">// store the known remote info in an event property</em> -<a name="171" href="#171">171</a> event.setProperty(<span class="string">"log4j.remoteSourceInfo"</span>, remoteInfo); -<a name="172" href="#172">172</a> -<a name="173" href="#173">173</a> <em class="comment">// if configured with a receiver, tell it to post the event</em> -<a name="174" href="#174">174</a> <strong>if</strong> (!isPaused()) { -<a name="175" href="#175">175</a> <strong>if</strong> ((receiver != <strong>null</strong>)) { -<a name="176" href="#176">176</a> receiver.doPost(event); -<a name="177" href="#177">177</a> -<a name="178" href="#178">178</a> <em class="comment">// else post it via the hierarchy</em> -<a name="179" href="#179">179</a> } <strong>else</strong> { -<a name="180" href="#180">180</a> <em class="comment">// get a logger from the hierarchy. The name of the logger</em> -<a name="181" href="#181">181</a> <em class="comment">// is taken to be the name contained in the event.</em> -<a name="182" href="#182">182</a> remoteLogger = repository.getLogger(event.getLoggerName()); -<a name="183" href="#183">183</a> -<a name="184" href="#184">184</a> <em class="comment">//event.logger = remoteLogger;</em> -<a name="185" href="#185">185</a> <em class="comment">// apply the logger-level filter</em> -<a name="186" href="#186">186</a> <strong>if</strong> (event -<a name="187" href="#187">187</a> .getLevel() -<a name="188" href="#188">188</a> .isGreaterOrEqual(remoteLogger.getEffectiveLevel())) { -<a name="189" href="#189">189</a> <em class="comment">// finally log the event as if was generated locally</em> -<a name="190" href="#190">190</a> remoteLogger.callAppenders(event); -<a name="191" href="#191">191</a> } -<a name="192" href="#192">192</a> } -<a name="193" href="#193">193</a> } <strong>else</strong> { -<a name="194" href="#194">194</a> <em class="comment">//we simply discard this event.</em> -<a name="195" href="#195">195</a> } -<a name="196" href="#196">196</a> } -<a name="197" href="#197">197</a> } <strong>catch</strong> (java.io.EOFException e) { -<a name="198" href="#198">198</a> getLogger().info(<span class="string">"Caught java.io.EOFException closing connection."</span>); -<a name="199" href="#199">199</a> listenerException = e; -<a name="200" href="#200">200</a> } <strong>catch</strong> (java.net.SocketException e) { -<a name="201" href="#201">201</a> getLogger().info(<span class="string">"Caught java.net.SocketException closing connection."</span>); -<a name="202" href="#202">202</a> listenerException = e; -<a name="203" href="#203">203</a> } <strong>catch</strong> (IOException e) { -<a name="204" href="#204">204</a> getLogger().info(<span class="string">"Caught java.io.IOException: "</span> + e); -<a name="205" href="#205">205</a> getLogger().info(<span class="string">"Closing connection."</span>); -<a name="206" href="#206">206</a> listenerException = e; -<a name="207" href="#207">207</a> } <strong>catch</strong> (Exception e) { -<a name="208" href="#208">208</a> getLogger().error(<span class="string">"Unexpected exception. Closing connection."</span>, e); -<a name="209" href="#209">209</a> listenerException = e; -<a name="210" href="#210">210</a> } -<a name="211" href="#211">211</a> } -<a name="212" href="#212">212</a> -<a name="213" href="#213">213</a> <em class="comment">// close the socket</em> -<a name="214" href="#214">214</a> <strong>try</strong> { -<a name="215" href="#215">215</a> <strong>if</strong> (ois != <strong>null</strong>) { -<a name="216" href="#216">216</a> ois.close(); -<a name="217" href="#217">217</a> } -<a name="218" href="#218">218</a> } <strong>catch</strong> (Exception e) { -<a name="219" href="#219">219</a> <em class="comment">//getLogger().info("Could not close connection.", e);</em> -<a name="220" href="#220">220</a> } -<a name="221" href="#221">221</a> -<a name="222" href="#222">222</a> <em class="comment">// send event to listener, if configured</em> -<a name="223" href="#223">223</a> <strong>if</strong> (listenerList.size() > 0) { -<a name="224" href="#224">224</a> fireSocketClosedEvent(listenerException); -<a name="225" href="#225">225</a> } -<a name="226" href="#226">226</a> } -<a name="227" href="#227">227</a> -<a name="228" href="#228">228</a> <em>/**<em>*</em></em> -<a name="229" href="#229">229</a> <em> * Notifies all registered listeners regarding the closing of the Socket.</em> -<a name="230" href="#230">230</a> <em> * @param listenerException listener exception</em> -<a name="231" href="#231">231</a> <em> */</em> -<a name="232" href="#232">232</a> <strong>private</strong> <strong>void</strong> fireSocketClosedEvent(<strong>final</strong> Exception listenerException) { -<a name="233" href="#233">233</a> <strong>synchronized</strong> (listenerList) { -<a name="234" href="#234">234</a> <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) { -<a name="235" href="#235">235</a> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> snel = -<a name="236" href="#236">236</a> (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next(); -<a name="237" href="#237">237</a> <strong>if</strong> (snel != <strong>null</strong>) { -<a name="238" href="#238">238</a> snel.socketClosedEvent(listenerException); -<a name="239" href="#239">239</a> } -<a name="240" href="#240">240</a> } -<a name="241" href="#241">241</a> } -<a name="242" href="#242">242</a> } -<a name="243" href="#243">243</a> -<a name="244" href="#244">244</a> <em>/**<em>*</em></em> -<a name="245" href="#245">245</a> <em> * Notifies all registered listeners regarding the opening of a Socket.</em> -<a name="246" href="#246">246</a> <em> * @param remoteInfo remote info</em> -<a name="247" href="#247">247</a> <em> */</em> -<a name="248" href="#248">248</a> <strong>private</strong> <strong>void</strong> fireSocketOpened(<strong>final</strong> String remoteInfo) { -<a name="249" href="#249">249</a> <strong>synchronized</strong> (listenerList) { -<a name="250" href="#250">250</a> <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) { -<a name="251" href="#251">251</a> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> snel = -<a name="252" href="#252">252</a> (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next(); -<a name="253" href="#253">253</a> <strong>if</strong> (snel != <strong>null</strong>) { -<a name="254" href="#254">254</a> snel.socketOpened(remoteInfo); -<a name="255" href="#255">255</a> } -<a name="256" href="#256">256</a> } -<a name="257" href="#257">257</a> } -<a name="258" href="#258">258</a> } -<a name="259" href="#259">259</a> -<a name="260" href="#260">260</a> <em>/**<em>*</em></em> -<a name="261" href="#261">261</a> <em> * Sets if node is paused.</em> -<a name="262" href="#262">262</a> <em> * @param b new value</em> -<a name="263" href="#263">263</a> <em> */</em> -<a name="264" href="#264">264</a> <strong>public</strong> <strong>void</strong> setPaused(<strong>final</strong> <strong>boolean</strong> b) { -<a name="265" href="#265">265</a> <strong>this</strong>.paused = b; -<a name="266" href="#266">266</a> } -<a name="267" href="#267">267</a> -<a name="268" href="#268">268</a> <em>/**<em>*</em></em> -<a name="269" href="#269">269</a> <em> * Get if node is paused.</em> -<a name="270" href="#270">270</a> <em> * @return true if pause.</em> -<a name="271" href="#271">271</a> <em> */</em> -<a name="272" href="#272">272</a> <strong>public</strong> <strong>boolean</strong> isPaused() { -<a name="273" href="#273">273</a> <strong>return</strong> <strong>this</strong>.paused; -<a name="274" href="#274">274</a> } -<a name="275" href="#275">275</a> } +<a name="136" href="#136">136</a> +<a name="137" href="#137">137</a> <em>/**<em>*</em></em> +<a name="138" href="#138">138</a> <em> * Deserialize events from socket until interrupted.</em> +<a name="139" href="#139">139</a> <em> */</em> +<a name="140" href="#140">140</a> <strong>public</strong> <strong>void</strong> run() { +<a name="141" href="#141">141</a> LoggingEvent event; +<a name="142" href="#142">142</a> Logger remoteLogger; +<a name="143" href="#143">143</a> Exception listenerException = <strong>null</strong>; +<a name="144" href="#144">144</a> ObjectInputStream ois = <strong>null</strong>; +<a name="145" href="#145">145</a> +<a name="146" href="#146">146</a> <strong>try</strong> { +<a name="147" href="#147">147</a> ois = +<a name="148" href="#148">148</a> <strong>new</strong> ObjectInputStream( +<a name="149" href="#149">149</a> <strong>new</strong> BufferedInputStream(socket.getInputStream())); +<a name="150" href="#150">150</a> } <strong>catch</strong> (Exception e) { +<a name="151" href="#151">151</a> ois = <strong>null</strong>; +<a name="152" href="#152">152</a> listenerException = e; +<a name="153" href="#153">153</a> getLogger().error(<span class="string">"Exception opening ObjectInputStream to "</span> + socket, e); +<a name="154" href="#154">154</a> } +<a name="155" href="#155">155</a> +<a name="156" href="#156">156</a> <strong>if</strong> (ois != <strong>null</strong>) { +<a name="157" href="#157">157</a> +<a name="158" href="#158">158</a> String hostName = socket.getInetAddress().getHostName(); +<a name="159" href="#159">159</a> String remoteInfo = hostName + <span class="string">":"</span> + socket.getPort(); +<a name="160" href="#160">160</a> +<a name="161" href="#161">161</a> <em>/**<em>*</em></em> +<a name="162" href="#162">162</a> <em> * notify the listener that the socket has been</em> +<a name="163" href="#163">163</a> <em> * opened and this SocketNode is ready and waiting</em> +<a name="164" href="#164">164</a> <em> */</em> +<a name="165" href="#165">165</a> fireSocketOpened(remoteInfo); +<a name="166" href="#166">166</a> +<a name="167" href="#167">167</a> <strong>try</strong> { +<a name="168" href="#168">168</a> <strong>while</strong> (<strong>true</strong>) { +<a name="169" href="#169">169</a> <em class="comment">// read an event from the wire</em> +<a name="170" href="#170">170</a> event = (LoggingEvent) ois.readObject(); +<a name="171" href="#171">171</a> event.setProperty(Constants.HOSTNAME_KEY, hostName); +<a name="172" href="#172">172</a> <em class="comment">// store the known remote info in an event property</em> +<a name="173" href="#173">173</a> event.setProperty(<span class="string">"log4j.remoteSourceInfo"</span>, remoteInfo); +<a name="174" href="#174">174</a> +<a name="175" href="#175">175</a> <em class="comment">// if configured with a receiver, tell it to post the event</em> +<a name="176" href="#176">176</a> <strong>if</strong> (!isPaused()) { +<a name="177" href="#177">177</a> <strong>if</strong> ((receiver != <strong>null</strong>)) { +<a name="178" href="#178">178</a> receiver.doPost(event); +<a name="179" href="#179">179</a> +<a name="180" href="#180">180</a> <em class="comment">// else post it via the hierarchy</em> +<a name="181" href="#181">181</a> } <strong>else</strong> { +<a name="182" href="#182">182</a> <em class="comment">// get a logger from the hierarchy. The name of the logger</em> +<a name="183" href="#183">183</a> <em class="comment">// is taken to be the name contained in the event.</em> +<a name="184" href="#184">184</a> remoteLogger = repository.getLogger(event.getLoggerName()); +<a name="185" href="#185">185</a> +<a name="186" href="#186">186</a> <em class="comment">//event.logger = remoteLogger;</em> +<a name="187" href="#187">187</a> <em class="comment">// apply the logger-level filter</em> +<a name="188" href="#188">188</a> <strong>if</strong> (event +<a name="189" href="#189">189</a> .getLevel() +<a name="190" href="#190">190</a> .isGreaterOrEqual(remoteLogger.getEffectiveLevel())) { +<a name="191" href="#191">191</a> <em class="comment">// finally log the event as if was generated locally</em> +<a name="192" href="#192">192</a> remoteLogger.callAppenders(event); +<a name="193" href="#193">193</a> } +<a name="194" href="#194">194</a> } +<a name="195" href="#195">195</a> } <strong>else</strong> { +<a name="196" href="#196">196</a> <em class="comment">//we simply discard this event.</em> +<a name="197" href="#197">197</a> } +<a name="198" href="#198">198</a> } +<a name="199" href="#199">199</a> } <strong>catch</strong> (java.io.EOFException e) { +<a name="200" href="#200">200</a> getLogger().info(<span class="string">"Caught java.io.EOFException closing connection."</span>); +<a name="201" href="#201">201</a> listenerException = e; +<a name="202" href="#202">202</a> } <strong>catch</strong> (java.net.SocketException e) { +<a name="203" href="#203">203</a> getLogger().info(<span class="string">"Caught java.net.SocketException closing connection."</span>); +<a name="204" href="#204">204</a> listenerException = e; +<a name="205" href="#205">205</a> } <strong>catch</strong> (IOException e) { +<a name="206" href="#206">206</a> getLogger().info(<span class="string">"Caught java.io.IOException: "</span> + e); +<a name="207" href="#207">207</a> getLogger().info(<span class="string">"Closing connection."</span>); +<a name="208" href="#208">208</a> listenerException = e; +<a name="209" href="#209">209</a> } <strong>catch</strong> (Exception e) { +<a name="210" href="#210">210</a> getLogger().error(<span class="string">"Unexpected exception. Closing connection."</span>, e); +<a name="211" href="#211">211</a> listenerException = e; +<a name="212" href="#212">212</a> } +<a name="213" href="#213">213</a> } +<a name="214" href="#214">214</a> +<a name="215" href="#215">215</a> <em class="comment">// close the socket</em> +<a name="216" href="#216">216</a> <strong>try</strong> { +<a name="217" href="#217">217</a> <strong>if</strong> (ois != <strong>null</strong>) { +<a name="218" href="#218">218</a> ois.close(); +<a name="219" href="#219">219</a> } +<a name="220" href="#220">220</a> } <strong>catch</strong> (Exception e) { +<a name="221" href="#221">221</a> <em class="comment">//getLogger().info("Could not close connection.", e);</em> +<a name="222" href="#222">222</a> } +<a name="223" href="#223">223</a> +<a name="224" href="#224">224</a> <em class="comment">// send event to listener, if configured</em> +<a name="225" href="#225">225</a> <strong>if</strong> (listenerList.size() > 0) { +<a name="226" href="#226">226</a> fireSocketClosedEvent(listenerException); +<a name="227" href="#227">227</a> } +<a name="228" href="#228">228</a> } +<a name="229" href="#229">229</a> +<a name="230" href="#230">230</a> <em>/**<em>*</em></em> +<a name="231" href="#231">231</a> <em> * Notifies all registered listeners regarding the closing of the Socket.</em> +<a name="232" href="#232">232</a> <em> * @param listenerException listener exception</em> +<a name="233" href="#233">233</a> <em> */</em> +<a name="234" href="#234">234</a> <strong>private</strong> <strong>void</strong> fireSocketClosedEvent(<strong>final</strong> Exception listenerException) { +<a name="235" href="#235">235</a> <strong>synchronized</strong> (listenerList) { +<a name="236" href="#236">236</a> <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) { +<a name="237" href="#237">237</a> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> snel = +<a name="238" href="#238">238</a> (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next(); +<a name="239" href="#239">239</a> <strong>if</strong> (snel != <strong>null</strong>) { +<a name="240" href="#240">240</a> snel.socketClosedEvent(listenerException); +<a name="241" href="#241">241</a> } +<a name="242" href="#242">242</a> } +<a name="243" href="#243">243</a> } +<a name="244" href="#244">244</a> } +<a name="245" href="#245">245</a> +<a name="246" href="#246">246</a> <em>/**<em>*</em></em> +<a name="247" href="#247">247</a> <em> * Notifies all registered listeners regarding the opening of a Socket.</em> +<a name="248" href="#248">248</a> <em> * @param remoteInfo remote info</em> +<a name="249" href="#249">249</a> <em> */</em> +<a name="250" href="#250">250</a> <strong>private</strong> <strong>void</strong> fireSocketOpened(<strong>final</strong> String remoteInfo) { +<a name="251" href="#251">251</a> <strong>synchronized</strong> (listenerList) { +<a name="252" href="#252">252</a> <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) { +<a name="253" href="#253">253</a> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> snel = +<a name="254" href="#254">254</a> (<a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a>) iter.next(); +<a name="255" href="#255">255</a> <strong>if</strong> (snel != <strong>null</strong>) { +<a name="256" href="#256">256</a> snel.socketOpened(remoteInfo); +<a name="257" href="#257">257</a> } +<a name="258" href="#258">258</a> } +<a name="259" href="#259">259</a> } +<a name="260" href="#260">260</a> } +<a name="261" href="#261">261</a> +<a name="262" href="#262">262</a> <em>/**<em>*</em></em> +<a name="263" href="#263">263</a> <em> * Sets if node is paused.</em> +<a name="264" href="#264">264</a> <em> * @param b new value</em> +<a name="265" href="#265">265</a> <em> */</em> +<a name="266" href="#266">266</a> <strong>public</strong> <strong>void</strong> setPaused(<strong>final</strong> <strong>boolean</strong> b) { +<a name="267" href="#267">267</a> <strong>this</strong>.paused = b; +<a name="268" href="#268">268</a> } +<a name="269" href="#269">269</a> +<a name="270" href="#270">270</a> <em>/**<em>*</em></em> +<a name="271" href="#271">271</a> <em> * Get if node is paused.</em> +<a name="272" href="#272">272</a> <em> * @return true if pause.</em> +<a name="273" href="#273">273</a> <em> */</em> +<a name="274" href="#274">274</a> <strong>public</strong> <strong>boolean</strong> isPaused() { +<a name="275" href="#275">275</a> <strong>return</strong> <strong>this</strong>.paused; +<a name="276" href="#276">276</a> } +<a name="277" href="#277">277</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html>
Modified: logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html?rev=570911&r1=570910&r2=570911&view=diff ============================================================================== --- logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html (original) +++ logging/site/trunk/docs/log4j/companions/receivers/xref/org/apache/log4j/net/SocketNodeEventListener.html Wed Aug 29 12:46:25 2007 @@ -35,22 +35,21 @@ <a name="26" href="#26">26</a> <a name="27" href="#27">27</a> <em> @author Mark Womack</em> <a name="28" href="#28">28</a> <em> @author Paul Smith ([EMAIL PROTECTED])</em> -<a name="29" href="#29">29</a> <em> @since 1.3</em> -<a name="30" href="#30">30</a> <em>*/</em> -<a name="31" href="#31">31</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> <strong>extends</strong> EventListener { -<a name="32" href="#32">32</a> -<a name="33" href="#33">33</a> <em>/**<em>*</em></em> -<a name="34" href="#34">34</a> <em> * Called when the SocketNode is created and begins awaiting data.</em> -<a name="35" href="#35">35</a> <em> * @param remoteInfo remote info</em> -<a name="36" href="#36">36</a> <em> */</em> -<a name="37" href="#37">37</a> <strong>void</strong> socketOpened(String remoteInfo); -<a name="38" href="#38">38</a> -<a name="39" href="#39">39</a> <em>/**<em>*</em></em> -<a name="40" href="#40">40</a> <em> Called when the socket the node was given has been closed.</em> -<a name="41" href="#41">41</a> <em> @param e exception</em> -<a name="42" href="#42">42</a> <em> */</em> -<a name="43" href="#43">43</a> <strong>void</strong> socketClosedEvent(Exception e); -<a name="44" href="#44">44</a> } +<a name="29" href="#29">29</a> <em>*/</em> +<a name="30" href="#30">30</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../org/apache/log4j/net/SocketNodeEventListener.html">SocketNodeEventListener</a> <strong>extends</strong> EventListener { +<a name="31" href="#31">31</a> +<a name="32" href="#32">32</a> <em>/**<em>*</em></em> +<a name="33" href="#33">33</a> <em> * Called when the SocketNode is created and begins awaiting data.</em> +<a name="34" href="#34">34</a> <em> * @param remoteInfo remote info</em> +<a name="35" href="#35">35</a> <em> */</em> +<a name="36" href="#36">36</a> <strong>void</strong> socketOpened(String remoteInfo); +<a name="37" href="#37">37</a> +<a name="38" href="#38">38</a> <em>/**<em>*</em></em> +<a name="39" href="#39">39</a> <em> Called when the socket the node was given has been closed.</em> +<a name="40" href="#40">40</a> <em> @param e exception</em> +<a name="41" href="#41">41</a> <em> */</em> +<a name="42" href="#42">42</a> <strong>void</strong> socketClosedEvent(Exception e); +<a name="43" href="#43">43</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html>
