Modified: james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html?rev=800330&r1=800329&r2=800330&view=diff ============================================================================== --- james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html (original) +++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/Mailet.html Mon Aug 3 12:18:51 2009 @@ -30,106 +30,115 @@ <a name="20" href="#20">20</a> <a name="21" href="#21">21</a> <strong class="jxr_keyword">package</strong> org.apache.mailet; <a name="22" href="#22">22</a> -<a name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em> -<a name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * Draft of a Mailet inteface. The <code>service</code> perform all needed work</em> -<a name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * on the Mail object. Whatever remains at the end of the service is considered</em> -<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * to need futher processing and will go to the next Mailet if there is one</em> -<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * configured or will go to the error processor if not.</em> -<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * Setting a Mail state (setState(String)) to Mail.GHOST or cleaning its recipient</em> -<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * list has the same meaning that s no more processing is needed.</em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * Instead of creating new messages, the mailet can put a message with new recipients</em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * at the top of the mail queue, or insert them immediately after it's execution</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * through the API are provided by the MailetContext interface.</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * This interface defines methods to initialize a mailet, to service messages, and to</em> -<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * remove a mailet from the server. These are known as life-cycle methods and are called</em> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * in the following sequence:</em> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * <ol></em> -<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <li>The mailet is constructed, then initialized with the init method. </li></em> -<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <li>Any messages for the service method are handled.</li></em> -<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * <li>The mailet is taken out of service, then destroyed with the destroy method,</em> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * then garbage collected and finalized.</li></em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * </ol></em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * In addition to the life-cycle methods, this interface provides the getMailetConfig</em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * method, which the mailet can use to get any startup information, and the</em> -<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * getMailetInfo method, which allows the mailet to return basic information about itself,</em> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * such as author, version, and copyright.</em> -<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> *</em> -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @version 1.0.0, 24/04/1999</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> -<a name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/Mailet.html">Mailet</a> { -<a name="51" href="#51">51</a> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Called by the mailet container to indicate to a mailet that the</em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * mailet is being taken out of service. This method is only called once</em> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * all threads within the mailet's service method have exited or after a</em> -<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * timeout period has passed. After the mailet container calls this method,</em> -<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * it will not call the service method again on this mailet.</em> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * This method gives the mailet an opportunity to clean up any resources that</em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * are being held (for example, memory, file handles, threads) and make sure</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * that any persistent state is synchronized with the mailet's current state in memory.</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em> -<a name="63" href="#63">63</a> <strong class="jxr_keyword">void</strong> destroy(); -<a name="64" href="#64">64</a> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em> -<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Returns information about the mailet, such as author, version, and</em> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * copyright.</em> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * The string that this method returns should be plain text and not markup</em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * of any kind (such as HTML, XML, etc.).</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return a String containing servlet information</em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em> -<a name="74" href="#74">74</a> String getMailetInfo(); -<a name="75" href="#75">75</a> -<a name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em> -<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * Returns a MailetConfig object, which contains initialization and</em> -<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * startup parameters for this mailet.</em> -<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * Implementations of this interface are responsible for storing the MailetConfig</em> -<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * object so that this method can return it. The GenericMailet class, which implements</em> -<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * this interface, already does this.</em> -<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> *</em> -<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @return the MailetConfig object that initializes this mailet</em> -<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em> -<a name="86" href="#86">86</a> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> getMailetConfig(); -<a name="87" href="#87">87</a> -<a name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em> -<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Called by the mailet container to indicate to a mailet that the</em> -<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * mailet is being placed into service.</em> -<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * The mailet container calls the init method exactly once after</em> -<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * instantiating the mailet. The init method must complete successfully</em> -<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * before the mailet can receive any requests.</em> -<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> *</em> -<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * @param config - a MailetConfig object containing the mailet's configuration</em> -<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * and initialization parameters</em> -<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @throws javax.mail.MessagingException - if an exception has occurred that interferes with</em> -<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * the mailet's normal operation</em> -<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em> -<a name="101" href="#101">101</a> <strong class="jxr_keyword">void</strong> init(<a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> config) <strong class="jxr_keyword">throws</strong> javax.mail.MessagingException; -<a name="102" href="#102">102</a> -<a name="103" href="#103">103</a> <em class="jxr_javadoccomment">/**</em> -<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Called by the mailet container to allow the mailet to process to</em> -<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * a message.</em> -<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * This method is only called after the mailet's init() method has completed</em> -<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * successfully.</em> -<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Mailets typically run inside multithreaded mailet containers that can handle</em> -<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * multiple requests concurrently. Developers must be aware to synchronize access</em> -<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * to any shared resources such as files, network connections, as well as the</em> -<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * mailet's class and instance variables. More information on multithreaded</em> -<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * programming in Java is available in <a href="<a href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html"; target="alexandria_uri">http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html</a>">the</em> -<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Java tutorial on multi-threaded programming</a>.</em> -<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> *</em> -<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @param mail - the Mail object that contains the message and routing information</em> -<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * @throws javax.mail.MessagingException - if a message or address parsing exception occurs or</em> -<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * an exception that interferes with the mailet's normal operation</em> +<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException; +<a name="24" href="#24">24</a> +<a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * A Mailet processes mail messages.</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * The Mailet life cycle is controlled by the mailet container,</em> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * which invokes the Mailet methods in the following order:</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <ol></em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <li>The mailet is constructed.</em> +<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * <li>The {...@link #init} method is invoked once to initialize the mailet.</em> +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * <li>The {...@link #service} method is invoked to process mail messages.</em> +<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * This can occur an unlimited number of times, even concurrently.</em> +<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <li>At some point, such as when the mailet container is shut down,</em> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * the mailet is taken out of service and then destroyed by invoking</em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * the {...@link #destroy} method once.</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * </ol></em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * In addition to the life-cycle methods, this interface provides the</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * {...@link #getMailetConfig} method, which provides the Mailet with</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * its initialization parameters and a {...@link MailetContext} through which</em> +<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * it can interact with the mailet container, and the {...@link #getMailetInfo}</em> +<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * method, which provides basic information about the Mailet.</em> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Mailets are grouped by the mailet container's configuration into processors.</em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Each processor is comprised of an ordered sequence of Mailets, each with a</em> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * corresponding {...@link Matcher}. A Mail message is processed by each</em> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * Matcher-Mailet pair in order: If the mail is matched by the Matcher, it is</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * passed to the Mailet's {...@code service} method for processing, and if it is</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * not matched, the Mailet is skipped and the mail moves on to the next</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Matcher-Mailet pair.</em> +<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * The {...@code service} method performs all needed processing on the Mail,</em> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * and may modify the message content, recipients, attributes, state, etc.</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * When the method returns, the mail is passed on to the next Matcher-Mailer</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * pair in the processor. If there are no subsequent mailets in the processor,</em> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * it is moved to the error processor.</em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Setting the Mail {...@link Mail#setState state} to {...@link Mail#GHOST}, or clearing its</em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * recipient list, both mean that no further processing is needed, which will</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * cause the Mail to be dropped without ever reaching subsequent Mailets.</em> +<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * Instead of creating new messages, the mailet can put a message with new recipients</em> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * at the top of the mail queue, or insert them immediately after it's execution</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * through the API are provided by the MailetContext interface.</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em> +<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/Mailet.html">Mailet</a> { +<a name="68" href="#68">68</a> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment">/**</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * Initializes this Mailet.</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * This method is called only once, and must complete successfully</em> +<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * before the {...@link #service} method can be invoked.</em> +<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> *</em> +<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param config a MailetConfig containing the mailet's configuration</em> +<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * and initialization parameters</em> +<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * @throws MessagingException if an error occurs</em> +<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> */</em> +<a name="79" href="#79">79</a> <strong class="jxr_keyword">void</strong> init(<a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> config) <strong class="jxr_keyword">throws</strong> MessagingException; +<a name="80" href="#80">80</a> +<a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em> +<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Services a mail message.</em> +<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * Mailets typically run inside multithreaded mailet containers that can handle</em> +<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * multiple requests concurrently. Developers must be aware to synchronize access</em> +<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * to any shared resources such as files and network connections, as well as the</em> +<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * mailet's fields. More information on multithreaded programming in Java is</em> +<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * available at <a href="<a href="http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html"; target="alexandria_uri">http://java.sun.com/Series/Tutorial/java/threads/multithreaded.html</a>">the</em> +<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * Java tutorial on multi-threaded programming</a>.</em> +<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> *</em> +<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * @param mail the Mail to process</em> +<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @throws MessagingException if any error occurs which prevents the Mail</em> +<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * processing from completing successfully</em> +<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> */</em> +<a name="95" href="#95">95</a> <strong class="jxr_keyword">void</strong> service(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail) <strong class="jxr_keyword">throws</strong> MessagingException; +<a name="96" href="#96">96</a> +<a name="97" href="#97">97</a> <em class="jxr_javadoccomment">/**</em> +<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * Destroys this Mailet.</em> +<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * This method is called only once, after all {...@link #service} invocations</em> +<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * have completed (or a timeout period has elapsed). After this method</em> +<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * returns, this Mailet will no longer be used.</em> +<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * Implementations should use this method to release any resources that</em> +<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * are being held (such as memory, file handles or threads) and make sure</em> +<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * that any persistent information is properly stored.</em> +<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> */</em> +<a name="108" href="#108">108</a> <strong class="jxr_keyword">void</strong> destroy(); +<a name="109" href="#109">109</a> +<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em> +<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Returns a MailetConfig object, which provides initialization parameters</em> +<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * and a {...@link MailetContext} through which it can interact with the</em> +<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * mailet container.</em> +<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * <p></em> +<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Implementations of this interface are responsible for storing the</em> +<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * MailetConfig which they receive in the {...@link #init} method so</em> +<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * that this method can return it.</em> +<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> *</em> +<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * @return the MailetConfig that this mailet was initialized with</em> <a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em> -<a name="121" href="#121">121</a> <strong class="jxr_keyword">void</strong> service(<a href="../../../org/apache/mailet/Mail.html">Mail</a> mail) <strong class="jxr_keyword">throws</strong> javax.mail.MessagingException; -<a name="122" href="#122">122</a> } +<a name="121" href="#121">121</a> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> getMailetConfig(); +<a name="122" href="#122">122</a> +<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">/**</em> +<a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * Returns information about the mailet, such as author, version and</em> +<a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * copyright.</em> +<a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> *</em> +<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @return the Mailet information (as a plain text string)</em> +<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em> +<a name="129" href="#129">129</a> String getMailetInfo(); +<a name="130" href="#130">130</a> +<a name="131" href="#131">131</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html>
Modified: james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html?rev=800330&r1=800329&r2=800330&view=diff ============================================================================== --- james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html (original) +++ james/site/trunk/www/mailet/api/xref/org/apache/mailet/MailetConfig.html Mon Aug 3 12:18:51 2009 @@ -33,55 +33,54 @@ <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; <a name="24" href="#24">24</a> <a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em> -<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * A mailet configuration object used by a mailet container to pass information</em> -<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * to a mailet during initialization.</em> +<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * A mailet configuration object used by the mailet container to pass</em> +<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * information to a mailet during initialization.</em> <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * <p></em> -<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * The configuration information contains initialization parameters, which are a set</em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * of name/value pairs, and a MailetContext object, which gives the mailet information</em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * about the server.</em> +<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * The configuration information consists of mailet-specific initialization</em> +<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * parameters in a set of name/value pairs, and a MailetContext object</em> +<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * which allows the mailet to interact with the mailet container.</em> <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @version 1.0.0, 24/04/1999</em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em> -<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> { -<a name="36" href="#36">36</a> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em> -<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * Returns a String containing the value of the named initialization</em> -<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * parameter, or null if the parameter does not exist.</em> -<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param name - a String specifying the name of the initialization parameter</em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @return a String containing the value of the initialization parameter</em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em> -<a name="44" href="#44">44</a> String getInitParameter(String name); -<a name="45" href="#45">45</a> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em> -<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Returns the names of the mailet's initialization parameters as an</em> -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Iterator of String objects, or an empty Iterator if the mailet has</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * no initialization parameters.</em> -<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> *</em> -<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * @return an Iterator of String objects containing the names of the mailet's</em> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * initialization parameters</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> */</em> -<a name="54" href="#54">54</a> Iterator getInitParameterNames(); -<a name="55" href="#55">55</a> -<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em> -<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * Returns a reference to the MailetContext in which the mailet is</em> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * executing.</em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @return a MailetContext object, used by the mailet to interact with its</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * mailet container</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em> -<a name="63" href="#63">63</a> <a href="../../../org/apache/mailet/MailetContext.html">MailetContext</a> getMailetContext(); -<a name="64" href="#64">64</a> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em> -<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Returns the name of this mailet instance. The name may be provided via</em> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * server administration, assigned in the application deployment descriptor,</em> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * or for an unregistered (and thus unnamed) mailet instance it will be the</em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * mailet's class name.</em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @return the name of the mailet instance</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em> -<a name="73" href="#73">73</a> String getMailetName(); -<a name="74" href="#74">74</a> } +<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> */</em> +<a name="34" href="#34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../org/apache/mailet/MailetConfig.html">MailetConfig</a> { +<a name="35" href="#35">35</a> +<a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> +<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Returns the value of the named initialization parameter,</em> +<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * or null if the parameter does not exist.</em> +<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em> +<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @param name the name of the initialization parameter</em> +<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @return the value of the initialization parameter, or null</em> +<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em> +<a name="43" href="#43">43</a> String getInitParameter(String name); +<a name="44" href="#44">44</a> +<a name="45" href="#45">45</a> <em class="jxr_javadoccomment">/**</em> +<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * Returns the names of the mailet's initialization parameters as an</em> +<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Iterator of String objects, or an empty Iterator if the mailet has</em> +<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * no initialization parameters.</em> +<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> *</em> +<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @return an Iterator of String objects containing the names of the</em> +<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * mailet's initialization parameters</em> +<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> */</em> +<a name="53" href="#53">53</a> Iterator getInitParameterNames(); +<a name="54" href="#54">54</a> +<a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em> +<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Returns a reference to the MailetContext in which the mailet is</em> +<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * executing.</em> +<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> *</em> +<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @return a MailetContext object which can be used by the mailet</em> +<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * to interact with the mailet container</em> +<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> */</em> +<a name="62" href="#62">62</a> <a href="../../../org/apache/mailet/MailetContext.html">MailetContext</a> getMailetContext(); +<a name="63" href="#63">63</a> +<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em> +<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Returns the name of this mailet instance. The name may be provided via</em> +<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * server administration, assigned in the application deployment descriptor,</em> +<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * or, for an unregistered (and thus unnamed) mailet instance, it will be</em> +<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * the mailet's class name.</em> +<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em> +<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @return the name of the mailet instance</em> +<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em> +<a name="72" href="#72">72</a> String getMailetName(); +<a name="73" href="#73">73</a> } </pre> <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> </html>
