logging-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From carn...@apache.org
Subject svn commit: r558355 [22/25] - in /logging/site/trunk/docs/log4j/companions/component: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/log4j/ apidocs/org/apache/log4j/class-use/ apidocs/org/apache/log4j/helpers/ apidocs/org/apache/log4j/...
Date Sat, 21 Jul 2007 17:21:03 GMT
Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginEvent.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginEvent.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginEvent.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginEvent.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,60 @@
+<!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=ISO-8859-1" /><title>PluginEvent xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/PluginEvent.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="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 name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.plugins;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> java.util.EventObject;
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  
+<a name="23" href="#23">23</a>  <em>/**<em>*</em></em>
+<a name="24" href="#24">24</a>  <em> * All Plugin events are encapsulated in this class, which</em>
+<a name="25" href="#25">25</a>  <em> * simply contains the source Plugin, but may in future include more</em>
+<a name="26" href="#26">26</a>  <em> * information.</em>
+<a name="27" href="#27">27</a>  <em> *</em>
+<a name="28" href="#28">28</a>  <em> * @author Paul Smith</em>
+<a name="29" href="#29">29</a>  <em> */</em>
+<a name="30" href="#30">30</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a> <strong>extends</strong> EventObject {
+<a name="31" href="#31">31</a>      <em>/**<em>*</em></em>
+<a name="32" href="#32">32</a>  <em>     * @param source The source plugin of the event</em>
+<a name="33" href="#33">33</a>  <em>     */</em>
+<a name="34" href="#34">34</a>      <a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a>(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> source) {
+<a name="35" href="#35">35</a>          <strong>super</strong>(source);
+<a name="36" href="#36">36</a>      }
+<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>     * Returns the source Plugin of this event, which is simple</em>
+<a name="40" href="#40">40</a>  <em>     * the getSource() method casted to Plugin for convenience.</em>
+<a name="41" href="#41">41</a>  <em>     *</em>
+<a name="42" href="#42">42</a>  <em>     * @return Plugin source of this event</em>
+<a name="43" href="#43">43</a>  <em>     */</em>
+<a name="44" href="#44">44</a>      <strong>public</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> getPlugin() {
+<a name="45" href="#45">45</a>          <strong>return</strong> (Plugin) getSource();
+<a name="46" href="#46">46</a>    }
+<a name="47" href="#47">47</a>  }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginEvent.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginListener.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginListener.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginListener.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginListener.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,56 @@
+<!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=ISO-8859-1" /><title>PluginListener xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/PluginListener.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="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 name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <em class="comment">/*</em>
+<a name="19" href="#19">19</a>  <em class="comment"> */</em>
+<a name="20" href="#20">20</a>  <strong>package</strong> org.apache.log4j.plugins;
+<a name="21" href="#21">21</a>  
+<a name="22" href="#22">22</a>  <strong>import</strong> java.util.EventListener;
+<a name="23" href="#23">23</a>  
+<a name="24" href="#24">24</a>  
+<a name="25" href="#25">25</a>  <em>/**<em>*</em></em>
+<a name="26" href="#26">26</a>  <em> * PluginListeners are notified when plugins are started or stopped</em>
+<a name="27" href="#27">27</a>  <em> * by the PluginRegistry.</em>
+<a name="28" href="#28">28</a>  <em> *</em>
+<a name="29" href="#29">29</a>  <em> * @author Paul Smith (psmith@apache.org)</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/plugins/PluginListener.html">PluginListener</a> <strong>extends</strong> EventListener {
+<a name="32" href="#32">32</a>      <em>/**<em>*</em></em>
+<a name="33" href="#33">33</a>  <em>     * Notification that plugin has started.</em>
+<a name="34" href="#34">34</a>  <em>     * @param e event</em>
+<a name="35" href="#35">35</a>  <em>     */</em>
+<a name="36" href="#36">36</a>    <strong>void</strong> pluginStarted(<a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a> e);
+<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>     * Notification that plugin has stopped.</em>
+<a name="40" href="#40">40</a>  <em>     * @param e event</em>
+<a name="41" href="#41">41</a>  <em>     */</em>
+<a name="42" href="#42">42</a>    <strong>void</strong> pluginStopped(<a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a> 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>
+

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginListener.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginRegistry.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginRegistry.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginRegistry.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginRegistry.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,317 @@
+<!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=ISO-8859-1" /><title>PluginRegistry xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/PluginRegistry.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="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 name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  <strong>package</strong> org.apache.log4j.plugins;
+<a name="18" href="#18">18</a>  
+<a name="19" href="#19">19</a>  <strong>import</strong> java.util.ArrayList;
+<a name="20" href="#20">20</a>  <strong>import</strong> java.util.Collections;
+<a name="21" href="#21">21</a>  <strong>import</strong> java.util.HashMap;
+<a name="22" href="#22">22</a>  <strong>import</strong> java.util.Iterator;
+<a name="23" href="#23">23</a>  <strong>import</strong> java.util.List;
+<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Map;
+<a name="25" href="#25">25</a>  
+<a name="26" href="#26">26</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepository;
+<a name="27" href="#27">27</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepositoryEx;
+<a name="28" href="#28">28</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepositoryEventListener;
+<a name="29" href="#29">29</a>  
+<a name="30" href="#30">30</a>  
+<a name="31" href="#31">31</a>  <em>/**<em>*</em></em>
+<a name="32" href="#32">32</a>  <em> * This is a registry for Plugin instances. It provides methods to</em>
+<a name="33" href="#33">33</a>  <em> * start and stop plugin objects individually and to stop all</em>
+<a name="34" href="#34">34</a>  <em> * plugins for a repository.</em>
+<a name="35" href="#35">35</a>  <em> *</em>
+<a name="36" href="#36">36</a>  <em> * @author Mark Womack</em>
+<a name="37" href="#37">37</a>  <em> * @author Paul Smith</em>
+<a name="38" href="#38">38</a>  <em> * @since 1.3</em>
+<a name="39" href="#39">39</a>  <em> */</em>
+<a name="40" href="#40">40</a>  <strong>public</strong> <strong>final</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/plugins/PluginRegistry.html">PluginRegistry</a> {
+<a name="41" href="#41">41</a>      <em>/**<em>*</em></em>
+<a name="42" href="#42">42</a>  <em>     * The pluginMap is keyed by plugin name and contains plugins as values.</em>
+<a name="43" href="#43">43</a>  <em>     * key=plugin.getName, value=plugin</em>
+<a name="44" href="#44">44</a>  <em>     */</em>
+<a name="45" href="#45">45</a>      <strong>private</strong> <strong>final</strong> Map pluginMap;
+<a name="46" href="#46">46</a>      <em>/**<em>*</em></em>
+<a name="47" href="#47">47</a>  <em>     * Logger repository.</em>
+<a name="48" href="#48">48</a>  <em>     */</em>
+<a name="49" href="#49">49</a>      <strong>private</strong> <strong>final</strong> <a href="../../../../org/apache/log4j/spi/LoggerRepositoryEx.html">LoggerRepositoryEx</a> loggerRepository;
+<a name="50" href="#50">50</a>  
+<a name="51" href="#51">51</a>      <em>/**<em>*</em></em>
+<a name="52" href="#52">52</a>  <em>     * the listener used to listen for repository events.</em>
+<a name="53" href="#53">53</a>  <em>     */</em>
+<a name="54" href="#54">54</a>      <strong>private</strong> <strong>final</strong> RepositoryListener listener = <strong>new</strong> RepositoryListener();
+<a name="55" href="#55">55</a>      <em>/**<em>*</em></em>
+<a name="56" href="#56">56</a>  <em>     * List of listeners.</em>
+<a name="57" href="#57">57</a>  <em>     */</em>
+<a name="58" href="#58">58</a>      <strong>private</strong> <strong>final</strong> List listenerList =
+<a name="59" href="#59">59</a>              Collections.synchronizedList(<strong>new</strong> ArrayList());
+<a name="60" href="#60">60</a>  
+<a name="61" href="#61">61</a>      <em>/**<em>*</em></em>
+<a name="62" href="#62">62</a>  <em>     * Creates a new instance.</em>
+<a name="63" href="#63">63</a>  <em>     * @param repository logger repository.</em>
+<a name="64" href="#64">64</a>  <em>     */</em>
+<a name="65" href="#65">65</a>      <strong>public</strong> <a href="../../../../org/apache/log4j/plugins/PluginRegistry.html">PluginRegistry</a>(<strong>final</strong> <a href="../../../../org/apache/log4j/spi/LoggerRepositoryEx.html">LoggerRepositoryEx</a> repository) {
+<a name="66" href="#66">66</a>          <strong>super</strong>();
+<a name="67" href="#67">67</a>          pluginMap = <strong>new</strong> HashMap();
+<a name="68" href="#68">68</a>          <strong>this</strong>.loggerRepository = repository;
+<a name="69" href="#69">69</a>          <strong>this</strong>.loggerRepository.addLoggerRepositoryEventListener(listener);
+<a name="70" href="#70">70</a>      }
+<a name="71" href="#71">71</a>  
+<a name="72" href="#72">72</a>      <em>/**<em>*</em></em>
+<a name="73" href="#73">73</a>  <em>     * Get logger repository.</em>
+<a name="74" href="#74">74</a>  <em>     * @return logger repository.</em>
+<a name="75" href="#75">75</a>  <em>     */</em>
+<a name="76" href="#76">76</a>      <strong>public</strong> <a href="../../../../org/apache/log4j/spi/LoggerRepositoryEx.html">LoggerRepositoryEx</a> getLoggerRepository() {
+<a name="77" href="#77">77</a>          <strong>return</strong> loggerRepository;
+<a name="78" href="#78">78</a>      }
+<a name="79" href="#79">79</a>  
+<a name="80" href="#80">80</a>  
+<a name="81" href="#81">81</a>      <em>/**<em>*</em></em>
+<a name="82" href="#82">82</a>  <em>     * Returns true if the specified name is already taken by</em>
+<a name="83" href="#83">83</a>  <em>     * an existing Plugin registered within the scope of the specified</em>
+<a name="84" href="#84">84</a>  <em>     * LoggerRepository.</em>
+<a name="85" href="#85">85</a>  <em>     *</em>
+<a name="86" href="#86">86</a>  <em>     * @param name The name to check the repository for</em>
+<a name="87" href="#87">87</a>  <em>     * @return true if the name is already in use, otherwise false</em>
+<a name="88" href="#88">88</a>  <em>     */</em>
+<a name="89" href="#89">89</a>      <strong>public</strong> <strong>boolean</strong> pluginNameExists(<strong>final</strong> String name) {
+<a name="90" href="#90">90</a>          <strong>synchronized</strong> (pluginMap) {
+<a name="91" href="#91">91</a>              <strong>return</strong> pluginMap.containsKey(name);
+<a name="92" href="#92">92</a>          }
+<a name="93" href="#93">93</a>      }
+<a name="94" href="#94">94</a>  
+<a name="95" href="#95">95</a>  
+<a name="96" href="#96">96</a>      <em>/**<em>*</em></em>
+<a name="97" href="#97">97</a>  <em>     * Adds a plugin to the plugin registry.</em>
+<a name="98" href="#98">98</a>  <em>     * If a plugin with the same name exists</em>
+<a name="99" href="#99">99</a>  <em>     * already, it is shutdown and removed.</em>
+<a name="100" href="#100">100</a> <em>     *</em>
+<a name="101" href="#101">101</a> <em>     * @param plugin the plugin to add.</em>
+<a name="102" href="#102">102</a> <em>     */</em>
+<a name="103" href="#103">103</a>     <strong>public</strong> <strong>void</strong> addPlugin(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> plugin) {
+<a name="104" href="#104">104</a>         <em class="comment">// put plugin into the repository's reciever map</em>
+<a name="105" href="#105">105</a>         <strong>synchronized</strong> (pluginMap) {
+<a name="106" href="#106">106</a>             String name = plugin.getName();
+<a name="107" href="#107">107</a> 
+<a name="108" href="#108">108</a>             <em class="comment">// make sure the plugin has reference to repository</em>
+<a name="109" href="#109">109</a>             plugin.setLoggerRepository(getLoggerRepository());
+<a name="110" href="#110">110</a> 
+<a name="111" href="#111">111</a>             <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> existingPlugin = (Plugin) pluginMap.get(name);
+<a name="112" href="#112">112</a>             <strong>if</strong> (existingPlugin != <strong>null</strong>) {
+<a name="113" href="#113">113</a>                 existingPlugin.shutdown();
+<a name="114" href="#114">114</a>             }
+<a name="115" href="#115">115</a> 
+<a name="116" href="#116">116</a>             <em class="comment">// put the new plugin into the map</em>
+<a name="117" href="#117">117</a>             pluginMap.put(name, plugin);
+<a name="118" href="#118">118</a>             firePluginStarted(plugin);
+<a name="119" href="#119">119</a>         }
+<a name="120" href="#120">120</a>     }
+<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>     * Calls the pluginStarted method on every registered PluginListener.</em>
+<a name="125" href="#125">125</a> <em>     *</em>
+<a name="126" href="#126">126</a> <em>     * @param plugin The plugin that has been started.</em>
+<a name="127" href="#127">127</a> <em>     */</em>
+<a name="128" href="#128">128</a>     <strong>private</strong> <strong>void</strong> firePluginStarted(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> plugin) {
+<a name="129" href="#129">129</a>         <a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a> e = <strong>null</strong>;
+<a name="130" href="#130">130</a>         <strong>synchronized</strong> (listenerList) {
+<a name="131" href="#131">131</a>             <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) {
+<a name="132" href="#132">132</a>                 <a href="../../../../org/apache/log4j/plugins/PluginListener.html">PluginListener</a> l = (PluginListener) iter.next();
+<a name="133" href="#133">133</a>                 <strong>if</strong> (e == <strong>null</strong>) {
+<a name="134" href="#134">134</a>                     e = <strong>new</strong> <a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a>(plugin);
+<a name="135" href="#135">135</a>                 }
+<a name="136" href="#136">136</a>                 l.pluginStarted(e);
+<a name="137" href="#137">137</a>             }
+<a name="138" href="#138">138</a>         }
+<a name="139" href="#139">139</a>     }
+<a name="140" href="#140">140</a> 
+<a name="141" href="#141">141</a> 
+<a name="142" href="#142">142</a>     <em>/**<em>*</em></em>
+<a name="143" href="#143">143</a> <em>     * Calls the pluginStopped method for every registered PluginListner.</em>
+<a name="144" href="#144">144</a> <em>     *</em>
+<a name="145" href="#145">145</a> <em>     * @param plugin The plugin that has been stopped.</em>
+<a name="146" href="#146">146</a> <em>     */</em>
+<a name="147" href="#147">147</a>     <strong>private</strong> <strong>void</strong> firePluginStopped(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> plugin) {
+<a name="148" href="#148">148</a>         <a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a> e = <strong>null</strong>;
+<a name="149" href="#149">149</a>         <strong>synchronized</strong> (listenerList) {
+<a name="150" href="#150">150</a>             <strong>for</strong> (Iterator iter = listenerList.iterator(); iter.hasNext();) {
+<a name="151" href="#151">151</a>                 <a href="../../../../org/apache/log4j/plugins/PluginListener.html">PluginListener</a> l = (PluginListener) iter.next();
+<a name="152" href="#152">152</a>                 <strong>if</strong> (e == <strong>null</strong>) {
+<a name="153" href="#153">153</a>                     e = <strong>new</strong> <a href="../../../../org/apache/log4j/plugins/PluginEvent.html">PluginEvent</a>(plugin);
+<a name="154" href="#154">154</a>                 }
+<a name="155" href="#155">155</a>                 l.pluginStopped(e);
+<a name="156" href="#156">156</a>             }
+<a name="157" href="#157">157</a>         }
+<a name="158" href="#158">158</a>     }
+<a name="159" href="#159">159</a> 
+<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>     * Returns all the plugins for a given repository.</em>
+<a name="163" href="#163">163</a> <em>     *</em>
+<a name="164" href="#164">164</a> <em>     * @return List list of plugins from the repository.</em>
+<a name="165" href="#165">165</a> <em>     */</em>
+<a name="166" href="#166">166</a>     <strong>public</strong> List getPlugins() {
+<a name="167" href="#167">167</a>         <strong>synchronized</strong> (pluginMap) {
+<a name="168" href="#168">168</a>             List pluginList = <strong>new</strong> ArrayList(pluginMap.size());
+<a name="169" href="#169">169</a>             Iterator iter = pluginMap.values().iterator();
+<a name="170" href="#170">170</a> 
+<a name="171" href="#171">171</a>             <strong>while</strong> (iter.hasNext()) {
+<a name="172" href="#172">172</a>                 pluginList.add(iter.next());
+<a name="173" href="#173">173</a>             }
+<a name="174" href="#174">174</a>             <strong>return</strong> pluginList;
+<a name="175" href="#175">175</a>         }
+<a name="176" href="#176">176</a>     }
+<a name="177" href="#177">177</a> 
+<a name="178" href="#178">178</a> 
+<a name="179" href="#179">179</a>     <em>/**<em>*</em></em>
+<a name="180" href="#180">180</a> <em>     * Returns all the plugins for a given repository that are instances</em>
+<a name="181" href="#181">181</a> <em>     * of a certain class.</em>
+<a name="182" href="#182">182</a> <em>     *</em>
+<a name="183" href="#183">183</a> <em>     * @param pluginClass the class the plugin must implement to be selected.</em>
+<a name="184" href="#184">184</a> <em>     * @return List list of plugins from the repository.</em>
+<a name="185" href="#185">185</a> <em>     */</em>
+<a name="186" href="#186">186</a>     <strong>public</strong> List getPlugins(<strong>final</strong> Class pluginClass) {
+<a name="187" href="#187">187</a>         <strong>synchronized</strong> (pluginMap) {
+<a name="188" href="#188">188</a>             List pluginList = <strong>new</strong> ArrayList(pluginMap.size());
+<a name="189" href="#189">189</a>             Iterator iter = pluginMap.values().iterator();
+<a name="190" href="#190">190</a> 
+<a name="191" href="#191">191</a>             <strong>while</strong> (iter.hasNext()) {
+<a name="192" href="#192">192</a>                 Object plugin = iter.next();
+<a name="193" href="#193">193</a> 
+<a name="194" href="#194">194</a>                 <strong>if</strong> (pluginClass.isInstance(plugin)) {
+<a name="195" href="#195">195</a>                     pluginList.add(plugin);
+<a name="196" href="#196">196</a>                 }
+<a name="197" href="#197">197</a>             }
+<a name="198" href="#198">198</a>             <strong>return</strong> pluginList;
+<a name="199" href="#199">199</a>         }
+<a name="200" href="#200">200</a>     }
+<a name="201" href="#201">201</a> 
+<a name="202" href="#202">202</a> 
+<a name="203" href="#203">203</a>     <em>/**<em>*</em></em>
+<a name="204" href="#204">204</a> <em>     * Stops a plugin by plugin name and repository.</em>
+<a name="205" href="#205">205</a> <em>     *</em>
+<a name="206" href="#206">206</a> <em>     * @param pluginName the name of the plugin to stop.</em>
+<a name="207" href="#207">207</a> <em>     * @return Plugin the plugin, if stopped, or null if the</em>
+<a name="208" href="#208">208</a> <em>     *         the plugin was not found in the registry.</em>
+<a name="209" href="#209">209</a> <em>     */</em>
+<a name="210" href="#210">210</a>     <strong>public</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> stopPlugin(<strong>final</strong> String pluginName) {
+<a name="211" href="#211">211</a>         <strong>synchronized</strong> (pluginMap) {
+<a name="212" href="#212">212</a>             <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> plugin = (Plugin) pluginMap.get(pluginName);
+<a name="213" href="#213">213</a> 
+<a name="214" href="#214">214</a>             <strong>if</strong> (plugin == <strong>null</strong>) {
+<a name="215" href="#215">215</a>                 <strong>return</strong> <strong>null</strong>;
+<a name="216" href="#216">216</a>             }
+<a name="217" href="#217">217</a> 
+<a name="218" href="#218">218</a>             <em class="comment">// shutdown the plugin</em>
+<a name="219" href="#219">219</a>             plugin.shutdown();
+<a name="220" href="#220">220</a> 
+<a name="221" href="#221">221</a>             <em class="comment">// remove it from the plugin map</em>
+<a name="222" href="#222">222</a>             pluginMap.remove(pluginName);
+<a name="223" href="#223">223</a>             firePluginStopped(plugin);
+<a name="224" href="#224">224</a> 
+<a name="225" href="#225">225</a>             <em class="comment">// return it for future use</em>
+<a name="226" href="#226">226</a>             <strong>return</strong> plugin;
+<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>     * Stops all plugins in the given logger repository.</em>
+<a name="232" href="#232">232</a> <em>     */</em>
+<a name="233" href="#233">233</a>     <strong>public</strong> <strong>void</strong> stopAllPlugins() {
+<a name="234" href="#234">234</a>         <strong>synchronized</strong> (pluginMap) {
+<a name="235" href="#235">235</a>             <em class="comment">// remove the listener for this repository</em>
+<a name="236" href="#236">236</a>             loggerRepository.removeLoggerRepositoryEventListener(listener);
+<a name="237" href="#237">237</a> 
+<a name="238" href="#238">238</a>             Iterator iter = pluginMap.values().iterator();
+<a name="239" href="#239">239</a> 
+<a name="240" href="#240">240</a>             <strong>while</strong> (iter.hasNext()) {
+<a name="241" href="#241">241</a>                 <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> plugin = (Plugin) iter.next();
+<a name="242" href="#242">242</a>                 plugin.shutdown();
+<a name="243" href="#243">243</a>                 firePluginStopped(plugin);
+<a name="244" href="#244">244</a>             }
+<a name="245" href="#245">245</a>         }
+<a name="246" href="#246">246</a>     }
+<a name="247" href="#247">247</a> 
+<a name="248" href="#248">248</a> 
+<a name="249" href="#249">249</a>     <em>/**<em>*</em></em>
+<a name="250" href="#250">250</a> <em>     * Adds a PluginListener to this registry to be notified</em>
+<a name="251" href="#251">251</a> <em>     * of PluginEvents.</em>
+<a name="252" href="#252">252</a> <em>     *</em>
+<a name="253" href="#253">253</a> <em>     * @param l PluginListener to add to this registry</em>
+<a name="254" href="#254">254</a> <em>     */</em>
+<a name="255" href="#255">255</a>     <strong>public</strong> <strong>void</strong> addPluginListener(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/PluginListener.html">PluginListener</a> l) {
+<a name="256" href="#256">256</a>         listenerList.add(l);
+<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>     * Removes a particular PluginListener from this registry</em>
+<a name="262" href="#262">262</a> <em>     * such that it will no longer be notified of PluginEvents.</em>
+<a name="263" href="#263">263</a> <em>     *</em>
+<a name="264" href="#264">264</a> <em>     * @param l PluginListener to remove</em>
+<a name="265" href="#265">265</a> <em>     */</em>
+<a name="266" href="#266">266</a>     <strong>public</strong> <strong>void</strong> removePluginListener(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/PluginListener.html">PluginListener</a> l) {
+<a name="267" href="#267">267</a>         listenerList.remove(l);
+<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>     * Internal class used to handle listener events from repositories.</em>
+<a name="272" href="#272">272</a> <em>     */</em>
+<a name="273" href="#273">273</a>     <strong>private</strong> <strong>class</strong> RepositoryListener implements <a href="../../../../org/apache/log4j/spi/LoggerRepositoryEventListener.html">LoggerRepositoryEventListener</a> {
+<a name="274" href="#274">274</a>         <em>/**<em>*</em></em>
+<a name="275" href="#275">275</a> <em>         * Stops all plugins associated with the repository being reset.</em>
+<a name="276" href="#276">276</a> <em>         *</em>
+<a name="277" href="#277">277</a> <em>         * @param repository the repository that was reset.</em>
+<a name="278" href="#278">278</a> <em>         */</em>
+<a name="279" href="#279">279</a>         <strong>public</strong> <strong>void</strong> configurationResetEvent(<strong>final</strong> LoggerRepository repository) {
+<a name="280" href="#280">280</a>             PluginRegistry.<strong>this</strong>.stopAllPlugins();
+<a name="281" href="#281">281</a>         }
+<a name="282" href="#282">282</a> 
+<a name="283" href="#283">283</a> 
+<a name="284" href="#284">284</a>         <em>/**<em>*</em></em>
+<a name="285" href="#285">285</a> <em>         * Called when the repository configuration is changed.</em>
+<a name="286" href="#286">286</a> <em>         *</em>
+<a name="287" href="#287">287</a> <em>         * @param repository the repository that was changed.</em>
+<a name="288" href="#288">288</a> <em>         */</em>
+<a name="289" href="#289">289</a>         <strong>public</strong> <strong>void</strong> configurationChangedEvent(
+<a name="290" href="#290">290</a>                 <strong>final</strong> LoggerRepository repository) {
+<a name="291" href="#291">291</a>             <em class="comment">// do nothing with this event</em>
+<a name="292" href="#292">292</a>         }
+<a name="293" href="#293">293</a> 
+<a name="294" href="#294">294</a> 
+<a name="295" href="#295">295</a>         <em>/**<em>*</em></em>
+<a name="296" href="#296">296</a> <em>         * Stops all plugins associated with the repository being shutdown.</em>
+<a name="297" href="#297">297</a> <em>         *</em>
+<a name="298" href="#298">298</a> <em>         * @param repository the repository being shutdown.</em>
+<a name="299" href="#299">299</a> <em>         */</em>
+<a name="300" href="#300">300</a>         <strong>public</strong> <strong>void</strong> shutdownEvent(<strong>final</strong> LoggerRepository repository) {
+<a name="301" href="#301">301</a>             PluginRegistry.<strong>this</strong>.stopAllPlugins();
+<a name="302" href="#302">302</a>         }
+<a name="303" href="#303">303</a>     }
+<a name="304" href="#304">304</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginRegistry.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginSkeleton.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginSkeleton.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginSkeleton.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginSkeleton.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,236 @@
+<!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=ISO-8859-1" /><title>PluginSkeleton xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/PluginSkeleton.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="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 name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.plugins;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> org.apache.log4j.spi.ComponentBase;
+<a name="21" href="#21">21</a>  <strong>import</strong> org.apache.log4j.spi.LoggerRepository;
+<a name="22" href="#22">22</a>  
+<a name="23" href="#23">23</a>  <strong>import</strong> java.beans.PropertyChangeEvent;
+<a name="24" href="#24">24</a>  <strong>import</strong> java.beans.PropertyChangeListener;
+<a name="25" href="#25">25</a>  <strong>import</strong> java.beans.PropertyChangeSupport;
+<a name="26" href="#26">26</a>  
+<a name="27" href="#27">27</a>  
+<a name="28" href="#28">28</a>  <em>/**<em>*</em></em>
+<a name="29" href="#29">29</a>  <em> * A convienent abstract class for plugin subclasses that implements</em>
+<a name="30" href="#30">30</a>  <em> * the basic methods of the Plugin interface. Subclasses are required</em>
+<a name="31" href="#31">31</a>  <em> * to implement the isActive(), activateOptions(), and shutdown()</em>
+<a name="32" href="#32">32</a>  <em> * methods.</em>
+<a name="33" href="#33">33</a>  <em> * &lt;p/></em>
+<a name="34" href="#34">34</a>  <em> * &lt;p>Developers are not required to subclass PluginSkeleton to</em>
+<a name="35" href="#35">35</a>  <em> * develop their own plugins (they are only required to implement the</em>
+<a name="36" href="#36">36</a>  <em> * Plugin interface), but it provides a convenient base class to start</em>
+<a name="37" href="#37">37</a>  <em> * from.</em>
+<a name="38" href="#38">38</a>  <em> * &lt;p/></em>
+<a name="39" href="#39">39</a>  <em> * Contributors: Nicko Cadell</em>
+<a name="40" href="#40">40</a>  <em> *</em>
+<a name="41" href="#41">41</a>  <em> * @author Mark Womack (mwomack@apache.org)</em>
+<a name="42" href="#42">42</a>  <em> * @author Paul Smith (psmith@apache.org)</em>
+<a name="43" href="#43">43</a>  <em> * @since 1.3</em>
+<a name="44" href="#44">44</a>  <em> */</em>
+<a name="45" href="#45">45</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html">PluginSkeleton</a> <strong>extends</strong> <a href="../../../../org/apache/log4j/spi/ComponentBase.html">ComponentBase</a> implements <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> {
+<a name="46" href="#46">46</a>      <em>/**<em>*</em></em>
+<a name="47" href="#47">47</a>  <em>     * Name of this plugin.</em>
+<a name="48" href="#48">48</a>  <em>     */</em>
+<a name="49" href="#49">49</a>      <strong>protected</strong> String name = <span class="string">""</span>;
+<a name="50" href="#50">50</a>  
+<a name="51" href="#51">51</a>      <em>/**<em>*</em></em>
+<a name="52" href="#52">52</a>  <em>     * Active state of plugin.</em>
+<a name="53" href="#53">53</a>  <em>     */</em>
+<a name="54" href="#54">54</a>      <strong>protected</strong> <strong>boolean</strong> active;
+<a name="55" href="#55">55</a>  
+<a name="56" href="#56">56</a>      <em>/**<em>*</em></em>
+<a name="57" href="#57">57</a>  <em>     * This is a delegate that does all the PropertyChangeListener</em>
+<a name="58" href="#58">58</a>  <em>     * support.</em>
+<a name="59" href="#59">59</a>  <em>     */</em>
+<a name="60" href="#60">60</a>      <strong>private</strong> PropertyChangeSupport propertySupport =
+<a name="61" href="#61">61</a>              <strong>new</strong> PropertyChangeSupport(<strong>this</strong>);
+<a name="62" href="#62">62</a>  
+<a name="63" href="#63">63</a>      <em>/**<em>*</em></em>
+<a name="64" href="#64">64</a>  <em>     * Construct new instance.</em>
+<a name="65" href="#65">65</a>  <em>     */</em>
+<a name="66" href="#66">66</a>      <strong>protected</strong> <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html">PluginSkeleton</a>() {
+<a name="67" href="#67">67</a>          <strong>super</strong>();
+<a name="68" href="#68">68</a>      }
+<a name="69" href="#69">69</a>  
+<a name="70" href="#70">70</a>      <em>/**<em>*</em></em>
+<a name="71" href="#71">71</a>  <em>     * Gets the name of the plugin.</em>
+<a name="72" href="#72">72</a>  <em>     *</em>
+<a name="73" href="#73">73</a>  <em>     * @return String the name of the plugin.</em>
+<a name="74" href="#74">74</a>  <em>     */</em>
+<a name="75" href="#75">75</a>      <strong>public</strong> String getName() {
+<a name="76" href="#76">76</a>          <strong>return</strong> name;
+<a name="77" href="#77">77</a>      }
+<a name="78" href="#78">78</a>  
+<a name="79" href="#79">79</a>      <em>/**<em>*</em></em>
+<a name="80" href="#80">80</a>  <em>     * Sets the name of the plugin and notifies</em>
+<a name="81" href="#81">81</a>  <em>     * PropertyChangeListeners of the change.</em>
+<a name="82" href="#82">82</a>  <em>     *</em>
+<a name="83" href="#83">83</a>  <em>     * @param newName the name of the plugin to set.</em>
+<a name="84" href="#84">84</a>  <em>     */</em>
+<a name="85" href="#85">85</a>      <strong>public</strong> <strong>void</strong> setName(<strong>final</strong> String newName) {
+<a name="86" href="#86">86</a>          String oldName = <strong>this</strong>.name;
+<a name="87" href="#87">87</a>          <strong>this</strong>.name = newName;
+<a name="88" href="#88">88</a>          propertySupport.firePropertyChange(<span class="string">"name"</span>, oldName, <strong>this</strong>.name);
+<a name="89" href="#89">89</a>      }
+<a name="90" href="#90">90</a>  
+<a name="91" href="#91">91</a>      <em>/**<em>*</em></em>
+<a name="92" href="#92">92</a>  <em>     * Gets the logger repository for this plugin.</em>
+<a name="93" href="#93">93</a>  <em>     *</em>
+<a name="94" href="#94">94</a>  <em>     * @return LoggerRepository the logger repository this plugin will affect.</em>
+<a name="95" href="#95">95</a>  <em>     */</em>
+<a name="96" href="#96">96</a>      <strong>public</strong> LoggerRepository getLoggerRepository() {
+<a name="97" href="#97">97</a>          <strong>return</strong> repository;
+<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>     * Sets the logger repository used by this plugin and notifies a</em>
+<a name="102" href="#102">102</a> <em>     * relevant PropertyChangeListeners registered. This</em>
+<a name="103" href="#103">103</a> <em>     * repository will be used by the plugin functionality.</em>
+<a name="104" href="#104">104</a> <em>     *</em>
+<a name="105" href="#105">105</a> <em>     * @param repository the logger repository that this plugin should affect.</em>
+<a name="106" href="#106">106</a> <em>     */</em>
+<a name="107" href="#107">107</a>     <strong>public</strong> <strong>void</strong> setLoggerRepository(<strong>final</strong> LoggerRepository repository) {
+<a name="108" href="#108">108</a>         Object oldValue = <strong>this</strong>.repository;
+<a name="109" href="#109">109</a>         <strong>this</strong>.repository = repository;
+<a name="110" href="#110">110</a>         firePropertyChange(<span class="string">"loggerRepository"</span>, oldValue, <strong>this</strong>.repository);
+<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>     * Returns whether this plugin is Active or not.</em>
+<a name="115" href="#115">115</a> <em>     *</em>
+<a name="116" href="#116">116</a> <em>     * @return true/false</em>
+<a name="117" href="#117">117</a> <em>     */</em>
+<a name="118" href="#118">118</a>     <strong>public</strong> <strong>synchronized</strong> <strong>boolean</strong> isActive() {
+<a name="119" href="#119">119</a>         <strong>return</strong> active;
+<a name="120" href="#120">120</a>     }
+<a name="121" href="#121">121</a> 
+<a name="122" href="#122">122</a>     <em>/**<em>*</em></em>
+<a name="123" href="#123">123</a> <em>     * Returns true if the plugin has the same name and logger repository as the</em>
+<a name="124" href="#124">124</a> <em>     * testPlugin passed in.</em>
+<a name="125" href="#125">125</a> <em>     *</em>
+<a name="126" href="#126">126</a> <em>     * @param testPlugin The plugin to test equivalency against.</em>
+<a name="127" href="#127">127</a> <em>     * @return Returns true if testPlugin is considered to be equivalent.</em>
+<a name="128" href="#128">128</a> <em>     */</em>
+<a name="129" href="#129">129</a>     <strong>public</strong> <strong>boolean</strong> isEquivalent(<strong>final</strong> <a href="../../../../org/apache/log4j/plugins/Plugin.html">Plugin</a> testPlugin) {
+<a name="130" href="#130">130</a>         <strong>return</strong> (repository == testPlugin.getLoggerRepository())
+<a name="131" href="#131">131</a>                 &amp;&amp; ((<strong>this</strong>.name == <strong>null</strong> &amp;&amp; testPlugin.getName() == <strong>null</strong>)
+<a name="132" href="#132">132</a>                 || (<strong>this</strong>.name != <strong>null</strong>
+<a name="133" href="#133">133</a>                            &amp;&amp; name.equals(testPlugin.getName())))
+<a name="134" href="#134">134</a>                 &amp;&amp; <strong>this</strong>.getClass().equals(testPlugin.getClass());
+<a name="135" href="#135">135</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>     * Add property change listener.</em>
+<a name="139" href="#139">139</a> <em>     * @param listener listener.</em>
+<a name="140" href="#140">140</a> <em>     */</em>
+<a name="141" href="#141">141</a>     <strong>public</strong> <strong>final</strong> <strong>void</strong> addPropertyChangeListener(
+<a name="142" href="#142">142</a>             <strong>final</strong> PropertyChangeListener listener) {
+<a name="143" href="#143">143</a>         propertySupport.addPropertyChangeListener(listener);
+<a name="144" href="#144">144</a>     }
+<a name="145" href="#145">145</a> 
+<a name="146" href="#146">146</a>     <em>/**<em>*</em></em>
+<a name="147" href="#147">147</a> <em>     * Add property change listener for one property only.</em>
+<a name="148" href="#148">148</a> <em>     * @param propertyName property name.</em>
+<a name="149" href="#149">149</a> <em>     * @param listener listener.</em>
+<a name="150" href="#150">150</a> <em>     */</em>
+<a name="151" href="#151">151</a>     <strong>public</strong> <strong>final</strong> <strong>void</strong> addPropertyChangeListener(
+<a name="152" href="#152">152</a>             <strong>final</strong> String propertyName,
+<a name="153" href="#153">153</a>             <strong>final</strong> PropertyChangeListener listener) {
+<a name="154" href="#154">154</a>         propertySupport.addPropertyChangeListener(propertyName, listener);
+<a name="155" href="#155">155</a>     }
+<a name="156" href="#156">156</a> 
+<a name="157" href="#157">157</a>     <em>/**<em>*</em></em>
+<a name="158" href="#158">158</a> <em>     * Remove property change listener.</em>
+<a name="159" href="#159">159</a> <em>     * @param listener listener.</em>
+<a name="160" href="#160">160</a> <em>     */</em>
+<a name="161" href="#161">161</a>     <strong>public</strong> <strong>final</strong> <strong>void</strong> removePropertyChangeListener(
+<a name="162" href="#162">162</a>             <strong>final</strong> PropertyChangeListener listener) {
+<a name="163" href="#163">163</a>         propertySupport.removePropertyChangeListener(listener);
+<a name="164" href="#164">164</a>     }
+<a name="165" href="#165">165</a> 
+<a name="166" href="#166">166</a>     <em>/**<em>*</em></em>
+<a name="167" href="#167">167</a> <em>     * Remove property change listener on a specific property.</em>
+<a name="168" href="#168">168</a> <em>     * @param propertyName property name.</em>
+<a name="169" href="#169">169</a> <em>     * @param listener listener.</em>
+<a name="170" href="#170">170</a> <em>     */</em>
+<a name="171" href="#171">171</a>     <strong>public</strong> <strong>final</strong> <strong>void</strong> removePropertyChangeListener(
+<a name="172" href="#172">172</a>             <strong>final</strong> String propertyName,
+<a name="173" href="#173">173</a>             <strong>final</strong> PropertyChangeListener listener) {
+<a name="174" href="#174">174</a>         propertySupport.removePropertyChangeListener(propertyName, listener);
+<a name="175" href="#175">175</a>     }
+<a name="176" href="#176">176</a> 
+<a name="177" href="#177">177</a>     <em>/**<em>*</em></em>
+<a name="178" href="#178">178</a> <em>     * Fire a property change event to appropriate listeners.</em>
+<a name="179" href="#179">179</a> <em>     * @param evt change event.</em>
+<a name="180" href="#180">180</a> <em>     */</em>
+<a name="181" href="#181">181</a>     <strong>protected</strong> <strong>final</strong> <strong>void</strong> firePropertyChange(
+<a name="182" href="#182">182</a>             <strong>final</strong> PropertyChangeEvent evt) {
+<a name="183" href="#183">183</a>         propertySupport.firePropertyChange(evt);
+<a name="184" href="#184">184</a>     }
+<a name="185" href="#185">185</a> 
+<a name="186" href="#186">186</a>     <em>/**<em>*</em></em>
+<a name="187" href="#187">187</a> <em>     * Fire property change event to appropriate listeners.</em>
+<a name="188" href="#188">188</a> <em>     * @param propertyName property name.</em>
+<a name="189" href="#189">189</a> <em>     * @param oldValue old value.</em>
+<a name="190" href="#190">190</a> <em>     * @param newValue new value.</em>
+<a name="191" href="#191">191</a> <em>     */</em>
+<a name="192" href="#192">192</a>     <strong>protected</strong> <strong>final</strong> <strong>void</strong> firePropertyChange(
+<a name="193" href="#193">193</a>             <strong>final</strong> String propertyName,
+<a name="194" href="#194">194</a>             <strong>final</strong> <strong>boolean</strong> oldValue,
+<a name="195" href="#195">195</a>             <strong>final</strong> <strong>boolean</strong> newValue) {
+<a name="196" href="#196">196</a>         propertySupport.firePropertyChange(propertyName, oldValue, newValue);
+<a name="197" href="#197">197</a>     }
+<a name="198" href="#198">198</a> 
+<a name="199" href="#199">199</a>     <em>/**<em>*</em></em>
+<a name="200" href="#200">200</a> <em>     * Fire property change event to appropriate listeners.</em>
+<a name="201" href="#201">201</a> <em>     * @param propertyName property name.</em>
+<a name="202" href="#202">202</a> <em>     * @param oldValue old value.</em>
+<a name="203" href="#203">203</a> <em>     * @param newValue new value.</em>
+<a name="204" href="#204">204</a> <em>     */</em>
+<a name="205" href="#205">205</a>     <strong>protected</strong> <strong>final</strong> <strong>void</strong> firePropertyChange(
+<a name="206" href="#206">206</a>             <strong>final</strong> String propertyName,
+<a name="207" href="#207">207</a>             <strong>final</strong> <strong>int</strong> oldValue, <strong>final</strong> <strong>int</strong> newValue) {
+<a name="208" href="#208">208</a>         propertySupport.firePropertyChange(propertyName, oldValue, newValue);
+<a name="209" href="#209">209</a>     }
+<a name="210" href="#210">210</a> 
+<a name="211" href="#211">211</a>     <em>/**<em>*</em></em>
+<a name="212" href="#212">212</a> <em>     * Fire property change event to appropriate listeners.</em>
+<a name="213" href="#213">213</a> <em>     * @param propertyName property name.</em>
+<a name="214" href="#214">214</a> <em>     * @param oldValue old value.</em>
+<a name="215" href="#215">215</a> <em>     * @param newValue new value.</em>
+<a name="216" href="#216">216</a> <em>     */</em>
+<a name="217" href="#217">217</a>     <strong>protected</strong> <strong>final</strong> <strong>void</strong> firePropertyChange(
+<a name="218" href="#218">218</a>             <strong>final</strong> String propertyName,
+<a name="219" href="#219">219</a>             <strong>final</strong> Object oldValue,
+<a name="220" href="#220">220</a>             <strong>final</strong> Object newValue) {
+<a name="221" href="#221">221</a>         propertySupport.firePropertyChange(propertyName, oldValue, newValue);
+<a name="222" href="#222">222</a>     }
+<a name="223" href="#223">223</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/PluginSkeleton.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Receiver.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Receiver.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Receiver.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Receiver.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,145 @@
+<!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=ISO-8859-1" /><title>Receiver xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/plugins/Receiver.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="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 name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.plugins;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  <strong>import</strong> org.apache.log4j.Level;
+<a name="21" href="#21">21</a>  <strong>import</strong> org.apache.log4j.Logger;
+<a name="22" href="#22">22</a>  <strong>import</strong> org.apache.log4j.spi.LoggingEvent;
+<a name="23" href="#23">23</a>  <strong>import</strong> org.apache.log4j.spi.Thresholdable;
+<a name="24" href="#24">24</a>  
+<a name="25" href="#25">25</a>  
+<a name="26" href="#26">26</a>  <em>/**<em>*</em></em>
+<a name="27" href="#27">27</a>  <em> * Defines the base class for Receiver plugins.</em>
+<a name="28" href="#28">28</a>  <em> * &lt;p/></em>
+<a name="29" href="#29">29</a>  <em> * &lt;p>Just as Appenders send logging events outside of the log4j</em>
+<a name="30" href="#30">30</a>  <em> * environment (to files, to smtp, to sockets, etc), Receivers bring</em>
+<a name="31" href="#31">31</a>  <em> * logging events inside the log4j environment.</em>
+<a name="32" href="#32">32</a>  <em> * &lt;p/></em>
+<a name="33" href="#33">33</a>  <em> * &lt;p>Receivers are meant to support the receiving of</em>
+<a name="34" href="#34">34</a>  <em> * remote logging events from another process. For example,</em>
+<a name="35" href="#35">35</a>  <em> * SocketAppender "appends" a logging event to a socket, configured</em>
+<a name="36" href="#36">36</a>  <em> * for a specific host and port number.  On the receiving side of</em>
+<a name="37" href="#37">37</a>  <em> * the socket can be a SocketReceiver object.  The SocketReceiver</em>
+<a name="38" href="#38">38</a>  <em> * object receives the logging event, and then "posts" it to the</em>
+<a name="39" href="#39">39</a>  <em> * log4j environment (LoggerRepository) on the receiving machine, to</em>
+<a name="40" href="#40">40</a>  <em> * be handled by the configured appenders, etc.  The various</em>
+<a name="41" href="#41">41</a>  <em> * settings in this environment (Logger levels, Appender filters &amp;</em>
+<a name="42" href="#42">42</a>  <em> * thresholds) are applied to the received logging event.</em>
+<a name="43" href="#43">43</a>  <em> * &lt;p/></em>
+<a name="44" href="#44">44</a>  <em> * &lt;p>Receivers can also be used to "import" log messages from other</em>
+<a name="45" href="#45">45</a>  <em> * logging packages into the log4j environment.</em>
+<a name="46" href="#46">46</a>  <em> * &lt;p/></em>
+<a name="47" href="#47">47</a>  <em> * &lt;p>Receivers can be configured to post events to a given</em>
+<a name="48" href="#48">48</a>  <em> * LoggerRepository.</em>
+<a name="49" href="#49">49</a>  <em> * &lt;p/></em>
+<a name="50" href="#50">50</a>  <em> * &lt;p>Subclasses of Receiver must implement the isActive(),</em>
+<a name="51" href="#51">51</a>  <em> * activateOptions(), and shutdown() methods. The doPost() method</em>
+<a name="52" href="#52">52</a>  <em> * is provided to standardize the "import" of remote events into</em>
+<a name="53" href="#53">53</a>  <em> * the repository.</em>
+<a name="54" href="#54">54</a>  <em> *</em>
+<a name="55" href="#55">55</a>  <em> * @author Mark Womack</em>
+<a name="56" href="#56">56</a>  <em> * @author Ceki G&amp;uuml;lc&amp;uuml;</em>
+<a name="57" href="#57">57</a>  <em> * @author Paul Smith (psmith@apache.org)</em>
+<a name="58" href="#58">58</a>  <em> * @since 1.3</em>
+<a name="59" href="#59">59</a>  <em> */</em>
+<a name="60" href="#60">60</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../../org/apache/log4j/plugins/Receiver.html">Receiver</a> <strong>extends</strong> <a href="../../../../org/apache/log4j/plugins/PluginSkeleton.html">PluginSkeleton</a> implements <a href="../../../../org/apache/log4j/spi/Thresholdable.html">Thresholdable</a> {
+<a name="61" href="#61">61</a>      <em>/**<em>*</em></em>
+<a name="62" href="#62">62</a>  <em>     * Threshold level.</em>
+<a name="63" href="#63">63</a>  <em>     */</em>
+<a name="64" href="#64">64</a>      <strong>protected</strong> Level thresholdLevel;
+<a name="65" href="#65">65</a>  
+<a name="66" href="#66">66</a>      <em>/**<em>*</em></em>
+<a name="67" href="#67">67</a>  <em>     * Create new instance.</em>
+<a name="68" href="#68">68</a>  <em>     */</em>
+<a name="69" href="#69">69</a>      <strong>protected</strong> <a href="../../../../org/apache/log4j/plugins/Receiver.html">Receiver</a>() {
+<a name="70" href="#70">70</a>          <strong>super</strong>();
+<a name="71" href="#71">71</a>      }
+<a name="72" href="#72">72</a>  
+<a name="73" href="#73">73</a>      <em>/**<em>*</em></em>
+<a name="74" href="#74">74</a>  <em>     * Sets the receiver theshold to the given level.</em>
+<a name="75" href="#75">75</a>  <em>     *</em>
+<a name="76" href="#76">76</a>  <em>     * @param level The threshold level events must equal or be greater</em>
+<a name="77" href="#77">77</a>  <em>     *              than before further processing can be done.</em>
+<a name="78" href="#78">78</a>  <em>     */</em>
+<a name="79" href="#79">79</a>      <strong>public</strong> <strong>void</strong> setThreshold(<strong>final</strong> Level level) {
+<a name="80" href="#80">80</a>          Level oldValue = <strong>this</strong>.thresholdLevel;
+<a name="81" href="#81">81</a>          thresholdLevel = level;
+<a name="82" href="#82">82</a>          firePropertyChange(<span class="string">"threshold"</span>, oldValue, <strong>this</strong>.thresholdLevel);
+<a name="83" href="#83">83</a>      }
+<a name="84" href="#84">84</a>  
+<a name="85" href="#85">85</a>      <em>/**<em>*</em></em>
+<a name="86" href="#86">86</a>  <em>     * Gets the current threshold setting of the receiver.</em>
+<a name="87" href="#87">87</a>  <em>     *</em>
+<a name="88" href="#88">88</a>  <em>     * @return Level The current threshold level of the receiver.</em>
+<a name="89" href="#89">89</a>  <em>     */</em>
+<a name="90" href="#90">90</a>      <strong>public</strong> Level getThreshold() {
+<a name="91" href="#91">91</a>          <strong>return</strong> thresholdLevel;
+<a name="92" href="#92">92</a>      }
+<a name="93" href="#93">93</a>  
+<a name="94" href="#94">94</a>      <em>/**<em>*</em></em>
+<a name="95" href="#95">95</a>  <em>     * Returns true if the given level is equals or greater than the current</em>
+<a name="96" href="#96">96</a>  <em>     * threshold value of the receiver.</em>
+<a name="97" href="#97">97</a>  <em>     *</em>
+<a name="98" href="#98">98</a>  <em>     * @param level The level to test against the receiver threshold.</em>
+<a name="99" href="#99">99</a>  <em>     * @return boolean True if level is equal or greater than the</em>
+<a name="100" href="#100">100</a> <em>     *         receiver threshold.</em>
+<a name="101" href="#101">101</a> <em>     */</em>
+<a name="102" href="#102">102</a>     <strong>public</strong> <strong>boolean</strong> isAsSevereAsThreshold(<strong>final</strong> Level level) {
+<a name="103" href="#103">103</a>         <strong>return</strong> ((thresholdLevel == <strong>null</strong>)
+<a name="104" href="#104">104</a>                 || level.isGreaterOrEqual(thresholdLevel));
+<a name="105" href="#105">105</a>     }
+<a name="106" href="#106">106</a> 
+<a name="107" href="#107">107</a>     <em>/**<em>*</em></em>
+<a name="108" href="#108">108</a> <em>     * Posts the logging event to a logger in the configured logger</em>
+<a name="109" href="#109">109</a> <em>     * repository.</em>
+<a name="110" href="#110">110</a> <em>     *</em>
+<a name="111" href="#111">111</a> <em>     * @param event the log event to post to the local log4j environment.</em>
+<a name="112" href="#112">112</a> <em>     */</em>
+<a name="113" href="#113">113</a>     <strong>public</strong> <strong>void</strong> doPost(<strong>final</strong> LoggingEvent event) {
+<a name="114" href="#114">114</a>         <em class="comment">// if event does not meet threshold, exit now</em>
+<a name="115" href="#115">115</a>         <strong>if</strong> (!isAsSevereAsThreshold(event.getLevel())) {
+<a name="116" href="#116">116</a>             <strong>return</strong>;
+<a name="117" href="#117">117</a>         }
+<a name="118" href="#118">118</a> 
+<a name="119" href="#119">119</a>         <em class="comment">// get the "local" logger for this event from the</em>
+<a name="120" href="#120">120</a>         <em class="comment">// configured repository.</em>
+<a name="121" href="#121">121</a>         Logger localLogger =
+<a name="122" href="#122">122</a>                 getLoggerRepository().getLogger(event.getLoggerName());
+<a name="123" href="#123">123</a> 
+<a name="124" href="#124">124</a>         <em class="comment">// if the logger level is greater or equal to the level</em>
+<a name="125" href="#125">125</a>         <em class="comment">// of the event, use the logger to append the event.</em>
+<a name="126" href="#126">126</a>         <strong>if</strong> (event.getLevel()
+<a name="127" href="#127">127</a>                 .isGreaterOrEqual(localLogger.getEffectiveLevel())) {
+<a name="128" href="#128">128</a>             <em class="comment">// call the loggers appenders to process the event</em>
+<a name="129" href="#129">129</a>             localLogger.callAppenders(event);
+<a name="130" href="#130">130</a>         }
+<a name="131" href="#131">131</a>   }
+<a name="132" href="#132">132</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/Receiver.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-frame.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-frame.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-frame.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-frame.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,45 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+		<title>Apache Component Companion for log4j 1.2. 1.0-SNAPSHOT Reference Package org.apache.log4j.plugins</title>
+		<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
+	</head>
+	<body>
+
+		<h3>
+        	<a href="package-summary.html" target="classFrame">org.apache.log4j.plugins</a>
+      	</h3>
+
+      	<h3>Classes</h3>
+
+      	<ul>
+      		          	<li>
+            	<a href="Pauseable.html" target="classFrame">Pauseable</a>
+          	</li>
+          	          	<li>
+            	<a href="Plugin.html" target="classFrame">Plugin</a>
+          	</li>
+          	          	<li>
+            	<a href="PluginConfigurator.html" target="classFrame">PluginConfigurator</a>
+          	</li>
+          	          	<li>
+            	<a href="PluginEvent.html" target="classFrame">PluginEvent</a>
+          	</li>
+          	          	<li>
+            	<a href="PluginListener.html" target="classFrame">PluginListener</a>
+          	</li>
+          	          	<li>
+            	<a href="PluginRegistry.html" target="classFrame">PluginRegistry</a>
+          	</li>
+          	          	<li>
+            	<a href="PluginSkeleton.html" target="classFrame">PluginSkeleton</a>
+          	</li>
+          	          	<li>
+            	<a href="Receiver.html" target="classFrame">Receiver</a>
+          	</li>
+          	      	</ul>
+
+	</body>
+</html>
\ No newline at end of file

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-frame.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-summary.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-summary.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-summary.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-summary.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,102 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+	<head>
+		<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+		<title>Apache Component Companion for log4j 1.2. 1.0-SNAPSHOT Reference Package $name</title>
+		<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="style" />
+	</head>
+	<body>
+		      	<div class="overview">
+        	<ul>
+          		<li>
+            		<a href="../../../../overview-summary.html">Overview</a>
+          		</li>
+          		<li class="selected">Package</li>
+        	</ul>
+      	</div>
+      	<div class="framenoframe">
+        	<ul>
+          		<li>
+            		<a href="../../../../index.html" target="_top">FRAMES</a>
+          		</li>
+          		<li>
+            		<a href="package-summary.html" target="_top">NO FRAMES</a>
+          		</li>
+        	</ul>
+      	</div>
+		
+		      	<h2>Package org.apache.log4j.plugins</h2>
+
+		<table class="summary">
+        	<thead>
+          		<tr>
+            		<th>Class Summary</th>
+          		</tr>
+        	</thead>
+        	<tbody>
+        		            	<tr>
+              		<td>
+                		<a href="Pauseable.html" target="classFrame">Pauseable</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="Plugin.html" target="classFrame">Plugin</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="PluginConfigurator.html" target="classFrame">PluginConfigurator</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="PluginEvent.html" target="classFrame">PluginEvent</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="PluginListener.html" target="classFrame">PluginListener</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="PluginRegistry.html" target="classFrame">PluginRegistry</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="PluginSkeleton.html" target="classFrame">PluginSkeleton</a>
+              		</td>
+            	</tr>
+				            	<tr>
+              		<td>
+                		<a href="Receiver.html" target="classFrame">Receiver</a>
+              		</td>
+            	</tr>
+				        	</tbody>
+      	</table>
+		
+		      	<div class="overview">
+        	<ul>
+          		<li>
+            		<a href="../../../../overview-summary.html">Overview</a>
+          		</li>
+          		<li class="selected">Package</li>
+        	</ul>
+      	</div>
+      	<div class="framenoframe">
+        	<ul>
+          		<li>
+            		<a href="../../../../index.html" target="_top">FRAMES</a>
+          		</li>
+          		<li>
+            		<a href="package-summary.html" target="_top">NO FRAMES</a>
+          		</li>
+        	</ul>
+      	</div>
+				<hr />
+		Copyright &copy; null Apache Software Foundation. All Rights Reserved.
+	</body>
+</html>
\ No newline at end of file

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/plugins/package-summary.html
------------------------------------------------------------------------------
    svn:mime-type = text/html

Added: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Job.html
URL: http://svn.apache.org/viewvc/logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Job.html?view=auto&rev=558355
==============================================================================
--- logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Job.html (added)
+++ logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Job.html Sat Jul 21 10:20:56 2007
@@ -0,0 +1,49 @@
+<!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=ISO-8859-1" /><title>Job xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../../../../apidocs/org/apache/log4j/scheduler/Job.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a>   <em class="comment">/*</em>
+<a name="2" href="#2">2</a>   <em class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
+<a name="3" href="#3">3</a>   <em class="comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
+<a name="4" href="#4">4</a>   <em class="comment"> * this work for additional information regarding copyright ownership.</em>
+<a name="5" href="#5">5</a>   <em class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
+<a name="6" href="#6">6</a>   <em class="comment"> * (the "License"); you may not use this file except in compliance with</em>
+<a name="7" href="#7">7</a>   <em class="comment"> * the License.  You may obtain a copy of the License at</em>
+<a name="8" href="#8">8</a>   <em class="comment"> *</em>
+<a name="9" href="#9">9</a>   <em class="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 name="10" href="#10">10</a>  <em class="comment"> *</em>
+<a name="11" href="#11">11</a>  <em class="comment"> * Unless required by applicable law or agreed to in writing, software</em>
+<a name="12" href="#12">12</a>  <em class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
+<a name="13" href="#13">13</a>  <em class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
+<a name="14" href="#14">14</a>  <em class="comment"> * See the License for the specific language governing permissions and</em>
+<a name="15" href="#15">15</a>  <em class="comment"> * limitations under the License.</em>
+<a name="16" href="#16">16</a>  <em class="comment"> */</em>
+<a name="17" href="#17">17</a>  
+<a name="18" href="#18">18</a>  <strong>package</strong> org.apache.log4j.scheduler;
+<a name="19" href="#19">19</a>  
+<a name="20" href="#20">20</a>  
+<a name="21" href="#21">21</a>  <em>/**<em>*</em></em>
+<a name="22" href="#22">22</a>  <em> * Job is a very simple interface. It only has a single method {@link #execute}</em>
+<a name="23" href="#23">23</a>  <em> * which is called by the {@link Scheduler} when a task is ready for execution.</em>
+<a name="24" href="#24">24</a>  <em> * &lt;p/></em>
+<a name="25" href="#25">25</a>  <em> * It is assumed that the execution context</em>
+<a name="26" href="#26">26</a>  <em> * are contained within the implementing</em>
+<a name="27" href="#27">27</a>  <em> * {@link Job} itself.</em>
+<a name="28" href="#28">28</a>  <em> *</em>
+<a name="29" href="#29">29</a>  <em> * @author Ceki G&amp;uuml;lc&amp;uuml;</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/scheduler/Job.html">Job</a> {
+<a name="32" href="#32">32</a>      <em>/**<em>*</em></em>
+<a name="33" href="#33">33</a>  <em>     * Execute job.</em>
+<a name="34" href="#34">34</a>  <em>     */</em>
+<a name="35" href="#35">35</a>      <strong>void</strong> execute();
+<a name="36" href="#36">36</a>  }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+

Propchange: logging/site/trunk/docs/log4j/companions/component/xref/org/apache/log4j/scheduler/Job.html
------------------------------------------------------------------------------
    svn:mime-type = text/html



Mime
View raw message