You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2008/08/31 21:32:08 UTC
svn commit: r690769 [13/15] - in /james/site/trunk/www/mailet/crypto: ./
apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/james/
apidocs/org/apache/james/security/
apidocs/org/apache/james/security/class-use/
apidocs/org/apache/james/transp...
Added: james/site/trunk/www/mailet/crypto/xref/org/apache/james/security/package-summary.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/crypto/xref/org/apache/james/security/package-summary.html?rev=690769&view=auto
==============================================================================
--- james/site/trunk/www/mailet/crypto/xref/org/apache/james/security/package-summary.html (added)
+++ james/site/trunk/www/mailet/crypto/xref/org/apache/james/security/package-summary.html Sun Aug 31 12:32:05 2008
@@ -0,0 +1,92 @@
+
+<!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 JAMES Crypto Mailets 1.0-SNAPSHOT Reference Package org.apache.james.security</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.james.security</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="InitJCE.html" target="classFrame">InitJCE</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="KeyHolder.html" target="classFrame">KeyHolder</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="KeyStoreHolder.html" target="classFrame">KeyStoreHolder</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SMIMEAttributeNames.html" target="classFrame">SMIMEAttributeNames</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SMIMEKeyHolder.html" target="classFrame">SMIMEKeyHolder</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="SMIMESignerInfo.html" target="classFrame">SMIMESignerInfo</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 © 2008 The Apache Software Foundation. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file
Added: james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/AbstractSign.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/AbstractSign.html?rev=690769&view=auto
==============================================================================
--- james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/AbstractSign.html (added)
+++ james/site/trunk/www/mailet/crypto/xref/org/apache/james/transport/mailets/smime/AbstractSign.html Sun Aug 31 12:32:05 2008
@@ -0,0 +1,729 @@
+<!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>AbstractSign xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/james/transport/mailets/smime/AbstractSign.html">View Javadoc</a></div><pre>
+
+<a name="1" href="#1">1</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">**************************************************************</em>
+<a name="2" href="#2">2</a> <em class="jxr_javadoccomment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
+<a name="3" href="#3">3</a> <em class="jxr_javadoccomment"> * or more contributor license agreements. See the NOTICE file *</em>
+<a name="4" href="#4">4</a> <em class="jxr_javadoccomment"> * distributed with this work for additional information *</em>
+<a name="5" href="#5">5</a> <em class="jxr_javadoccomment"> * regarding copyright ownership. The ASF licenses this file *</em>
+<a name="6" href="#6">6</a> <em class="jxr_javadoccomment"> * to you under the Apache License, Version 2.0 (the *</em>
+<a name="7" href="#7">7</a> <em class="jxr_javadoccomment"> * "License"); you may not use this file except in compliance *</em>
+<a name="8" href="#8">8</a> <em class="jxr_javadoccomment"> * with the License. You may obtain a copy of the License at *</em>
+<a name="9" href="#9">9</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="10" href="#10">10</a> <em class="jxr_javadoccomment"> * <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="11" href="#11">11</a> <em class="jxr_javadoccomment"> * *</em>
+<a name="12" href="#12">12</a> <em class="jxr_javadoccomment"> * Unless required by applicable law or agreed to in writing, *</em>
+<a name="13" href="#13">13</a> <em class="jxr_javadoccomment"> * software distributed under the License is distributed on an *</em>
+<a name="14" href="#14">14</a> <em class="jxr_javadoccomment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
+<a name="15" href="#15">15</a> <em class="jxr_javadoccomment"> * KIND, either express or implied. See the License for the *</em>
+<a name="16" href="#16">16</a> <em class="jxr_javadoccomment"> * specific language governing permissions and limitations *</em>
+<a name="17" href="#17">17</a> <em class="jxr_javadoccomment"> * under the License. *</em>
+<a name="18" href="#18">18</a> <em class="jxr_javadoccomment"> ****************************************************************/</em>
+<a name="19" href="#19">19</a>
+<a name="20" href="#20">20</a>
+<a name="21" href="#21">21</a>
+<a name="22" href="#22">22</a> <strong class="jxr_keyword">package</strong> org.apache.james.transport.mailets.smime;
+<a name="23" href="#23">23</a>
+<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.james.security.KeyHolder;
+<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.james.security.SMIMEAttributeNames;
+<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.GenericMailet;
+<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.Mail;
+<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.MailAddress;
+<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.mailet.RFC2822Headers;
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> javax.mail.MessagingException;
+<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> javax.mail.Session;
+<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.InternetAddress;
+<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeBodyPart;
+<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMessage;
+<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.MimeMultipart;
+<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> javax.mail.internet.ParseException;
+<a name="38" href="#38">38</a>
+<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
+<a name="41" href="#41">41</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Constructor;
+<a name="42" href="#42">42</a>
+<a name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
+<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * <P>Abstract mailet providing common SMIME signature services.<BR></em>
+<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * It can be subclassed to make authoring signing mailets simple.<BR></em>
+<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * By extending it and overriding one or more of the following methods a new behaviour can</em>
+<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * be quickly created without the author having to address any issue other than</em>
+<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * the relevant one:</P></em>
+<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * <li>{@link #initDebug}, {@link #setDebug} and {@link #isDebug} manage the debugging mode.</li></em>
+<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * <li>{@link #initExplanationText}, {@link #setExplanationText} and {@link #getExplanationText} manage the text of</em>
+<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * an attachment that will be added to explain the meaning of this server-side signature.</li></em>
+<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * <li>{@link #initKeyHolder}, {@link #setKeyHolder} and {@link #getKeyHolder} manage the {@link KeyHolder} object that will</em>
+<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * contain the keys and certificates and will do the crypto work.</li></em>
+<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * <li>{@link #initPostmasterSigns}, {@link #setPostmasterSigns} and {@link #isPostmasterSigns}</em>
+<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * determines whether messages originated by the Postmaster will be signed or not.</li></em>
+<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * <li>{@link #initRebuildFrom}, {@link #setRebuildFrom} and {@link #isRebuildFrom}</em>
+<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * determines whether the "From:" header will be rebuilt to neutralize the wrong behaviour of</em>
+<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * some MUAs like Microsoft Outlook Express.</li></em>
+<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * <li>{@link #initSignerName}, {@link #setSignerName} and {@link #getSignerName} manage the name</em>
+<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * of the signer to be shown in the explanation text.</li></em>
+<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * <li>{@link #isOkToSign} controls whether the mail can be signed or not.</li></em>
+<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * <li>The abstract method {@link #getWrapperBodyPart} returns the massaged {@link javax.mail.internet.MimeBodyPart}</em>
+<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * that will be signed, or null if the message has to be signed "as is".</li></em>
+<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> *</em>
+<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * <P>Handles the following init parameters:</P></em>
+<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * <ul></em>
+<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * <li>&lt;keyHolderClass&gt;: Sets the class of the KeyHolder object that will handle the cryptography functions,</em>
+<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * for example org.apache.james.security.SMIMEKeyHolder for SMIME.</li></em>
+<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * <li>&lt;debug&gt;: if <CODE>true</CODE> some useful information is logged.</em>
+<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * The default is <CODE>false</CODE>.</li></em>
+<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * <li>&lt;keyStoreFileName&gt;: the {@link java.security.KeyStore} full file name.</li></em>
+<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * <li>&lt;keyStorePassword&gt;: the <CODE>KeyStore</CODE> password.</em>
+<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * If given, it is used to check the integrity of the keystore data,</em>
+<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> * otherwise, if null, the integrity of the keystore is not checked.</li></em>
+<a name="77" href="#77">77</a> <em class="jxr_javadoccomment"> * <li>&lt;keyAlias&gt;: the alias name to use to search the Key using {@link java.security.KeyStore#getKey}.</em>
+<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * The default is to look for the first and only alias in the keystore;</em>
+<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * if zero or more than one is found a {@link java.security.KeyStoreException} is thrown.</li></em>
+<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <li>&lt;keyAliasPassword&gt;: the alias password. The default is to use the <CODE>KeyStore</CODE> password.</em>
+<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * At least one of the passwords must be provided.</li></em>
+<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * <li>&lt;keyStoreType&gt;: the type of the keystore. The default will use {@link java.security.KeyStore#getDefaultType}.</li></em>
+<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * <li>&lt;postmasterSigns&gt;: if <CODE>true</CODE> the message will be signed even if the sender is the Postmaster.</em>
+<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * The default is <CODE>false</CODE>.</li></li></em>
+<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * <li>&lt;rebuildFrom&gt;: If <CODE>true</CODE> will modify the "From:" header.</em>
+<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * For more info see {@link #isRebuildFrom}.</em>
+<a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * The default is <CODE>false</CODE>.</li></em>
+<a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * <li>&lt;signerName&gt;: the name of the signer to be shown in the explanation text.</em>
+<a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * The default is to use the "CN=" property of the signing certificate.</li></em>
+<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * <li>&lt;explanationText&gt;: the text of an explanation of the meaning of this server-side signature.</em>
+<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * May contain the following substitution patterns (see also {@link #getReplacedExplanationText}):</em>
+<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * <CODE>[signerName]</CODE>, <CODE>[signerAddress]</CODE>, <CODE>[reversePath]</CODE>, <CODE>[headers]</CODE>.</em>
+<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * It should be included in the signature.</em>
+<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * The actual presentation of the text depends on the specific concrete mailet subclass:</em>
+<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * see for example {@link SMIMESign}.</em>
+<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * The default is to not have any explanation text.</li></em>
+<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * </ul></em>
+<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @version CVS $Revision: 647925 $ $Date: 2008-04-14 19:38:17 +0100 (Mon, 14 Apr 2008) $</em>
+<a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @since 2.2.1</em>
+<a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
+<a name="101" href="#101">101</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/james/transport/mailets/smime/AbstractSign.html">AbstractSign</a> <strong class="jxr_keyword">extends</strong> GenericMailet {
+<a name="102" href="#102">102</a>
+<a name="103" href="#103">103</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String HEADERS_PATTERN = <span class="jxr_string">"[headers]"</span>;
+<a name="104" href="#104">104</a>
+<a name="105" href="#105">105</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SIGNER_NAME_PATTERN = <span class="jxr_string">"[signerName]"</span>;
+<a name="106" href="#106">106</a>
+<a name="107" href="#107">107</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SIGNER_ADDRESS_PATTERN = <span class="jxr_string">"[signerAddress]"</span>;
+<a name="108" href="#108">108</a>
+<a name="109" href="#109">109</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String REVERSE_PATH_PATTERN = <span class="jxr_string">"[reversePath]"</span>;
+<a name="110" href="#110">110</a>
+<a name="111" href="#111">111</a> <em class="jxr_javadoccomment">/**</em>
+<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * Holds value of property debug.</em>
+<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em>
+<a name="114" href="#114">114</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> debug;
+<a name="115" href="#115">115</a>
+<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em>
+<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Holds value of property keyHolderClass.</em>
+<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> */</em>
+<a name="119" href="#119">119</a> <strong class="jxr_keyword">private</strong> Class keyHolderClass;
+<a name="120" href="#120">120</a>
+<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">/**</em>
+<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * Holds value of property explanationText.</em>
+<a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> */</em>
+<a name="124" href="#124">124</a> <strong class="jxr_keyword">private</strong> String explanationText;
+<a name="125" href="#125">125</a>
+<a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em>
+<a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Holds value of property keyHolder.</em>
+<a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> */</em>
+<a name="129" href="#129">129</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../../org/apache/james/security/KeyHolder.html">KeyHolder</a> keyHolder;
+<a name="130" href="#130">130</a>
+<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">/**</em>
+<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * Holds value of property postmasterSigns.</em>
+<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em>
+<a name="134" href="#134">134</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> postmasterSigns;
+<a name="135" href="#135">135</a>
+<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em>
+<a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Holds value of property rebuildFrom.</em>
+<a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> */</em>
+<a name="139" href="#139">139</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> rebuildFrom;
+<a name="140" href="#140">140</a>
+<a name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
+<a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Holds value of property signerName.</em>
+<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> */</em>
+<a name="144" href="#144">144</a> <strong class="jxr_keyword">private</strong> String signerName;
+<a name="145" href="#145">145</a>
+<a name="146" href="#146">146</a> <em class="jxr_javadoccomment">/**</em>
+<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * Gets the expected init parameters.</em>
+<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * @return An array containing the parameter names allowed for this mailet.</em>
+<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> */</em>
+<a name="150" href="#150">150</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> String[] getAllowedInitParameters();
+<a name="151" href="#151">151</a>
+<a name="152" href="#152">152</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em></em>
+<a name="153" href="#153">153</a> <em class="jxr_comment">/*<em class="jxr_comment"> ****************** Begin of setters and getters ******************** */</em></em>
+<a name="154" href="#154">154</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em></em>
+<a name="155" href="#155">155</a>
+<a name="156" href="#156">156</a> <em class="jxr_javadoccomment">/**</em>
+<a name="157" href="#157">157</a> <em class="jxr_javadoccomment"> * Initializer for property debug.</em>
+<a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> */</em>
+<a name="159" href="#159">159</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initDebug() {
+<a name="160" href="#160">160</a> setDebug((getInitParameter(<span class="jxr_string">"debug"</span>) == <strong class="jxr_keyword">null</strong>) ? false : <strong class="jxr_keyword">new</strong> Boolean(getInitParameter(<span class="jxr_string">"debug"</span>)).booleanValue());
+<a name="161" href="#161">161</a> }
+<a name="162" href="#162">162</a>
+<a name="163" href="#163">163</a> <em class="jxr_javadoccomment">/**</em>
+<a name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * Getter for property debug.</em>
+<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @return Value of property debug.</em>
+<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em>
+<a name="167" href="#167">167</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isDebug() {
+<a name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.debug;
+<a name="169" href="#169">169</a> }
+<a name="170" href="#170">170</a>
+<a name="171" href="#171">171</a> <em class="jxr_javadoccomment">/**</em>
+<a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * Setter for property debug.</em>
+<a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> * @param debug New value of property debug.</em>
+<a name="174" href="#174">174</a> <em class="jxr_javadoccomment"> */</em>
+<a name="175" href="#175">175</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setDebug(<strong class="jxr_keyword">boolean</strong> debug) {
+<a name="176" href="#176">176</a> <strong class="jxr_keyword">this</strong>.debug = debug;
+<a name="177" href="#177">177</a> }
+<a name="178" href="#178">178</a>
+<a name="179" href="#179">179</a> <em class="jxr_javadoccomment">/**</em>
+<a name="180" href="#180">180</a> <em class="jxr_javadoccomment"> * Initializer for property keyHolderClass.</em>
+<a name="181" href="#181">181</a> <em class="jxr_javadoccomment"> */</em>
+<a name="182" href="#182">182</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initKeyHolderClass() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="183" href="#183">183</a> String keyHolderClassName = getInitParameter(<span class="jxr_string">"keyHolderClass"</span>);
+<a name="184" href="#184">184</a> <strong class="jxr_keyword">if</strong> (keyHolderClassName == <strong class="jxr_keyword">null</strong>) {
+<a name="185" href="#185">185</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"<keyHolderClass> parameter missing."</span>);
+<a name="186" href="#186">186</a> }
+<a name="187" href="#187">187</a> <strong class="jxr_keyword">try</strong> {
+<a name="188" href="#188">188</a> setKeyHolderClass(Class.forName(keyHolderClassName));
+<a name="189" href="#189">189</a> } <strong class="jxr_keyword">catch</strong> (ClassNotFoundException cnfe) {
+<a name="190" href="#190">190</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"The specified <keyHolderClass> does not exist: "</span> + keyHolderClassName);
+<a name="191" href="#191">191</a> }
+<a name="192" href="#192">192</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="193" href="#193">193</a> log(<span class="jxr_string">"keyHolderClass: "</span> + getKeyHolderClass());
+<a name="194" href="#194">194</a> }
+<a name="195" href="#195">195</a> }
+<a name="196" href="#196">196</a>
+<a name="197" href="#197">197</a> <em class="jxr_javadoccomment">/**</em>
+<a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * Getter for property keyHolderClass.</em>
+<a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * @return Value of property keyHolderClass.</em>
+<a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> */</em>
+<a name="201" href="#201">201</a> <strong class="jxr_keyword">public</strong> Class getKeyHolderClass() {
+<a name="202" href="#202">202</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.keyHolderClass;
+<a name="203" href="#203">203</a> }
+<a name="204" href="#204">204</a>
+<a name="205" href="#205">205</a> <em class="jxr_javadoccomment">/**</em>
+<a name="206" href="#206">206</a> <em class="jxr_javadoccomment"> * Setter for property keyHolderClass.</em>
+<a name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * @param keyHolderClass New value of property keyHolderClass.</em>
+<a name="208" href="#208">208</a> <em class="jxr_javadoccomment"> */</em>
+<a name="209" href="#209">209</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setKeyHolderClass(Class keyHolderClass) {
+<a name="210" href="#210">210</a> <strong class="jxr_keyword">this</strong>.keyHolderClass = keyHolderClass;
+<a name="211" href="#211">211</a> }
+<a name="212" href="#212">212</a>
+<a name="213" href="#213">213</a> <em class="jxr_javadoccomment">/**</em>
+<a name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * Initializer for property explanationText.</em>
+<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> */</em>
+<a name="216" href="#216">216</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initExplanationText() {
+<a name="217" href="#217">217</a> setExplanationText(getInitParameter(<span class="jxr_string">"explanationText"</span>));
+<a name="218" href="#218">218</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="219" href="#219">219</a> log(<span class="jxr_string">"Explanation text:\r\n"</span> + getExplanationText());
+<a name="220" href="#220">220</a> }
+<a name="221" href="#221">221</a> }
+<a name="222" href="#222">222</a>
+<a name="223" href="#223">223</a> <em class="jxr_javadoccomment">/**</em>
+<a name="224" href="#224">224</a> <em class="jxr_javadoccomment"> * Getter for property explanationText.</em>
+<a name="225" href="#225">225</a> <em class="jxr_javadoccomment"> * Text to be used in the SignatureExplanation.txt file.</em>
+<a name="226" href="#226">226</a> <em class="jxr_javadoccomment"> * @return Value of property explanationText.</em>
+<a name="227" href="#227">227</a> <em class="jxr_javadoccomment"> */</em>
+<a name="228" href="#228">228</a> <strong class="jxr_keyword">public</strong> String getExplanationText() {
+<a name="229" href="#229">229</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.explanationText;
+<a name="230" href="#230">230</a> }
+<a name="231" href="#231">231</a>
+<a name="232" href="#232">232</a> <em class="jxr_javadoccomment">/**</em>
+<a name="233" href="#233">233</a> <em class="jxr_javadoccomment"> * Setter for property explanationText.</em>
+<a name="234" href="#234">234</a> <em class="jxr_javadoccomment"> * @param explanationText New value of property explanationText.</em>
+<a name="235" href="#235">235</a> <em class="jxr_javadoccomment"> */</em>
+<a name="236" href="#236">236</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setExplanationText(String explanationText) {
+<a name="237" href="#237">237</a> <strong class="jxr_keyword">this</strong>.explanationText = explanationText;
+<a name="238" href="#238">238</a> }
+<a name="239" href="#239">239</a>
+<a name="240" href="#240">240</a> <em class="jxr_javadoccomment">/**</em>
+<a name="241" href="#241">241</a> <em class="jxr_javadoccomment"> * Initializer for property keyHolder.</em>
+<a name="242" href="#242">242</a> <em class="jxr_javadoccomment"> */</em>
+<a name="243" href="#243">243</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initKeyHolder() <strong class="jxr_keyword">throws</strong> Exception {
+<a name="244" href="#244">244</a> Constructor keyHolderConstructor = <strong class="jxr_keyword">null</strong>;
+<a name="245" href="#245">245</a> <strong class="jxr_keyword">try</strong> {
+<a name="246" href="#246">246</a> keyHolderConstructor = keyHolderClass.getConstructor(<strong class="jxr_keyword">new</strong> Class[] {String.<strong class="jxr_keyword">class</strong>, String.<strong class="jxr_keyword">class</strong>, String.<strong class="jxr_keyword">class</strong>, String.<strong class="jxr_keyword">class</strong>, String.<strong class="jxr_keyword">class</strong>});
+<a name="247" href="#247">247</a> } <strong class="jxr_keyword">catch</strong> (NoSuchMethodException nsme) {
+<a name="248" href="#248">248</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"The needed constructor does not exist: "</span>
+<a name="249" href="#249">249</a> + keyHolderClass + <span class="jxr_string">"(String, String, String, String, String)"</span>);
+<a name="250" href="#250">250</a> }
+<a name="251" href="#251">251</a>
+<a name="252" href="#252">252</a>
+<a name="253" href="#253">253</a> String keyStoreFileName = getInitParameter(<span class="jxr_string">"keyStoreFileName"</span>);
+<a name="254" href="#254">254</a> <strong class="jxr_keyword">if</strong> (keyStoreFileName == <strong class="jxr_keyword">null</strong>) {
+<a name="255" href="#255">255</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"<keyStoreFileName> parameter missing."</span>);
+<a name="256" href="#256">256</a> }
+<a name="257" href="#257">257</a>
+<a name="258" href="#258">258</a> String keyStorePassword = getInitParameter(<span class="jxr_string">"keyStorePassword"</span>);
+<a name="259" href="#259">259</a> <strong class="jxr_keyword">if</strong> (keyStorePassword == <strong class="jxr_keyword">null</strong>) {
+<a name="260" href="#260">260</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"<keyStorePassword> parameter missing."</span>);
+<a name="261" href="#261">261</a> }
+<a name="262" href="#262">262</a> String keyAliasPassword = getInitParameter(<span class="jxr_string">"keyAliasPassword"</span>);
+<a name="263" href="#263">263</a> <strong class="jxr_keyword">if</strong> (keyAliasPassword == <strong class="jxr_keyword">null</strong>) {
+<a name="264" href="#264">264</a> keyAliasPassword = keyStorePassword;
+<a name="265" href="#265">265</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="266" href="#266">266</a> log(<span class="jxr_string">"<keyAliasPassword> parameter not specified: will default to the <keyStorePassword> parameter."</span>);
+<a name="267" href="#267">267</a> }
+<a name="268" href="#268">268</a> }
+<a name="269" href="#269">269</a>
+<a name="270" href="#270">270</a> String keyStoreType = getInitParameter(<span class="jxr_string">"keyStoreType"</span>);
+<a name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> (keyStoreType == <strong class="jxr_keyword">null</strong>) {
+<a name="272" href="#272">272</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="273" href="#273">273</a> log(<span class="jxr_string">"<keyStoreType> parameter not specified: the default will be as appropriate to the keyStore requested."</span>);
+<a name="274" href="#274">274</a> }
+<a name="275" href="#275">275</a> }
+<a name="276" href="#276">276</a>
+<a name="277" href="#277">277</a> String keyAlias = getInitParameter(<span class="jxr_string">"keyAlias"</span>);
+<a name="278" href="#278">278</a> <strong class="jxr_keyword">if</strong> (keyAlias == <strong class="jxr_keyword">null</strong>) {
+<a name="279" href="#279">279</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="280" href="#280">280</a> log(<span class="jxr_string">"<keyAlias> parameter not specified: will look for the first one in the keystore."</span>);
+<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> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="285" href="#285">285</a> StringBuffer logBuffer =
+<a name="286" href="#286">286</a> <strong class="jxr_keyword">new</strong> StringBuffer(1024)
+<a name="287" href="#287">287</a> .append(<span class="jxr_string">"KeyStore related parameters:"</span>)
+<a name="288" href="#288">288</a> .append(<span class="jxr_string">" keyStoreFileName="</span>).append(keyStoreFileName)
+<a name="289" href="#289">289</a> .append(<span class="jxr_string">", keyStoreType="</span>).append(keyStoreType)
+<a name="290" href="#290">290</a> .append(<span class="jxr_string">", keyAlias="</span>).append(keyAlias)
+<a name="291" href="#291">291</a> .append(<span class="jxr_string">" "</span>);
+<a name="292" href="#292">292</a> log(logBuffer.toString());
+<a name="293" href="#293">293</a> }
+<a name="294" href="#294">294</a>
+<a name="295" href="#295">295</a> <em class="jxr_comment">// Certificate preparation</em>
+<a name="296" href="#296">296</a> String[] parameters = {keyStoreFileName, keyStorePassword, keyAlias, keyAliasPassword, keyStoreType};
+<a name="297" href="#297">297</a> setKeyHolder((KeyHolder)keyHolderConstructor.newInstance(parameters));
+<a name="298" href="#298">298</a>
+<a name="299" href="#299">299</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="300" href="#300">300</a> log(<span class="jxr_string">"Subject Distinguished Name: "</span> + getKeyHolder().getSignerDistinguishedName());
+<a name="301" href="#301">301</a> }
+<a name="302" href="#302">302</a>
+<a name="303" href="#303">303</a> <strong class="jxr_keyword">if</strong> (getKeyHolder().getSignerAddress() == <strong class="jxr_keyword">null</strong>) {
+<a name="304" href="#304">304</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Signer address missing in the certificate."</span>);
+<a name="305" href="#305">305</a> }
+<a name="306" href="#306">306</a> }
+<a name="307" href="#307">307</a>
+<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">/**</em>
+<a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * Getter for property keyHolder.</em>
+<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> * It is <CODE>protected</CODE> instead of <CODE>public</CODE> for security reasons.</em>
+<a name="311" href="#311">311</a> <em class="jxr_javadoccomment"> * @return Value of property keyHolder.</em>
+<a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> */</em>
+<a name="313" href="#313">313</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/james/security/KeyHolder.html">KeyHolder</a> getKeyHolder() {
+<a name="314" href="#314">314</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.keyHolder;
+<a name="315" href="#315">315</a> }
+<a name="316" href="#316">316</a>
+<a name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em>
+<a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * Setter for property keyHolder.</em>
+<a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * It is <CODE>protected</CODE> instead of <CODE>public</CODE> for security reasons.</em>
+<a name="320" href="#320">320</a> <em class="jxr_javadoccomment"> * @param keyHolder New value of property keyHolder.</em>
+<a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> */</em>
+<a name="322" href="#322">322</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setKeyHolder(<a href="../../../../../../org/apache/james/security/KeyHolder.html">KeyHolder</a> keyHolder) {
+<a name="323" href="#323">323</a> <strong class="jxr_keyword">this</strong>.keyHolder = keyHolder;
+<a name="324" href="#324">324</a> }
+<a name="325" href="#325">325</a>
+<a name="326" href="#326">326</a> <em class="jxr_javadoccomment">/**</em>
+<a name="327" href="#327">327</a> <em class="jxr_javadoccomment"> * Initializer for property postmasterSigns.</em>
+<a name="328" href="#328">328</a> <em class="jxr_javadoccomment"> */</em>
+<a name="329" href="#329">329</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initPostmasterSigns() {
+<a name="330" href="#330">330</a> setPostmasterSigns((getInitParameter(<span class="jxr_string">"postmasterSigns"</span>) == <strong class="jxr_keyword">null</strong>) ? false : <strong class="jxr_keyword">new</strong> Boolean(getInitParameter(<span class="jxr_string">"postmasterSigns"</span>)).booleanValue());
+<a name="331" href="#331">331</a> }
+<a name="332" href="#332">332</a>
+<a name="333" href="#333">333</a> <em class="jxr_javadoccomment">/**</em>
+<a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> * Getter for property postmasterSigns.</em>
+<a name="335" href="#335">335</a> <em class="jxr_javadoccomment"> * If true will sign messages signed by the postmaster.</em>
+<a name="336" href="#336">336</a> <em class="jxr_javadoccomment"> * @return Value of property postmasterSigns.</em>
+<a name="337" href="#337">337</a> <em class="jxr_javadoccomment"> */</em>
+<a name="338" href="#338">338</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isPostmasterSigns() {
+<a name="339" href="#339">339</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.postmasterSigns;
+<a name="340" href="#340">340</a> }
+<a name="341" href="#341">341</a>
+<a name="342" href="#342">342</a> <em class="jxr_javadoccomment">/**</em>
+<a name="343" href="#343">343</a> <em class="jxr_javadoccomment"> * Setter for property postmasterSigns.</em>
+<a name="344" href="#344">344</a> <em class="jxr_javadoccomment"> * @param postmasterSigns New value of property postmasterSigns.</em>
+<a name="345" href="#345">345</a> <em class="jxr_javadoccomment"> */</em>
+<a name="346" href="#346">346</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPostmasterSigns(<strong class="jxr_keyword">boolean</strong> postmasterSigns) {
+<a name="347" href="#347">347</a> <strong class="jxr_keyword">this</strong>.postmasterSigns = postmasterSigns;
+<a name="348" href="#348">348</a> }
+<a name="349" href="#349">349</a>
+<a name="350" href="#350">350</a> <em class="jxr_javadoccomment">/**</em>
+<a name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * Initializer for property rebuildFrom.</em>
+<a name="352" href="#352">352</a> <em class="jxr_javadoccomment"> */</em>
+<a name="353" href="#353">353</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initRebuildFrom() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="354" href="#354">354</a> setRebuildFrom((getInitParameter(<span class="jxr_string">"rebuildFrom"</span>) == <strong class="jxr_keyword">null</strong>) ? false : <strong class="jxr_keyword">new</strong> Boolean(getInitParameter(<span class="jxr_string">"rebuildFrom"</span>)).booleanValue());
+<a name="355" href="#355">355</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="356" href="#356">356</a> <strong class="jxr_keyword">if</strong> (isRebuildFrom()) {
+<a name="357" href="#357">357</a> log(<span class="jxr_string">"Will modify the \"From:\" header."</span>);
+<a name="358" href="#358">358</a> } <strong class="jxr_keyword">else</strong> {
+<a name="359" href="#359">359</a> log(<span class="jxr_string">"Will leave the \"From:\" header unchanged."</span>);
+<a name="360" href="#360">360</a> }
+<a name="361" href="#361">361</a> }
+<a name="362" href="#362">362</a> }
+<a name="363" href="#363">363</a>
+<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">/**</em>
+<a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * Getter for property rebuildFrom.</em>
+<a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> * If true will modify the "From:" header.</em>
+<a name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * <P>The modification is as follows:</em>
+<a name="368" href="#368">368</a> <em class="jxr_javadoccomment"> * assuming that the signer mail address in the signer certificate is <I>trusted-server@xxx.com&gt;</I></em>
+<a name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * and that <I>From: "John Smith" <john.smith@xxx.com></I></em>
+<a name="370" href="#370">370</a> <em class="jxr_javadoccomment"> * we will get <I>From: "John Smith" <john.smith@xxx.com>" &lt;trusted-server@xxx.com&gt;</I>.</P></em>
+<a name="371" href="#371">371</a> <em class="jxr_javadoccomment"> * <P>If the "ReplyTo:" header is missing or empty it will be set to the original "From:" header.</P></em>
+<a name="372" href="#372">372</a> <em class="jxr_javadoccomment"> * <P>Such modification is necessary to achieve a correct behaviour</em>
+<a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * with some mail clients (e.g. Microsoft Outlook Express).</P></em>
+<a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> * @return Value of property rebuildFrom.</em>
+<a name="375" href="#375">375</a> <em class="jxr_javadoccomment"> */</em>
+<a name="376" href="#376">376</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRebuildFrom() {
+<a name="377" href="#377">377</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.rebuildFrom;
+<a name="378" href="#378">378</a> }
+<a name="379" href="#379">379</a>
+<a name="380" href="#380">380</a> <em class="jxr_javadoccomment">/**</em>
+<a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * Setter for property rebuildFrom.</em>
+<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> * @param rebuildFrom New value of property rebuildFrom.</em>
+<a name="383" href="#383">383</a> <em class="jxr_javadoccomment"> */</em>
+<a name="384" href="#384">384</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setRebuildFrom(<strong class="jxr_keyword">boolean</strong> rebuildFrom) {
+<a name="385" href="#385">385</a> <strong class="jxr_keyword">this</strong>.rebuildFrom = rebuildFrom;
+<a name="386" href="#386">386</a> }
+<a name="387" href="#387">387</a>
+<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">/**</em>
+<a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * Initializer for property signerName.</em>
+<a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> */</em>
+<a name="391" href="#391">391</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> initSignerName() {
+<a name="392" href="#392">392</a> setSignerName(getInitParameter(<span class="jxr_string">"signerName"</span>));
+<a name="393" href="#393">393</a> <strong class="jxr_keyword">if</strong> (getSignerName() == <strong class="jxr_keyword">null</strong>) {
+<a name="394" href="#394">394</a> <strong class="jxr_keyword">if</strong> (getKeyHolder() == <strong class="jxr_keyword">null</strong>) {
+<a name="395" href="#395">395</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(<span class="jxr_string">"initKeyHolder() must be invoked before initSignerName()"</span>);
+<a name="396" href="#396">396</a> }
+<a name="397" href="#397">397</a> setSignerName(getKeyHolder().getSignerCN());
+<a name="398" href="#398">398</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="399" href="#399">399</a> log(<span class="jxr_string">"<signerName> parameter not specified: will use the certificate signer \"CN=\" attribute."</span>);
+<a name="400" href="#400">400</a> }
+<a name="401" href="#401">401</a> }
+<a name="402" href="#402">402</a> }
+<a name="403" href="#403">403</a>
+<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">/**</em>
+<a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * Getter for property signerName.</em>
+<a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> * @return Value of property signerName.</em>
+<a name="407" href="#407">407</a> <em class="jxr_javadoccomment"> */</em>
+<a name="408" href="#408">408</a> <strong class="jxr_keyword">public</strong> String getSignerName() {
+<a name="409" href="#409">409</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.signerName;
+<a name="410" href="#410">410</a> }
+<a name="411" href="#411">411</a>
+<a name="412" href="#412">412</a> <em class="jxr_javadoccomment">/**</em>
+<a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * Setter for property signerName.</em>
+<a name="414" href="#414">414</a> <em class="jxr_javadoccomment"> * @param signerName New value of property signerName.</em>
+<a name="415" href="#415">415</a> <em class="jxr_javadoccomment"> */</em>
+<a name="416" href="#416">416</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setSignerName(String signerName) {
+<a name="417" href="#417">417</a> <strong class="jxr_keyword">this</strong>.signerName = signerName;
+<a name="418" href="#418">418</a> }
+<a name="419" href="#419">419</a>
+<a name="420" href="#420">420</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em></em>
+<a name="421" href="#421">421</a> <em class="jxr_comment">/*<em class="jxr_comment"> ****************** End of setters and getters ********************** */</em></em>
+<a name="422" href="#422">422</a> <em class="jxr_comment">/*<em class="jxr_comment"> ******************************************************************** */</em> </em>
+<a name="423" href="#423">423</a>
+<a name="424" href="#424">424</a> <em class="jxr_javadoccomment">/**</em>
+<a name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * Mailet initialization routine.</em>
+<a name="426" href="#426">426</a> <em class="jxr_javadoccomment"> */</em>
+<a name="427" href="#427">427</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> init() <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="428" href="#428">428</a>
+<a name="429" href="#429">429</a> <em class="jxr_comment">// check that all init parameters have been declared in allowedInitParameters</em>
+<a name="430" href="#430">430</a> checkInitParameters(getAllowedInitParameters());
+<a name="431" href="#431">431</a>
+<a name="432" href="#432">432</a> <strong class="jxr_keyword">try</strong> {
+<a name="433" href="#433">433</a> initDebug();
+<a name="434" href="#434">434</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="435" href="#435">435</a> log(<span class="jxr_string">"Initializing"</span>);
+<a name="436" href="#436">436</a> }
+<a name="437" href="#437">437</a>
+<a name="438" href="#438">438</a> initKeyHolderClass();
+<a name="439" href="#439">439</a> initKeyHolder();
+<a name="440" href="#440">440</a> initSignerName();
+<a name="441" href="#441">441</a> initPostmasterSigns();
+<a name="442" href="#442">442</a> initRebuildFrom();
+<a name="443" href="#443">443</a> initExplanationText();
+<a name="444" href="#444">444</a>
+<a name="445" href="#445">445</a>
+<a name="446" href="#446">446</a> } <strong class="jxr_keyword">catch</strong> (MessagingException me) {
+<a name="447" href="#447">447</a> <strong class="jxr_keyword">throw</strong> me;
+<a name="448" href="#448">448</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="449" href="#449">449</a> log(<span class="jxr_string">"Exception thrown"</span>, e);
+<a name="450" href="#450">450</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Exception thrown"</span>, e);
+<a name="451" href="#451">451</a> } <strong class="jxr_keyword">finally</strong> {
+<a name="452" href="#452">452</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="453" href="#453">453</a> StringBuffer logBuffer =
+<a name="454" href="#454">454</a> <strong class="jxr_keyword">new</strong> StringBuffer(1024)
+<a name="455" href="#455">455</a> .append(<span class="jxr_string">"Other parameters:"</span>)
+<a name="456" href="#456">456</a> .append(<span class="jxr_string">", signerName="</span>).append(getSignerName())
+<a name="457" href="#457">457</a> .append(<span class="jxr_string">", postmasterSigns="</span>).append(postmasterSigns)
+<a name="458" href="#458">458</a> .append(<span class="jxr_string">", rebuildFrom="</span>).append(rebuildFrom)
+<a name="459" href="#459">459</a> .append(<span class="jxr_string">" "</span>);
+<a name="460" href="#460">460</a> log(logBuffer.toString());
+<a name="461" href="#461">461</a> }
+<a name="462" href="#462">462</a> }
+<a name="463" href="#463">463</a>
+<a name="464" href="#464">464</a> }
+<a name="465" href="#465">465</a>
+<a name="466" href="#466">466</a> <em class="jxr_javadoccomment">/**</em>
+<a name="467" href="#467">467</a> <em class="jxr_javadoccomment"> * Service does the hard work, and signs</em>
+<a name="468" href="#468">468</a> <em class="jxr_javadoccomment"> *</em>
+<a name="469" href="#469">469</a> <em class="jxr_javadoccomment"> * @param mail the mail to sign</em>
+<a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> * @throws MessagingException if a problem arises signing the mail</em>
+<a name="471" href="#471">471</a> <em class="jxr_javadoccomment"> */</em>
+<a name="472" href="#472">472</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> service(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="473" href="#473">473</a>
+<a name="474" href="#474">474</a> <strong class="jxr_keyword">try</strong> {
+<a name="475" href="#475">475</a> <strong class="jxr_keyword">if</strong> (!isOkToSign(mail)) {
+<a name="476" href="#476">476</a> <strong class="jxr_keyword">return</strong>;
+<a name="477" href="#477">477</a> }
+<a name="478" href="#478">478</a>
+<a name="479" href="#479">479</a> MimeBodyPart wrapperBodyPart = getWrapperBodyPart(mail);
+<a name="480" href="#480">480</a>
+<a name="481" href="#481">481</a> MimeMessage originalMessage = mail.getMessage();
+<a name="482" href="#482">482</a>
+<a name="483" href="#483">483</a> <em class="jxr_comment">// do it</em>
+<a name="484" href="#484">484</a> MimeMultipart signedMimeMultipart;
+<a name="485" href="#485">485</a> <strong class="jxr_keyword">if</strong> (wrapperBodyPart != <strong class="jxr_keyword">null</strong>) {
+<a name="486" href="#486">486</a> signedMimeMultipart = getKeyHolder().generate(wrapperBodyPart);
+<a name="487" href="#487">487</a> } <strong class="jxr_keyword">else</strong> {
+<a name="488" href="#488">488</a> signedMimeMultipart = getKeyHolder().generate(originalMessage);
+<a name="489" href="#489">489</a> }
+<a name="490" href="#490">490</a>
+<a name="491" href="#491">491</a> MimeMessage newMessage = <strong class="jxr_keyword">new</strong> MimeMessage(Session.getDefaultInstance(System.getProperties(),
+<a name="492" href="#492">492</a> <strong class="jxr_keyword">null</strong>));
+<a name="493" href="#493">493</a> Enumeration headerEnum = originalMessage.getAllHeaderLines();
+<a name="494" href="#494">494</a> <strong class="jxr_keyword">while</strong> (headerEnum.hasMoreElements()) {
+<a name="495" href="#495">495</a> newMessage.addHeaderLine((String) headerEnum.nextElement());
+<a name="496" href="#496">496</a> }
+<a name="497" href="#497">497</a>
+<a name="498" href="#498">498</a> newMessage.setSender(<strong class="jxr_keyword">new</strong> InternetAddress(getKeyHolder().getSignerAddress(), getSignerName()));
+<a name="499" href="#499">499</a>
+<a name="500" href="#500">500</a> <strong class="jxr_keyword">if</strong> (isRebuildFrom()) {
+<a name="501" href="#501">501</a> <em class="jxr_comment">// builds a new "mixed" "From:" header</em>
+<a name="502" href="#502">502</a> InternetAddress modifiedFromIA = <strong class="jxr_keyword">new</strong> InternetAddress(getKeyHolder().getSignerAddress(), mail.getSender().toString());
+<a name="503" href="#503">503</a> newMessage.setFrom(modifiedFromIA);
+<a name="504" href="#504">504</a>
+<a name="505" href="#505">505</a> <em class="jxr_comment">// if the original "ReplyTo:" header is missing sets it to the original "From:" header</em>
+<a name="506" href="#506">506</a> newMessage.setReplyTo(originalMessage.getReplyTo());
+<a name="507" href="#507">507</a> }
+<a name="508" href="#508">508</a>
+<a name="509" href="#509">509</a> newMessage.setContent(signedMimeMultipart, signedMimeMultipart.getContentType());
+<a name="510" href="#510">510</a> String messageId = originalMessage.getMessageID();
+<a name="511" href="#511">511</a> newMessage.saveChanges();
+<a name="512" href="#512">512</a> <strong class="jxr_keyword">if</strong> (messageId != <strong class="jxr_keyword">null</strong>) {
+<a name="513" href="#513">513</a> newMessage.setHeader(RFC2822Headers.MESSAGE_ID, messageId);
+<a name="514" href="#514">514</a> }
+<a name="515" href="#515">515</a>
+<a name="516" href="#516">516</a> mail.setMessage(newMessage);
+<a name="517" href="#517">517</a>
+<a name="518" href="#518">518</a> <em class="jxr_comment">// marks this mail as server-signed</em>
+<a name="519" href="#519">519</a> mail.setAttribute(SMIMEAttributeNames.SMIME_SIGNING_MAILET, <strong class="jxr_keyword">this</strong>.getClass().getName());
+<a name="520" href="#520">520</a> <em class="jxr_comment">// it is valid for us by definition (signed here by us)</em>
+<a name="521" href="#521">521</a> mail.setAttribute(SMIMEAttributeNames.SMIME_SIGNATURE_VALIDITY, <span class="jxr_string">"valid"</span>);
+<a name="522" href="#522">522</a>
+<a name="523" href="#523">523</a> <em class="jxr_comment">// saves the trusted server signer address</em>
+<a name="524" href="#524">524</a> <em class="jxr_comment">// warning: should be same as the mail address in the certificate, but it is not guaranteed</em>
+<a name="525" href="#525">525</a> mail.setAttribute(SMIMEAttributeNames.SMIME_SIGNER_ADDRESS, getKeyHolder().getSignerAddress());
+<a name="526" href="#526">526</a>
+<a name="527" href="#527">527</a> <strong class="jxr_keyword">if</strong> (isDebug()) {
+<a name="528" href="#528">528</a> log(<span class="jxr_string">"Message signed, reverse-path: "</span> + mail.getSender() + <span class="jxr_string">", Id: "</span> + messageId);
+<a name="529" href="#529">529</a> }
+<a name="530" href="#530">530</a>
+<a name="531" href="#531">531</a> } <strong class="jxr_keyword">catch</strong> (MessagingException me) {
+<a name="532" href="#532">532</a> log(<span class="jxr_string">"MessagingException found - could not sign!"</span>, me);
+<a name="533" href="#533">533</a> <strong class="jxr_keyword">throw</strong> me;
+<a name="534" href="#534">534</a> } <strong class="jxr_keyword">catch</strong> (Exception e) {
+<a name="535" href="#535">535</a> log(<span class="jxr_string">"Exception found"</span>, e);
+<a name="536" href="#536">536</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MessagingException(<span class="jxr_string">"Exception thrown - could not sign!"</span>, e);
+<a name="537" href="#537">537</a> }
+<a name="538" href="#538">538</a>
+<a name="539" href="#539">539</a> }
+<a name="540" href="#540">540</a>
+<a name="541" href="#541">541</a>
+<a name="542" href="#542">542</a> <em class="jxr_javadoccomment">/**</em>
+<a name="543" href="#543">543</a> <em class="jxr_javadoccomment"> * <P>Checks if the mail can be signed.</P></em>
+<a name="544" href="#544">544</a> <em class="jxr_javadoccomment"> * <P>Rules:</P></em>
+<a name="545" href="#545">545</a> <em class="jxr_javadoccomment"> * <OL></em>
+<a name="546" href="#546">546</a> <em class="jxr_javadoccomment"> * <LI>The reverse-path != null (it is not a bounce).</LI></em>
+<a name="547" href="#547">547</a> <em class="jxr_javadoccomment"> * <LI>The sender user must have been SMTP authenticated.</LI></em>
+<a name="548" href="#548">548</a> <em class="jxr_javadoccomment"> * <LI>Either:</LI></em>
+<a name="549" href="#549">549</a> <em class="jxr_javadoccomment"> * <UL></em>
+<a name="550" href="#550">550</a> <em class="jxr_javadoccomment"> * <LI>The reverse-path is the postmaster address and {@link #isPostmasterSigns} returns <I>true</I></LI></em>
+<a name="551" href="#551">551</a> <em class="jxr_javadoccomment"> * <LI>or the reverse-path == the authenticated user</em>
+<a name="552" href="#552">552</a> <em class="jxr_javadoccomment"> * and there is at least one "From:" address == reverse-path.</LI>.</em>
+<a name="553" href="#553">553</a> <em class="jxr_javadoccomment"> * </UL></em>
+<a name="554" href="#554">554</a> <em class="jxr_javadoccomment"> * <LI>The message has not already been signed (mimeType != <I>multipart/signed</I></em>
+<a name="555" href="#555">555</a> <em class="jxr_javadoccomment"> * and != <I>application/pkcs7-mime</I>).</LI></em>
+<a name="556" href="#556">556</a> <em class="jxr_javadoccomment"> * </OL></em>
+<a name="557" href="#557">557</a> <em class="jxr_javadoccomment"> * @param mail The mail object to check.</em>
+<a name="558" href="#558">558</a> <em class="jxr_javadoccomment"> * @return True if can be signed.</em>
+<a name="559" href="#559">559</a> <em class="jxr_javadoccomment"> */</em>
+<a name="560" href="#560">560</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> isOkToSign(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="561" href="#561">561</a>
+<a name="562" href="#562">562</a> MailAddress reversePath = mail.getSender();
+<a name="563" href="#563">563</a>
+<a name="564" href="#564">564</a> <em class="jxr_comment">// Is it a bounce?</em>
+<a name="565" href="#565">565</a> <strong class="jxr_keyword">if</strong> (reversePath == <strong class="jxr_keyword">null</strong>) {
+<a name="566" href="#566">566</a> <strong class="jxr_keyword">return</strong> false;
+<a name="567" href="#567">567</a> }
+<a name="568" href="#568">568</a>
+<a name="569" href="#569">569</a> String authUser = (String) mail.getAttribute(<span class="jxr_string">"org.apache.james.SMTPAuthUser"</span>);
+<a name="570" href="#570">570</a> <em class="jxr_comment">// was the sender user SMTP authorized?</em>
+<a name="571" href="#571">571</a> <strong class="jxr_keyword">if</strong> (authUser == <strong class="jxr_keyword">null</strong>) {
+<a name="572" href="#572">572</a> <strong class="jxr_keyword">return</strong> false;
+<a name="573" href="#573">573</a> }
+<a name="574" href="#574">574</a>
+<a name="575" href="#575">575</a> <em class="jxr_comment">// The sender is the postmaster?</em>
+<a name="576" href="#576">576</a> <strong class="jxr_keyword">if</strong> (getMailetContext().getPostmaster().equals(reversePath)) {
+<a name="577" href="#577">577</a> <em class="jxr_comment">// should not sign postmaster sent messages?</em>
+<a name="578" href="#578">578</a> <strong class="jxr_keyword">if</strong> (!isPostmasterSigns()) {
+<a name="579" href="#579">579</a> <strong class="jxr_keyword">return</strong> false;
+<a name="580" href="#580">580</a> }
+<a name="581" href="#581">581</a> } <strong class="jxr_keyword">else</strong> {
+<a name="582" href="#582">582</a> <em class="jxr_comment">// is the reverse-path user different from the SMTP authorized user?</em>
+<a name="583" href="#583">583</a> <strong class="jxr_keyword">if</strong> (!reversePath.getUser().equals(authUser)) {
+<a name="584" href="#584">584</a> <strong class="jxr_keyword">return</strong> false;
+<a name="585" href="#585">585</a> }
+<a name="586" href="#586">586</a> <em class="jxr_comment">// is there no "From:" address same as the reverse-path?</em>
+<a name="587" href="#587">587</a> <strong class="jxr_keyword">if</strong> (!fromAddressSameAsReverse(mail)) {
+<a name="588" href="#588">588</a> <strong class="jxr_keyword">return</strong> false;
+<a name="589" href="#589">589</a> }
+<a name="590" href="#590">590</a> }
+<a name="591" href="#591">591</a>
+<a name="592" href="#592">592</a>
+<a name="593" href="#593">593</a> <em class="jxr_comment">// if already signed return false</em>
+<a name="594" href="#594">594</a> MimeMessage mimeMessage = mail.getMessage();
+<a name="595" href="#595">595</a> <strong class="jxr_keyword">if</strong> (mimeMessage.isMimeType(<span class="jxr_string">"multipart/signed"</span>)
+<a name="596" href="#596">596</a> || mimeMessage.isMimeType(<span class="jxr_string">"application/pkcs7-mime"</span>)) {
+<a name="597" href="#597">597</a> <strong class="jxr_keyword">return</strong> false;
+<a name="598" href="#598">598</a> }
+<a name="599" href="#599">599</a>
+<a name="600" href="#600">600</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="601" href="#601">601</a> }
+<a name="602" href="#602">602</a>
+<a name="603" href="#603">603</a> <em class="jxr_javadoccomment">/**</em>
+<a name="604" href="#604">604</a> <em class="jxr_javadoccomment"> * Creates the {@link javax.mail.internet.MimeBodyPart} that will be signed.</em>
+<a name="605" href="#605">605</a> <em class="jxr_javadoccomment"> * For example, may attach a text file explaining the meaning of the signature,</em>
+<a name="606" href="#606">606</a> <em class="jxr_javadoccomment"> * or an XML file containing information that can be checked by other MTAs.</em>
+<a name="607" href="#607">607</a> <em class="jxr_javadoccomment"> * @param mail The mail to massage.</em>
+<a name="608" href="#608">608</a> <em class="jxr_javadoccomment"> * @return The massaged MimeBodyPart to sign, or null to have the whole message signed "as is".</em>
+<a name="609" href="#609">609</a> <em class="jxr_javadoccomment"> */</em>
+<a name="610" href="#610">610</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">abstract</strong> MimeBodyPart getWrapperBodyPart(Mail mail) <strong class="jxr_keyword">throws</strong> MessagingException, IOException;
+<a name="611" href="#611">611</a>
+<a name="612" href="#612">612</a> <em class="jxr_javadoccomment">/**</em>
+<a name="613" href="#613">613</a> <em class="jxr_javadoccomment"> * Utility method that checks if there is at least one address in the "From:" header</em>
+<a name="614" href="#614">614</a> <em class="jxr_javadoccomment"> * same as the <i>reverse-path</i>.</em>
+<a name="615" href="#615">615</a> <em class="jxr_javadoccomment"> * @param mail The mail to check.</em>
+<a name="616" href="#616">616</a> <em class="jxr_javadoccomment"> * @return True if an address is found, false otherwise.</em>
+<a name="617" href="#617">617</a> <em class="jxr_javadoccomment"> */</em>
+<a name="618" href="#618">618</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> fromAddressSameAsReverse(Mail mail) {
+<a name="619" href="#619">619</a>
+<a name="620" href="#620">620</a> MailAddress reversePath = mail.getSender();
+<a name="621" href="#621">621</a>
+<a name="622" href="#622">622</a> <strong class="jxr_keyword">if</strong> (reversePath == <strong class="jxr_keyword">null</strong>) {
+<a name="623" href="#623">623</a> <strong class="jxr_keyword">return</strong> false;
+<a name="624" href="#624">624</a> }
+<a name="625" href="#625">625</a>
+<a name="626" href="#626">626</a> <strong class="jxr_keyword">try</strong> {
+<a name="627" href="#627">627</a> InternetAddress[] fromArray = (InternetAddress[]) mail.getMessage().getFrom();
+<a name="628" href="#628">628</a> <strong class="jxr_keyword">if</strong> (fromArray != <strong class="jxr_keyword">null</strong>) {
+<a name="629" href="#629">629</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < fromArray.length; i++) {
+<a name="630" href="#630">630</a> MailAddress mailAddress = <strong class="jxr_keyword">null</strong>;
+<a name="631" href="#631">631</a> <strong class="jxr_keyword">try</strong> {
+<a name="632" href="#632">632</a> mailAddress = <strong class="jxr_keyword">new</strong> MailAddress(fromArray[i]);
+<a name="633" href="#633">633</a> } <strong class="jxr_keyword">catch</strong> (ParseException pe) {
+<a name="634" href="#634">634</a> log(<span class="jxr_string">"Unable to parse a \"FROM\" header address: "</span> + fromArray[i].toString() + <span class="jxr_string">"; ignoring."</span>);
+<a name="635" href="#635">635</a> <strong class="jxr_keyword">continue</strong>;
+<a name="636" href="#636">636</a> }
+<a name="637" href="#637">637</a> <strong class="jxr_keyword">if</strong> (mailAddress.equals(reversePath)) {
+<a name="638" href="#638">638</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a name="639" href="#639">639</a> }
+<a name="640" href="#640">640</a> }
+<a name="641" href="#641">641</a> }
+<a name="642" href="#642">642</a> } <strong class="jxr_keyword">catch</strong> (MessagingException me) {
+<a name="643" href="#643">643</a> log(<span class="jxr_string">"Unable to parse the \"FROM\" header; ignoring."</span>);
+<a name="644" href="#644">644</a> }
+<a name="645" href="#645">645</a>
+<a name="646" href="#646">646</a> <strong class="jxr_keyword">return</strong> false;
+<a name="647" href="#647">647</a>
+<a name="648" href="#648">648</a> }
+<a name="649" href="#649">649</a>
+<a name="650" href="#650">650</a> <em class="jxr_javadoccomment">/**</em>
+<a name="651" href="#651">651</a> <em class="jxr_javadoccomment"> * Utility method for obtaining a string representation of the Message's headers</em>
+<a name="652" href="#652">652</a> <em class="jxr_javadoccomment"> * @param message The message to extract the headers from.</em>
+<a name="653" href="#653">653</a> <em class="jxr_javadoccomment"> * @return The string containing the headers.</em>
+<a name="654" href="#654">654</a> <em class="jxr_javadoccomment"> */</em>
+<a name="655" href="#655">655</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> String getMessageHeaders(MimeMessage message) <strong class="jxr_keyword">throws</strong> MessagingException {
+<a name="656" href="#656">656</a> Enumeration heads = message.getAllHeaderLines();
+<a name="657" href="#657">657</a> StringBuffer headBuffer = <strong class="jxr_keyword">new</strong> StringBuffer(1024);
+<a name="658" href="#658">658</a> <strong class="jxr_keyword">while</strong>(heads.hasMoreElements()) {
+<a name="659" href="#659">659</a> headBuffer.append(heads.nextElement().toString()).append(<span class="jxr_string">"\r\n"</span>);
+<a name="660" href="#660">660</a> }
+<a name="661" href="#661">661</a> <strong class="jxr_keyword">return</strong> headBuffer.toString();
+<a name="662" href="#662">662</a> }
+<a name="663" href="#663">663</a>
+<a name="664" href="#664">664</a> <em class="jxr_javadoccomment">/**</em>
+<a name="665" href="#665">665</a> <em class="jxr_javadoccomment"> * Prepares the explanation text making substitutions in the <I>explanationText</I> template string.</em>
+<a name="666" href="#666">666</a> <em class="jxr_javadoccomment"> * Utility method that searches for all occurrences of some pattern strings</em>
+<a name="667" href="#667">667</a> <em class="jxr_javadoccomment"> * and substitute them with the appropriate params.</em>
+<a name="668" href="#668">668</a> <em class="jxr_javadoccomment"> * @param explanationText The template string for the explanation text.</em>
+<a name="669" href="#669">669</a> <em class="jxr_javadoccomment"> * @param signerName The string that will replace the <CODE>[signerName]</CODE> pattern.</em>
+<a name="670" href="#670">670</a> <em class="jxr_javadoccomment"> * @param signerAddress The string that will replace the <CODE>[signerAddress]</CODE> pattern.</em>
+<a name="671" href="#671">671</a> <em class="jxr_javadoccomment"> * @param reversePath The string that will replace the <CODE>[reversePath]</CODE> pattern.</em>
+<a name="672" href="#672">672</a> <em class="jxr_javadoccomment"> * @param headers The string that will replace the <CODE>[headers]</CODE> pattern.</em>
+<a name="673" href="#673">673</a> <em class="jxr_javadoccomment"> * @return The actual explanation text string with all replacements done.</em>
+<a name="674" href="#674">674</a> <em class="jxr_javadoccomment"> */</em>
+<a name="675" href="#675">675</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">final</strong> String getReplacedExplanationText(String explanationText, String signerName,
+<a name="676" href="#676">676</a> String signerAddress, String reversePath, String headers) {
+<a name="677" href="#677">677</a>
+<a name="678" href="#678">678</a> String replacedExplanationText = explanationText;
+<a name="679" href="#679">679</a>
+<a name="680" href="#680">680</a> replacedExplanationText = getReplacedString(replacedExplanationText, SIGNER_NAME_PATTERN, signerName);
+<a name="681" href="#681">681</a> replacedExplanationText = getReplacedString(replacedExplanationText, SIGNER_ADDRESS_PATTERN, signerAddress);
+<a name="682" href="#682">682</a> replacedExplanationText = getReplacedString(replacedExplanationText, REVERSE_PATH_PATTERN, reversePath);
+<a name="683" href="#683">683</a> replacedExplanationText = getReplacedString(replacedExplanationText, HEADERS_PATTERN, headers);
+<a name="684" href="#684">684</a>
+<a name="685" href="#685">685</a> <strong class="jxr_keyword">return</strong> replacedExplanationText;
+<a name="686" href="#686">686</a> }
+<a name="687" href="#687">687</a>
+<a name="688" href="#688">688</a> <em class="jxr_javadoccomment">/**</em>
+<a name="689" href="#689">689</a> <em class="jxr_javadoccomment"> * Searches the <I>template</I> String for all occurrences of the <I>pattern</I> string</em>
+<a name="690" href="#690">690</a> <em class="jxr_javadoccomment"> * and creates a new String substituting them with the <I>actual</I> String.</em>
+<a name="691" href="#691">691</a> <em class="jxr_javadoccomment"> * @param template The template String to work on.</em>
+<a name="692" href="#692">692</a> <em class="jxr_javadoccomment"> * @param pattern The string to search for the replacement.</em>
+<a name="693" href="#693">693</a> <em class="jxr_javadoccomment"> * @param actual The actual string to use for the replacement.</em>
+<a name="694" href="#694">694</a> <em class="jxr_javadoccomment"> */</em>
+<a name="695" href="#695">695</a> <strong class="jxr_keyword">private</strong> String getReplacedString(String template, String pattern, String actual) {
+<a name="696" href="#696">696</a> <strong class="jxr_keyword">if</strong> (actual != <strong class="jxr_keyword">null</strong>) {
+<a name="697" href="#697">697</a> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer(template.length());
+<a name="698" href="#698">698</a> <strong class="jxr_keyword">int</strong> fromIndex = 0;
+<a name="699" href="#699">699</a> <strong class="jxr_keyword">int</strong> index;
+<a name="700" href="#700">700</a> <strong class="jxr_keyword">while</strong> ((index = template.indexOf(pattern, fromIndex)) >= 0) {
+<a name="701" href="#701">701</a> sb.append(template.substring(fromIndex, index));
+<a name="702" href="#702">702</a> sb.append(actual);
+<a name="703" href="#703">703</a> fromIndex = index + pattern.length();
+<a name="704" href="#704">704</a> }
+<a name="705" href="#705">705</a> <strong class="jxr_keyword">if</strong> (fromIndex < template.length()){
+<a name="706" href="#706">706</a> sb.append(template.substring(fromIndex));
+<a name="707" href="#707">707</a> }
+<a name="708" href="#708">708</a> <strong class="jxr_keyword">return</strong> sb.toString();
+<a name="709" href="#709">709</a> } <strong class="jxr_keyword">else</strong> {
+<a name="710" href="#710">710</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(template);
+<a name="711" href="#711">711</a> }
+<a name="712" href="#712">712</a> }
+<a name="713" href="#713">713</a>
+<a name="714" href="#714">714</a> }
+<a name="715" href="#715">715</a>
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+