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 ba...@apache.org on 2006/09/24 17:35:10 UTC
svn commit: r449415 [11/18] - in /james/site/trunk/www/jspf: ./ apidocs/
apidocs/org/apache/james/jspf/ apidocs/org/apache/james/jspf/class-use/
apidocs/org/apache/james/jspf/core/
apidocs/org/apache/james/jspf/core/class-use/ apidocs/org/apache/james/...
Modified: james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF.html?view=diff&rev=449415&r1=449414&r2=449415
==============================================================================
--- james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF.html (original)
+++ james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF.html Sun Sep 24 08:35:04 2006
@@ -36,251 +36,243 @@
<a name="27" href="#27">27</a> <strong>import</strong> org.apache.james.jspf.core.SPF1Constants;
<a name="28" href="#28">28</a> <strong>import</strong> org.apache.james.jspf.core.SPF1Data;
<a name="29" href="#29">29</a> <strong>import</strong> org.apache.james.jspf.core.SPF1Record;
-<a name="30" href="#30">30</a> <strong>import</strong> org.apache.james.jspf.exceptions.NoneException;
-<a name="31" href="#31">31</a> <strong>import</strong> org.apache.james.jspf.exceptions.PermErrorException;
-<a name="32" href="#32">32</a> <strong>import</strong> org.apache.james.jspf.exceptions.TempErrorException;
-<a name="33" href="#33">33</a> <strong>import</strong> org.apache.james.jspf.macro.MacroExpand;
-<a name="34" href="#34">34</a> <strong>import</strong> org.apache.james.jspf.parser.SPF1Parser;
-<a name="35" href="#35">35</a>
-<a name="36" href="#36">36</a> <strong>import</strong> java.util.Iterator;
-<a name="37" href="#37">37</a>
-<a name="38" href="#38">38</a> <em>/**<em>*</em></em>
-<a name="39" href="#39">39</a> <em> * This class is used to generate a SPF-Test and provided all intressting data.</em>
-<a name="40" href="#40">40</a> <em> * </em>
-<a name="41" href="#41">41</a> <em> */</em>
-<a name="42" href="#42">42</a>
-<a name="43" href="#43">43</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a> {
-<a name="44" href="#44">44</a>
-<a name="45" href="#45">45</a> <strong>private</strong> <a href="../../../../org/apache/james/jspf/core/DNSService.html">DNSService</a> dnsProbe;
-<a name="46" href="#46">46</a>
-<a name="47" href="#47">47</a> <strong>private</strong> SPF1Parser parser;
-<a name="48" href="#48">48</a>
-<a name="49" href="#49">49</a> <strong>private</strong> <a href="../../../../org/apache/james/jspf/core/Logger.html">Logger</a> log;
-<a name="50" href="#50">50</a>
-<a name="51" href="#51">51</a> <em>/**<em>*</em></em>
-<a name="52" href="#52">52</a> <em> * Uses default Log4JLogger and DNSJava based dns resolver</em>
-<a name="53" href="#53">53</a> <em> */</em>
-<a name="54" href="#54">54</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a>() {
-<a name="55" href="#55">55</a> <strong>this</strong>(<strong>new</strong> Log4JLogger(org.apache.log4j.Logger.getLogger(SPF.<strong>class</strong>)));
-<a name="56" href="#56">56</a> }
-<a name="57" href="#57">57</a>
-<a name="58" href="#58">58</a> <em>/**<em>*</em></em>
-<a name="59" href="#59">59</a> <em> * Uses passed logger and DNSJava based dns resolver</em>
-<a name="60" href="#60">60</a> <em> * @param logger logger</em>
-<a name="61" href="#61">61</a> <em> */</em>
-<a name="62" href="#62">62</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a>(<a href="../../../../org/apache/james/jspf/core/Logger.html">Logger</a> logger) {
-<a name="63" href="#63">63</a> <strong>this</strong>(<strong>new</strong> <a href="../../../../org/apache/james/jspf/DNSServiceXBillImpl.html">DNSServiceXBillImpl</a>(logger), logger);
-<a name="64" href="#64">64</a> }
-<a name="65" href="#65">65</a>
-<a name="66" href="#66">66</a> <em>/**<em>*</em></em>
-<a name="67" href="#67">67</a> <em> * @param dnsProbe</em>
-<a name="68" href="#68">68</a> <em> * the dns provider</em>
-<a name="69" href="#69">69</a> <em> */</em>
-<a name="70" href="#70">70</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a>(<a href="../../../../org/apache/james/jspf/core/DNSService.html">DNSService</a> dnsProbe, <a href="../../../../org/apache/james/jspf/core/Logger.html">Logger</a> logger) {
-<a name="71" href="#71">71</a> <strong>super</strong>();
-<a name="72" href="#72">72</a> <strong>this</strong>.dnsProbe = dnsProbe;
-<a name="73" href="#73">73</a> <strong>this</strong>.parser = <strong>new</strong> SPF1Parser(logger);
-<a name="74" href="#74">74</a> <strong>this</strong>.log = logger;
-<a name="75" href="#75">75</a> }
-<a name="76" href="#76">76</a>
-<a name="77" href="#77">77</a> <em>/**<em>*</em></em>
-<a name="78" href="#78">78</a> <em> * Run check for SPF with the given values.</em>
-<a name="79" href="#79">79</a> <em> * </em>
-<a name="80" href="#80">80</a> <em> * @param ipAddress</em>
-<a name="81" href="#81">81</a> <em> * The ipAddress the connection is comming from</em>
-<a name="82" href="#82">82</a> <em> * @param mailFrom</em>
-<a name="83" href="#83">83</a> <em> * The mailFrom which was provided</em>
-<a name="84" href="#84">84</a> <em> * @param hostName</em>
-<a name="85" href="#85">85</a> <em> * The hostname which was provided as HELO/EHLO</em>
-<a name="86" href="#86">86</a> <em> * @return result. Possible results are: pass, neutral, fail,</em>
-<a name="87" href="#87">87</a> <em> * softfail, error,temperror, none</em>
-<a name="88" href="#88">88</a> <em> */</em>
-<a name="89" href="#89">89</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a> checkSPF(String ipAddress, String mailFrom, String hostName) {
-<a name="90" href="#90">90</a> SPF1Data spfData = <strong>null</strong>;
-<a name="91" href="#91">91</a> String result = <strong>null</strong>;
-<a name="92" href="#92">92</a> String resultChar = <strong>null</strong>;
-<a name="93" href="#93">93</a> String explanation = <strong>null</strong>;
-<a name="94" href="#94">94</a>
-<a name="95" href="#95">95</a> <strong>try</strong> {
-<a name="96" href="#96">96</a> <em class="comment">// Setup the data</em>
-<a name="97" href="#97">97</a> spfData = <strong>new</strong> SPF1Data(mailFrom, hostName, ipAddress, dnsProbe);
-<a name="98" href="#98">98</a> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> res = checkSPF(spfData);
-<a name="99" href="#99">99</a> resultChar = res.getResultChar();
-<a name="100" href="#100">100</a> result = SPF1Utils.resultToName(resultChar);
-<a name="101" href="#101">101</a> explanation = res.getExplanation();
-<a name="102" href="#102">102</a> } <strong>catch</strong> (PermErrorException e) {
-<a name="103" href="#103">103</a> log.warn(e.getMessage(),e);
-<a name="104" href="#104">104</a> result = SPF1Utils.PERM_ERROR;
-<a name="105" href="#105">105</a> } <strong>catch</strong> (NoneException e) {
+<a name="30" href="#30">30</a> <strong>import</strong> org.apache.james.jspf.exceptions.NeutralException;
+<a name="31" href="#31">31</a> <strong>import</strong> org.apache.james.jspf.exceptions.NoneException;
+<a name="32" href="#32">32</a> <strong>import</strong> org.apache.james.jspf.exceptions.PermErrorException;
+<a name="33" href="#33">33</a> <strong>import</strong> org.apache.james.jspf.exceptions.TempErrorException;
+<a name="34" href="#34">34</a> <strong>import</strong> org.apache.james.jspf.macro.MacroExpand;
+<a name="35" href="#35">35</a> <strong>import</strong> org.apache.james.jspf.parser.SPF1Parser;
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <strong>import</strong> java.util.Iterator;
+<a name="38" href="#38">38</a>
+<a name="39" href="#39">39</a> <em>/**<em>*</em></em>
+<a name="40" href="#40">40</a> <em> * This class is used to generate a SPF-Test and provided all intressting data.</em>
+<a name="41" href="#41">41</a> <em> * </em>
+<a name="42" href="#42">42</a> <em> */</em>
+<a name="43" href="#43">43</a>
+<a name="44" href="#44">44</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a> {
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <strong>private</strong> <a href="../../../../org/apache/james/jspf/core/DNSService.html">DNSService</a> dnsProbe;
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <strong>private</strong> SPF1Parser parser;
+<a name="49" href="#49">49</a>
+<a name="50" href="#50">50</a> <strong>private</strong> <a href="../../../../org/apache/james/jspf/core/Logger.html">Logger</a> log;
+<a name="51" href="#51">51</a>
+<a name="52" href="#52">52</a> <em>/**<em>*</em></em>
+<a name="53" href="#53">53</a> <em> * Uses default Log4JLogger and DNSJava based dns resolver</em>
+<a name="54" href="#54">54</a> <em> */</em>
+<a name="55" href="#55">55</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a>() {
+<a name="56" href="#56">56</a> <strong>this</strong>(<strong>new</strong> Log4JLogger(org.apache.log4j.Logger.getLogger(SPF.<strong>class</strong>)));
+<a name="57" href="#57">57</a> }
+<a name="58" href="#58">58</a>
+<a name="59" href="#59">59</a> <em>/**<em>*</em></em>
+<a name="60" href="#60">60</a> <em> * Uses passed logger and DNSJava based dns resolver</em>
+<a name="61" href="#61">61</a> <em> * </em>
+<a name="62" href="#62">62</a> <em> * @param logger the logger to use</em>
+<a name="63" href="#63">63</a> <em> */</em>
+<a name="64" href="#64">64</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a>(<a href="../../../../org/apache/james/jspf/core/Logger.html">Logger</a> logger) {
+<a name="65" href="#65">65</a> <strong>this</strong>(<strong>new</strong> <a href="../../../../org/apache/james/jspf/DNSServiceXBillImpl.html">DNSServiceXBillImpl</a>(logger), logger);
+<a name="66" href="#66">66</a> }
+<a name="67" href="#67">67</a>
+<a name="68" href="#68">68</a> <em>/**<em>*</em></em>
+<a name="69" href="#69">69</a> <em> * Uses passed logger and passed dnsServicer</em>
+<a name="70" href="#70">70</a> <em> * </em>
+<a name="71" href="#71">71</a> <em> * @param dnsProbe the dns provider</em>
+<a name="72" href="#72">72</a> <em> * @param logger the logger to use</em>
+<a name="73" href="#73">73</a> <em> */</em>
+<a name="74" href="#74">74</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPF.html">SPF</a>(<a href="../../../../org/apache/james/jspf/core/DNSService.html">DNSService</a> dnsProbe, <a href="../../../../org/apache/james/jspf/core/Logger.html">Logger</a> logger) {
+<a name="75" href="#75">75</a> <strong>super</strong>();
+<a name="76" href="#76">76</a> <strong>this</strong>.dnsProbe = dnsProbe;
+<a name="77" href="#77">77</a> <strong>this</strong>.parser = <strong>new</strong> SPF1Parser(logger);
+<a name="78" href="#78">78</a> <strong>this</strong>.log = logger;
+<a name="79" href="#79">79</a> }
+<a name="80" href="#80">80</a>
+<a name="81" href="#81">81</a> <em>/**<em>*</em></em>
+<a name="82" href="#82">82</a> <em> * Run check for SPF with the given values.</em>
+<a name="83" href="#83">83</a> <em> * </em>
+<a name="84" href="#84">84</a> <em> * @param ipAddress</em>
+<a name="85" href="#85">85</a> <em> * The ipAddress the connection is comming from</em>
+<a name="86" href="#86">86</a> <em> * @param mailFrom</em>
+<a name="87" href="#87">87</a> <em> * The mailFrom which was provided</em>
+<a name="88" href="#88">88</a> <em> * @param hostName</em>
+<a name="89" href="#89">89</a> <em> * The hostname which was provided as HELO/EHLO</em>
+<a name="90" href="#90">90</a> <em> * @return result The SPFResult</em>
+<a name="91" href="#91">91</a> <em> */</em>
+<a name="92" href="#92">92</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a> checkSPF(String ipAddress, String mailFrom, String hostName) {
+<a name="93" href="#93">93</a> SPF1Data spfData = <strong>null</strong>;
+<a name="94" href="#94">94</a> String result = <strong>null</strong>;
+<a name="95" href="#95">95</a> String resultChar = <strong>null</strong>;
+<a name="96" href="#96">96</a> String explanation = <strong>null</strong>;
+<a name="97" href="#97">97</a>
+<a name="98" href="#98">98</a> <strong>try</strong> {
+<a name="99" href="#99">99</a> <em class="comment">// Setup the data</em>
+<a name="100" href="#100">100</a> spfData = <strong>new</strong> SPF1Data(mailFrom, hostName, ipAddress, dnsProbe);
+<a name="101" href="#101">101</a> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> res = checkSPF(spfData);
+<a name="102" href="#102">102</a> resultChar = res.getResultChar();
+<a name="103" href="#103">103</a> result = SPF1Utils.resultToName(resultChar);
+<a name="104" href="#104">104</a> explanation = res.getExplanation();
+<a name="105" href="#105">105</a> } <strong>catch</strong> (PermErrorException e) {
<a name="106" href="#106">106</a> log.warn(e.getMessage(),e);
-<a name="107" href="#107">107</a> result = SPF1Utils.NONE;
-<a name="108" href="#108">108</a> } <strong>catch</strong> (TempErrorException e) {
+<a name="107" href="#107">107</a> result = SPF1Utils.PERM_ERROR_CONV;
+<a name="108" href="#108">108</a> } <strong>catch</strong> (NoneException e) {
<a name="109" href="#109">109</a> log.warn(e.getMessage(),e);
-<a name="110" href="#110">110</a> result = SPF1Utils.TEMP_ERROR;
-<a name="111" href="#111">111</a> } <strong>catch</strong> (IllegalStateException e) {
-<a name="112" href="#112">112</a> <em class="comment">// this should never happen at all. But anyway we will set the</em>
-<a name="113" href="#113">113</a> <em class="comment">// result to neutral. Safety first ..</em>
-<a name="114" href="#114">114</a> log.error(e.getMessage(),e);
-<a name="115" href="#115">115</a> result = SPF1Constants.NEUTRAL;
-<a name="116" href="#116">116</a> }
-<a name="117" href="#117">117</a>
-<a name="118" href="#118">118</a> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a> ret = <strong>new</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a>(result, resultChar, explanation, spfData);
-<a name="119" href="#119">119</a>
-<a name="120" href="#120">120</a> log.info(<span class="string">"[ipAddress="</span> + ipAddress + <span class="string">"] [mailFrom="</span> + mailFrom
-<a name="121" href="#121">121</a> + <span class="string">"] [helo="</span> + hostName + <span class="string">"] => "</span> + ret.getResult());
+<a name="110" href="#110">110</a> result = SPF1Utils.NONE_CONV;
+<a name="111" href="#111">111</a> } <strong>catch</strong> (NeutralException e) {
+<a name="112" href="#112">112</a> result = SPF1Utils.NEUTRAL_CONV;
+<a name="113" href="#113">113</a> } <strong>catch</strong> (TempErrorException e) {
+<a name="114" href="#114">114</a> log.warn(e.getMessage(),e);
+<a name="115" href="#115">115</a> result = SPF1Utils.TEMP_ERROR_CONV;
+<a name="116" href="#116">116</a> } <strong>catch</strong> (IllegalStateException e) {
+<a name="117" href="#117">117</a> <em class="comment">// this should never happen at all. But anyway we will set the</em>
+<a name="118" href="#118">118</a> <em class="comment">// result to neutral. Safety first ..</em>
+<a name="119" href="#119">119</a> log.error(e.getMessage(),e);
+<a name="120" href="#120">120</a> result = SPF1Constants.NEUTRAL;
+<a name="121" href="#121">121</a> }
<a name="122" href="#122">122</a>
-<a name="123" href="#123">123</a> <strong>return</strong> ret;
-<a name="124" href="#124">124</a>
-<a name="125" href="#125">125</a> }
-<a name="126" href="#126">126</a>
-<a name="127" href="#127">127</a> <em>/**<em>*</em></em>
-<a name="128" href="#128">128</a> <em> * Run check for SPF with the given values.</em>
-<a name="129" href="#129">129</a> <em> * </em>
-<a name="130" href="#130">130</a> <em> * @param spfData</em>
-<a name="131" href="#131">131</a> <em> * The SPF1Data which should be used to run the check</em>
-<a name="132" href="#132">132</a> <em> * @throws PermErrorException</em>
-<a name="133" href="#133">133</a> <em> * Get thrown if an error was detected</em>
-<a name="134" href="#134">134</a> <em> * @throws NoneException</em>
-<a name="135" href="#135">135</a> <em> * Get thrown if no Record was found</em>
-<a name="136" href="#136">136</a> <em> * @throws TempErrorException</em>
-<a name="137" href="#137">137</a> <em> * Get thrown if a DNS problem was detected</em>
-<a name="138" href="#138">138</a> <em> */</em>
-<a name="139" href="#139">139</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> checkSPF(SPF1Data spfData) throws PermErrorException,
-<a name="140" href="#140">140</a> NoneException, <a href="../../../../org/apache/james/jspf/exceptions/TempErrorException.html">TempErrorException</a> {
-<a name="141" href="#141">141</a> String result = SPF1Constants.NEUTRAL;
-<a name="142" href="#142">142</a> String explanation = <strong>null</strong>;
-<a name="143" href="#143">143</a>
-<a name="144" href="#144">144</a> <em>/**<em>*</em></em>
-<a name="145" href="#145">145</a> <em> * Check if the connection was made from localhost. Set the result to</em>
-<a name="146" href="#146">146</a> <em> * PASS if its from localhost.</em>
-<a name="147" href="#147">147</a> <em> */</em>
-<a name="148" href="#148">148</a> <strong>if</strong> (spfData.getIpAddress().trim().startsWith(<span class="string">"127."</span>)) {
-<a name="149" href="#149">149</a> <em class="comment">// logging</em>
-<a name="150" href="#150">150</a> log.info(<span class="string">"Connection was made from localhost => skip checking"</span>);
-<a name="151" href="#151">151</a>
-<a name="152" href="#152">152</a> result = SPF1Constants.PASS;
-<a name="153" href="#153">153</a> <strong>return</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a>(result, explanation);
-<a name="154" href="#154">154</a> }
-<a name="155" href="#155">155</a>
-<a name="156" href="#156">156</a> <em class="comment">// Get the raw dns txt entry which contains a spf entry</em>
-<a name="157" href="#157">157</a> String spfDnsEntry = dnsProbe.getSpfRecord(spfData.getCurrentDomain(),
-<a name="158" href="#158">158</a> SPF1Constants.SPF_VERSION);
+<a name="123" href="#123">123</a> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a> ret = <strong>new</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a>(result, resultChar, explanation, spfData);
+<a name="124" href="#124">124</a>
+<a name="125" href="#125">125</a> log.info(<span class="string">"[ipAddress="</span> + ipAddress + <span class="string">"] [mailFrom="</span> + mailFrom
+<a name="126" href="#126">126</a> + <span class="string">"] [helo="</span> + hostName + <span class="string">"] => "</span> + ret.getResult());
+<a name="127" href="#127">127</a>
+<a name="128" href="#128">128</a> <strong>return</strong> ret;
+<a name="129" href="#129">129</a>
+<a name="130" href="#130">130</a> }
+<a name="131" href="#131">131</a>
+<a name="132" href="#132">132</a> <em>/**<em>*</em></em>
+<a name="133" href="#133">133</a> <em> * Run check for SPF with the given values.</em>
+<a name="134" href="#134">134</a> <em> * </em>
+<a name="135" href="#135">135</a> <em> * @param spfData</em>
+<a name="136" href="#136">136</a> <em> * The SPF1Data which should be used to run the check</em>
+<a name="137" href="#137">137</a> <em> * @return result </em>
+<a name="138" href="#138">138</a> <em> * The SPFInternalResult </em>
+<a name="139" href="#139">139</a> <em> * @throws PermErrorException</em>
+<a name="140" href="#140">140</a> <em> * Get thrown if an error was detected</em>
+<a name="141" href="#141">141</a> <em> * @throws NoneException</em>
+<a name="142" href="#142">142</a> <em> * Get thrown if no Record was found</em>
+<a name="143" href="#143">143</a> <em> * @throws TempErrorException</em>
+<a name="144" href="#144">144</a> <em> * Get thrown if a DNS problem was detected</em>
+<a name="145" href="#145">145</a> <em> * @throws NeutralException </em>
+<a name="146" href="#146">146</a> <em> * Get thrown if the result should be neutral</em>
+<a name="147" href="#147">147</a> <em> */</em>
+<a name="148" href="#148">148</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> checkSPF(SPF1Data spfData) throws PermErrorException,
+<a name="149" href="#149">149</a> NoneException, TempErrorException, <a href="../../../../org/apache/james/jspf/exceptions/NeutralException.html">NeutralException</a> {
+<a name="150" href="#150">150</a> String result = SPF1Constants.NEUTRAL;
+<a name="151" href="#151">151</a> String explanation = <strong>null</strong>;
+<a name="152" href="#152">152</a>
+<a name="153" href="#153">153</a> <em class="comment">// Get the raw dns txt entry which contains a spf entry</em>
+<a name="154" href="#154">154</a> String spfDnsEntry = dnsProbe.getSpfRecord(spfData.getCurrentDomain(),
+<a name="155" href="#155">155</a> SPF1Constants.SPF_VERSION);
+<a name="156" href="#156">156</a>
+<a name="157" href="#157">157</a> <em class="comment">// logging</em>
+<a name="158" href="#158">158</a> log.debug(<span class="string">"Start parsing SPF-Record:"</span> + spfDnsEntry);
<a name="159" href="#159">159</a>
-<a name="160" href="#160">160</a> <em class="comment">// logging</em>
-<a name="161" href="#161">161</a> log.debug(<span class="string">"Start parsing SPF-Record:"</span> + spfDnsEntry);
-<a name="162" href="#162">162</a>
-<a name="163" href="#163">163</a> SPF1Record spfRecord = parser.parse(spfDnsEntry);
+<a name="160" href="#160">160</a> SPF1Record spfRecord = parser.parse(spfDnsEntry);
+<a name="161" href="#161">161</a>
+<a name="162" href="#162">162</a> String qualifier = <strong>null</strong>;
+<a name="163" href="#163">163</a> <strong>boolean</strong> hasCommand = false;
<a name="164" href="#164">164</a>
-<a name="165" href="#165">165</a> <em class="comment">// System.out.println(spfRecord);</em>
-<a name="166" href="#166">166</a>
-<a name="167" href="#167">167</a> String qualifier = <strong>null</strong>;
-<a name="168" href="#168">168</a> <strong>boolean</strong> hasCommand = false;
-<a name="169" href="#169">169</a>
-<a name="170" href="#170">170</a> <em class="comment">// get all commands</em>
-<a name="171" href="#171">171</a> Iterator com = spfRecord.getDirectives().iterator();
-<a name="172" href="#172">172</a> <strong>while</strong> (com.hasNext()) {
-<a name="173" href="#173">173</a>
-<a name="174" href="#174">174</a> <em class="comment">// if we reach maximum calls we must throw a PermErrorException. See</em>
-<a name="175" href="#175">175</a> <em class="comment">// SPF-RFC Section 10.1. Processing Limits</em>
-<a name="176" href="#176">176</a> <strong>if</strong> (spfData.getCurrentDepth() > spfData.getMaxDepth()) {
-<a name="177" href="#177">177</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/exceptions/PermErrorException.html">PermErrorException</a>(
-<a name="178" href="#178">178</a> <span class="string">"Maximum mechanism/modifier calls done: "</span>
-<a name="179" href="#179">179</a> + spfData.getCurrentDepth());
-<a name="180" href="#180">180</a> }
-<a name="181" href="#181">181</a>
-<a name="182" href="#182">182</a> hasCommand = <strong>true</strong>;
-<a name="183" href="#183">183</a> <a href="../../../../org/apache/james/jspf/core/Directive.html">Directive</a> d = (Directive) com.next();
-<a name="184" href="#184">184</a>
-<a name="185" href="#185">185</a> <em class="comment">// logging</em>
-<a name="186" href="#186">186</a> log.debug(<span class="string">"Processing directive: "</span> + d.getQualifier()
-<a name="187" href="#187">187</a> + d.getMechanism().toString());
-<a name="188" href="#188">188</a>
-<a name="189" href="#189">189</a> qualifier = d.run(spfData);
-<a name="190" href="#190">190</a>
-<a name="191" href="#191">191</a> <em class="comment">// logging</em>
-<a name="192" href="#192">192</a> log.debug(<span class="string">"Processed directive: "</span> + d.getQualifier()
-<a name="193" href="#193">193</a> + d.getMechanism().toString() + <span class="string">" returned "</span> + qualifier);
-<a name="194" href="#194">194</a>
-<a name="195" href="#195">195</a> <strong>if</strong> (qual<strong>if</strong>ier != <strong>null</strong>) {
-<a name="196" href="#196">196</a> <strong>if</strong> (qual<strong>if</strong>ier.equals(<span class="string">""</span>)) {
-<a name="197" href="#197">197</a> result = SPF1Constants.PASS;
-<a name="198" href="#198">198</a> } <strong>else</strong> {
-<a name="199" href="#199">199</a> result = qualifier;
-<a name="200" href="#200">200</a> }
-<a name="201" href="#201">201</a>
-<a name="202" href="#202">202</a> spfData.setCurrentResult(result);
-<a name="203" href="#203">203</a> spfData.setMatch(<strong>true</strong>);
+<a name="165" href="#165">165</a> <em class="comment">// get all commands</em>
+<a name="166" href="#166">166</a> Iterator com = spfRecord.getDirectives().iterator();
+<a name="167" href="#167">167</a> <strong>while</strong> (com.hasNext()) {
+<a name="168" href="#168">168</a>
+<a name="169" href="#169">169</a> <em class="comment">// if we reach maximum calls we must throw a PermErrorException. See</em>
+<a name="170" href="#170">170</a> <em class="comment">// SPF-RFC Section 10.1. Processing Limits</em>
+<a name="171" href="#171">171</a> <strong>if</strong> (spfData.getCurrentDepth() > spfData.getMaxDepth()) {
+<a name="172" href="#172">172</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/exceptions/PermErrorException.html">PermErrorException</a>(
+<a name="173" href="#173">173</a> <span class="string">"Maximum mechanism/modifier calls done: "</span>
+<a name="174" href="#174">174</a> + spfData.getCurrentDepth());
+<a name="175" href="#175">175</a> }
+<a name="176" href="#176">176</a>
+<a name="177" href="#177">177</a> hasCommand = <strong>true</strong>;
+<a name="178" href="#178">178</a> <a href="../../../../org/apache/james/jspf/core/Directive.html">Directive</a> d = (Directive) com.next();
+<a name="179" href="#179">179</a>
+<a name="180" href="#180">180</a> <em class="comment">// logging</em>
+<a name="181" href="#181">181</a> log.debug(<span class="string">"Processing directive: "</span> + d.getQualifier()
+<a name="182" href="#182">182</a> + d.getMechanism().toString());
+<a name="183" href="#183">183</a>
+<a name="184" href="#184">184</a> qualifier = d.run(spfData);
+<a name="185" href="#185">185</a>
+<a name="186" href="#186">186</a> <em class="comment">// logging</em>
+<a name="187" href="#187">187</a> log.debug(<span class="string">"Processed directive: "</span> + d.getQualifier()
+<a name="188" href="#188">188</a> + d.getMechanism().toString() + <span class="string">" returned "</span> + qualifier);
+<a name="189" href="#189">189</a>
+<a name="190" href="#190">190</a> <strong>if</strong> (qual<strong>if</strong>ier != <strong>null</strong>) {
+<a name="191" href="#191">191</a> <strong>if</strong> (qual<strong>if</strong>ier.equals(<span class="string">""</span>)) {
+<a name="192" href="#192">192</a> result = SPF1Constants.PASS;
+<a name="193" href="#193">193</a> } <strong>else</strong> {
+<a name="194" href="#194">194</a> result = qualifier;
+<a name="195" href="#195">195</a> }
+<a name="196" href="#196">196</a>
+<a name="197" href="#197">197</a> spfData.setCurrentResult(result);
+<a name="198" href="#198">198</a> spfData.setMatch(<strong>true</strong>);
+<a name="199" href="#199">199</a>
+<a name="200" href="#200">200</a> <em class="comment">// If we have a match we should break the while loop</em>
+<a name="201" href="#201">201</a> <strong>break</strong>;
+<a name="202" href="#202">202</a> }
+<a name="203" href="#203">203</a> }
<a name="204" href="#204">204</a>
-<a name="205" href="#205">205</a> <em class="comment">// If we have a match we should break the while loop</em>
-<a name="206" href="#206">206</a> <strong>break</strong>;
-<a name="207" href="#207">207</a> }
-<a name="208" href="#208">208</a> }
-<a name="209" href="#209">209</a>
-<a name="210" href="#210">210</a> Iterator mod = spfRecord.getModifiers().iterator();
-<a name="211" href="#211">211</a> <strong>while</strong> (mod.hasNext()) {
-<a name="212" href="#212">212</a> spfData.setCurrentDepth(spfData.getCurrentDepth() + 1);
-<a name="213" href="#213">213</a>
-<a name="214" href="#214">214</a> <em class="comment">// if we reach maximum calls we must throw a PermErrorException. See</em>
-<a name="215" href="#215">215</a> <em class="comment">// SPF-RFC Section 10.1. Processing Limits</em>
-<a name="216" href="#216">216</a> <strong>if</strong> (spfData.getCurrentDepth() > spfData.getMaxDepth()) {
-<a name="217" href="#217">217</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/exceptions/PermErrorException.html">PermErrorException</a>(
-<a name="218" href="#218">218</a> <span class="string">"Maximum mechanism/modifiers calls done: "</span>
-<a name="219" href="#219">219</a> + spfData.getCurrentDepth());
-<a name="220" href="#220">220</a> }
-<a name="221" href="#221">221</a>
-<a name="222" href="#222">222</a> <a href="../../../../org/apache/james/jspf/core/Modifier.html">Modifier</a> m = (Modifier) mod.next();
-<a name="223" href="#223">223</a>
-<a name="224" href="#224">224</a> log.debug(<span class="string">"Processing modifier: "</span> + m.toString());
+<a name="205" href="#205">205</a> Iterator mod = spfRecord.getModifiers().iterator();
+<a name="206" href="#206">206</a> <strong>while</strong> (mod.hasNext()) {
+<a name="207" href="#207">207</a> spfData.setCurrentDepth(spfData.getCurrentDepth() + 1);
+<a name="208" href="#208">208</a>
+<a name="209" href="#209">209</a> <em class="comment">// if we reach maximum calls we must throw a PermErrorException. See</em>
+<a name="210" href="#210">210</a> <em class="comment">// SPF-RFC Section 10.1. Processing Limits</em>
+<a name="211" href="#211">211</a> <strong>if</strong> (spfData.getCurrentDepth() > spfData.getMaxDepth()) {
+<a name="212" href="#212">212</a> <strong>throw</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/exceptions/PermErrorException.html">PermErrorException</a>(
+<a name="213" href="#213">213</a> <span class="string">"Maximum mechanism/modifiers calls done: "</span>
+<a name="214" href="#214">214</a> + spfData.getCurrentDepth());
+<a name="215" href="#215">215</a> }
+<a name="216" href="#216">216</a>
+<a name="217" href="#217">217</a> <a href="../../../../org/apache/james/jspf/core/Modifier.html">Modifier</a> m = (Modifier) mod.next();
+<a name="218" href="#218">218</a>
+<a name="219" href="#219">219</a> log.debug(<span class="string">"Processing modifier: "</span> + m.toString());
+<a name="220" href="#220">220</a>
+<a name="221" href="#221">221</a> String q = m.run(spfData);
+<a name="222" href="#222">222</a>
+<a name="223" href="#223">223</a> log.debug(<span class="string">"Processed modifier: "</span> + m.toString() + <span class="string">" resulted in "</span>
+<a name="224" href="#224">224</a> + q);
<a name="225" href="#225">225</a>
-<a name="226" href="#226">226</a> String q = m.run(spfData);
-<a name="227" href="#227">227</a>
-<a name="228" href="#228">228</a> log.debug(<span class="string">"Processed modifier: "</span> + m.toString() + <span class="string">" resulted in "</span>
-<a name="229" href="#229">229</a> + q);
-<a name="230" href="#230">230</a>
-<a name="231" href="#231">231</a> <strong>if</strong> (q != <strong>null</strong>) {
-<a name="232" href="#232">232</a> qualifier = q;
-<a name="233" href="#233">233</a> }
-<a name="234" href="#234">234</a>
-<a name="235" href="#235">235</a> <strong>if</strong> (qual<strong>if</strong>ier != <strong>null</strong>) {
-<a name="236" href="#236">236</a> result = qualifier;
+<a name="226" href="#226">226</a> <strong>if</strong> (q != <strong>null</strong>) {
+<a name="227" href="#227">227</a> qualifier = q;
+<a name="228" href="#228">228</a> }
+<a name="229" href="#229">229</a>
+<a name="230" href="#230">230</a> <strong>if</strong> (qual<strong>if</strong>ier != <strong>null</strong>) {
+<a name="231" href="#231">231</a> result = qualifier;
+<a name="232" href="#232">232</a>
+<a name="233" href="#233">233</a> spfData.setCurrentResult(result);
+<a name="234" href="#234">234</a> spfData.setMatch(<strong>true</strong>);
+<a name="235" href="#235">235</a> }
+<a name="236" href="#236">236</a> }
<a name="237" href="#237">237</a>
-<a name="238" href="#238">238</a> spfData.setCurrentResult(result);
-<a name="239" href="#239">239</a> spfData.setMatch(<strong>true</strong>);
-<a name="240" href="#240">240</a> }
-<a name="241" href="#241">241</a> }
-<a name="242" href="#242">242</a>
-<a name="243" href="#243">243</a> <em class="comment">// If no match was found set the result to neutral</em>
-<a name="244" href="#244">244</a> <strong>if</strong> (!spfData.isMatch() && (hasCommand == <strong>true</strong>)) {
-<a name="245" href="#245">245</a> result = SPF1Constants.NEUTRAL;
-<a name="246" href="#246">246</a> }
-<a name="247" href="#247">247</a>
-<a name="248" href="#248">248</a> <strong>if</strong> (result.equals(SPF1Constants.FAIL)) {
-<a name="249" href="#249">249</a> <strong>if</strong> (spfData.getExplanation()==<strong>null</strong> || spfData.getExplanation().equals(<span class="string">""</span>)) {
-<a name="250" href="#250">250</a> <strong>try</strong> {
-<a name="251" href="#251">251</a> spfData.setExplanation(<strong>new</strong> <a href="../../../../org/apache/james/jspf/macro/MacroExpand.html">MacroExpand</a>(spfData, log)
-<a name="252" href="#252">252</a> .expandExplanation(SPF1Utils.DEFAULT_EXPLANATION));
-<a name="253" href="#253">253</a> } <strong>catch</strong> (PermErrorException e) {}
-<a name="254" href="#254">254</a> }
-<a name="255" href="#255">255</a> explanation = spfData.getExplanation();
-<a name="256" href="#256">256</a> }
-<a name="257" href="#257">257</a>
-<a name="258" href="#258">258</a> <strong>return</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a>(result, explanation);
-<a name="259" href="#259">259</a> }
-<a name="260" href="#260">260</a>
-<a name="261" href="#261">261</a> <em>/**<em>*</em></em>
-<a name="262" href="#262">262</a> <em> * Set the amount of time (in seconds) before an TermError is returned when</em>
-<a name="263" href="#263">263</a> <em> * the dnsserver not answer. Default is 20 seconds.</em>
-<a name="264" href="#264">264</a> <em> * </em>
-<a name="265" href="#265">265</a> <em> * TempError should be returned</em>
-<a name="266" href="#266">266</a> <em> * </em>
-<a name="267" href="#267">267</a> <em> * @param timeOut</em>
-<a name="268" href="#268">268</a> <em> * The timout in seconds</em>
-<a name="269" href="#269">269</a> <em> */</em>
-<a name="270" href="#270">270</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> setTimeOut(<strong>int</strong> timeOut) {
-<a name="271" href="#271">271</a> log.debug(<span class="string">"TimeOut was set to: "</span> + timeOut);
-<a name="272" href="#272">272</a> dnsProbe.setTimeOut(timeOut);
-<a name="273" href="#273">273</a> }
-<a name="274" href="#274">274</a> }
+<a name="238" href="#238">238</a> <em class="comment">// If no match was found set the result to neutral</em>
+<a name="239" href="#239">239</a> <strong>if</strong> (!spfData.isMatch() && (hasCommand == <strong>true</strong>)) {
+<a name="240" href="#240">240</a> result = SPF1Constants.NEUTRAL;
+<a name="241" href="#241">241</a> }
+<a name="242" href="#242">242</a>
+<a name="243" href="#243">243</a> <strong>if</strong> (result.equals(SPF1Constants.FAIL)) {
+<a name="244" href="#244">244</a> <strong>if</strong> (spfData.getExplanation()==<strong>null</strong> || spfData.getExplanation().equals(<span class="string">""</span>)) {
+<a name="245" href="#245">245</a> <strong>try</strong> {
+<a name="246" href="#246">246</a> spfData.setExplanation(<strong>new</strong> <a href="../../../../org/apache/james/jspf/macro/MacroExpand.html">MacroExpand</a>(spfData, log)
+<a name="247" href="#247">247</a> .expandExplanation(SPF1Utils.DEFAULT_EXPLANATION));
+<a name="248" href="#248">248</a> } <strong>catch</strong> (PermErrorException e) {}
+<a name="249" href="#249">249</a> }
+<a name="250" href="#250">250</a> explanation = spfData.getExplanation();
+<a name="251" href="#251">251</a> }
+<a name="252" href="#252">252</a>
+<a name="253" href="#253">253</a> <strong>return</strong> <strong>new</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a>(result, explanation);
+<a name="254" href="#254">254</a> }
+<a name="255" href="#255">255</a>
+<a name="256" href="#256">256</a> <em>/**<em>*</em></em>
+<a name="257" href="#257">257</a> <em> * Set the amount of time (in seconds) before an TermError is returned when</em>
+<a name="258" href="#258">258</a> <em> * the dnsserver not answer. Default is 20 seconds.</em>
+<a name="259" href="#259">259</a> <em> * </em>
+<a name="260" href="#260">260</a> <em> * @param timeOut The timout in seconds</em>
+<a name="261" href="#261">261</a> <em> */</em>
+<a name="262" href="#262">262</a> <strong>public</strong> <strong>synchronized</strong> <strong>void</strong> setTimeOut(<strong>int</strong> timeOut) {
+<a name="263" href="#263">263</a> log.debug(<span class="string">"TimeOut was set to: "</span> + timeOut);
+<a name="264" href="#264">264</a> dnsProbe.setTimeOut(timeOut);
+<a name="265" href="#265">265</a> }
+<a name="266" href="#266">266</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/jspf/xref/org/apache/james/jspf/SPF1Utils.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF1Utils.html?view=diff&rev=449415&r1=449414&r2=449415
==============================================================================
--- james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF1Utils.html (original)
+++ james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPF1Utils.html Sun Sep 24 08:35:04 2006
@@ -39,103 +39,95 @@
<a name="30" href="#30">30</a> <em> */</em>
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <strong>public</strong> <strong>class</strong> SPF1Utils {
-<a name="33" href="#33">33</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PERM_ERROR = <span class="string">"error"</span>;
-<a name="34" href="#34">34</a>
-<a name="35" href="#35">35</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PERM_ERROR_CONV = <span class="string">"error"</span>;
-<a name="36" href="#36">36</a>
-<a name="37" href="#37">37</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NONE = <span class="string">"none"</span>;
-<a name="38" href="#38">38</a>
-<a name="39" href="#39">39</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NONE_CONV = <span class="string">"none"</span>;
-<a name="40" href="#40">40</a>
-<a name="41" href="#41">41</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String TEMP_ERROR = <span class="string">"temperror"</span>;
-<a name="42" href="#42">42</a>
-<a name="43" href="#43">43</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String TEMP_ERROR_CONV = <span class="string">"temperror"</span>;
-<a name="44" href="#44">44</a>
-<a name="45" href="#45">45</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PASS_CONV = <span class="string">"pass"</span>;
-<a name="46" href="#46">46</a>
-<a name="47" href="#47">47</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NEUTRAL_CONV = <span class="string">"neutral"</span>;
-<a name="48" href="#48">48</a>
-<a name="49" href="#49">49</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String FAIL_CONV = <span class="string">"fail"</span>;
-<a name="50" href="#50">50</a>
-<a name="51" href="#51">51</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String SOFTFAIL_CONV = <span class="string">"softfail"</span>;
-<a name="52" href="#52">52</a>
-<a name="53" href="#53">53</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String DEFAULT_EXPLANATION = <span class="string">"http://www.openspf.org/why.html?sender=%{S}&ip=%{I}"</span>;
-<a name="54" href="#54">54</a>
-<a name="55" href="#55">55</a> <em>/**<em>*</em></em>
-<a name="56" href="#56">56</a> <em> * Convert raw SPF results to SPF names</em>
-<a name="57" href="#57">57</a> <em> * </em>
-<a name="58" href="#58">58</a> <em> * @param result</em>
-<a name="59" href="#59">59</a> <em> * The result which should converted</em>
-<a name="60" href="#60">60</a> <em> * @return coverted result</em>
-<a name="61" href="#61">61</a> <em> */</em>
-<a name="62" href="#62">62</a> <strong>protected</strong> <strong>static</strong> String resultToName(String result) {
-<a name="63" href="#63">63</a>
-<a name="64" href="#64">64</a> <strong>if</strong> (result.equals(SPF1Constants.PASS)) {
-<a name="65" href="#65">65</a> <strong>return</strong> PASS_CONV;
-<a name="66" href="#66">66</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Constants.FAIL)) {
-<a name="67" href="#67">67</a> <strong>return</strong> FAIL_CONV;
-<a name="68" href="#68">68</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Constants.NEUTRAL)) {
-<a name="69" href="#69">69</a> <strong>return</strong> NEUTRAL_CONV;
-<a name="70" href="#70">70</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Constants.SOFTFAIL)) {
-<a name="71" href="#71">71</a> <strong>return</strong> SOFTFAIL_CONV;
-<a name="72" href="#72">72</a> } <strong>else</strong> <strong>if</strong> (result.equals(PERM_ERROR)) {
-<a name="73" href="#73">73</a> <strong>return</strong> PERM_ERROR_CONV;
-<a name="74" href="#74">74</a> } <strong>else</strong> <strong>if</strong> (result.equals(TEMP_ERROR)) {
-<a name="75" href="#75">75</a> <strong>return</strong> TEMP_ERROR_CONV;
-<a name="76" href="#76">76</a> } <strong>else</strong> <strong>if</strong> (result.equals(NONE)) {
-<a name="77" href="#77">77</a> <strong>return</strong> NONE_CONV;
-<a name="78" href="#78">78</a> } <strong>else</strong> {
-<a name="79" href="#79">79</a> <strong>return</strong> NEUTRAL_CONV;
-<a name="80" href="#80">80</a> }
-<a name="81" href="#81">81</a>
-<a name="82" href="#82">82</a> }
-<a name="83" href="#83">83</a>
-<a name="84" href="#84">84</a> <em>/**<em>*</em></em>
-<a name="85" href="#85">85</a> <em> * Covert SPF names to raw SPF results</em>
-<a name="86" href="#86">86</a> <em> * </em>
-<a name="87" href="#87">87</a> <em> * @param result</em>
-<a name="88" href="#88">88</a> <em> * The result which should converted</em>
-<a name="89" href="#89">89</a> <em> * @return coverted result</em>
-<a name="90" href="#90">90</a> <em> */</em>
-<a name="91" href="#91">91</a> <strong>protected</strong> <strong>static</strong> String nameToResult(String result) {
-<a name="92" href="#92">92</a>
-<a name="93" href="#93">93</a> <strong>if</strong> (result.equals(PASS_CONV)) {
-<a name="94" href="#94">94</a> <strong>return</strong> SPF1Constants.PASS;
-<a name="95" href="#95">95</a> } <strong>else</strong> <strong>if</strong> (result.equals(FAIL_CONV)) {
-<a name="96" href="#96">96</a> <strong>return</strong> SPF1Constants.FAIL;
-<a name="97" href="#97">97</a> } <strong>else</strong> <strong>if</strong> (result.equals(NEUTRAL_CONV)) {
-<a name="98" href="#98">98</a> <strong>return</strong> SPF1Constants.NEUTRAL;
-<a name="99" href="#99">99</a> } <strong>else</strong> <strong>if</strong> (result.equals(SOFTFAIL_CONV)) {
-<a name="100" href="#100">100</a> <strong>return</strong> SPF1Constants.SOFTFAIL;
-<a name="101" href="#101">101</a> } <strong>else</strong> <strong>if</strong> (result.equals(PERM_ERROR_CONV)) {
-<a name="102" href="#102">102</a> <strong>return</strong> PERM_ERROR;
-<a name="103" href="#103">103</a> } <strong>else</strong> <strong>if</strong> (result.equals(TEMP_ERROR_CONV)) {
-<a name="104" href="#104">104</a> <strong>return</strong> TEMP_ERROR;
-<a name="105" href="#105">105</a> } <strong>else</strong> <strong>if</strong> (result.equals(NONE_CONV)) {
-<a name="106" href="#106">106</a> <strong>return</strong> NONE;
-<a name="107" href="#107">107</a> } <strong>else</strong> {
-<a name="108" href="#108">108</a> <strong>return</strong> SPF1Constants.NEUTRAL;
-<a name="109" href="#109">109</a> }
-<a name="110" href="#110">110</a>
-<a name="111" href="#111">111</a> }
-<a name="112" href="#112">112</a>
-<a name="113" href="#113">113</a> <em>/**<em>*</em></em>
-<a name="114" href="#114">114</a> <em> * Check for valid FQDN</em>
-<a name="115" href="#115">115</a> <em> * </em>
-<a name="116" href="#116">116</a> <em> * @param host</em>
-<a name="117" href="#117">117</a> <em> * The hostname to check</em>
-<a name="118" href="#118">118</a> <em> * @return false or true</em>
-<a name="119" href="#119">119</a> <em> */</em>
-<a name="120" href="#120">120</a> <strong>public</strong> <strong>static</strong> <strong>boolean</strong> checkFQDN(String host) {
-<a name="121" href="#121">121</a> String regex = <span class="string">"(([a-zA-Z0-9//-])+//.)+([a-zA-Z]+)$"</span>;
-<a name="122" href="#122">122</a> <strong>if</strong> (host.matches(regex)) {
-<a name="123" href="#123">123</a> <strong>return</strong> <strong>true</strong>;
-<a name="124" href="#124">124</a> } <strong>else</strong> {
-<a name="125" href="#125">125</a> <strong>return</strong> false;
-<a name="126" href="#126">126</a> }
-<a name="127" href="#127">127</a> }
-<a name="128" href="#128">128</a>
-<a name="129" href="#129">129</a> }
+<a name="33" href="#33">33</a>
+<a name="34" href="#34">34</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PERM_ERROR_CONV = <span class="string">"error"</span>;
+<a name="35" href="#35">35</a>
+<a name="36" href="#36">36</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NONE_CONV = <span class="string">"none"</span>;
+<a name="37" href="#37">37</a>
+<a name="38" href="#38">38</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String TEMP_ERROR_CONV = <span class="string">"temperror"</span>;
+<a name="39" href="#39">39</a>
+<a name="40" href="#40">40</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String PASS_CONV = <span class="string">"pass"</span>;
+<a name="41" href="#41">41</a>
+<a name="42" href="#42">42</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String NEUTRAL_CONV = <span class="string">"neutral"</span>;
+<a name="43" href="#43">43</a>
+<a name="44" href="#44">44</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String FAIL_CONV = <span class="string">"fail"</span>;
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String SOFTFAIL_CONV = <span class="string">"softfail"</span>;
+<a name="47" href="#47">47</a>
+<a name="48" href="#48">48</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> String DEFAULT_EXPLANATION = <span class="string">"http://www.openspf.org/why.html?sender=%{S}&ip=%{I}"</span>;
+<a name="49" href="#49">49</a>
+<a name="50" href="#50">50</a> <em>/**<em>*</em></em>
+<a name="51" href="#51">51</a> <em> * Convert raw SPF results to SPF names</em>
+<a name="52" href="#52">52</a> <em> * </em>
+<a name="53" href="#53">53</a> <em> * @param result The result which should converted</em>
+<a name="54" href="#54">54</a> <em> * @return coverted result</em>
+<a name="55" href="#55">55</a> <em> */</em>
+<a name="56" href="#56">56</a> <strong>protected</strong> <strong>static</strong> String resultToName(String result) {
+<a name="57" href="#57">57</a>
+<a name="58" href="#58">58</a> <strong>if</strong> (result.equals(SPF1Constants.PASS)) {
+<a name="59" href="#59">59</a> <strong>return</strong> PASS_CONV;
+<a name="60" href="#60">60</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Constants.FAIL)) {
+<a name="61" href="#61">61</a> <strong>return</strong> FAIL_CONV;
+<a name="62" href="#62">62</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Constants.NEUTRAL)) {
+<a name="63" href="#63">63</a> <strong>return</strong> NEUTRAL_CONV;
+<a name="64" href="#64">64</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Constants.SOFTFAIL)) {
+<a name="65" href="#65">65</a> <strong>return</strong> SOFTFAIL_CONV;
+<a name="66" href="#66">66</a> } <strong>else</strong> <strong>if</strong> (result.equals(PERM_ERROR_CONV)) {
+<a name="67" href="#67">67</a> <strong>return</strong> PERM_ERROR_CONV;
+<a name="68" href="#68">68</a> } <strong>else</strong> <strong>if</strong> (result.equals(TEMP_ERROR_CONV)) {
+<a name="69" href="#69">69</a> <strong>return</strong> TEMP_ERROR_CONV;
+<a name="70" href="#70">70</a> } <strong>else</strong> <strong>if</strong> (result.equals(NONE_CONV)) {
+<a name="71" href="#71">71</a> <strong>return</strong> NONE_CONV;
+<a name="72" href="#72">72</a> } <strong>else</strong> {
+<a name="73" href="#73">73</a> <strong>return</strong> NEUTRAL_CONV;
+<a name="74" href="#74">74</a> }
+<a name="75" href="#75">75</a>
+<a name="76" href="#76">76</a> }
+<a name="77" href="#77">77</a>
+<a name="78" href="#78">78</a> <em>/**<em>*</em></em>
+<a name="79" href="#79">79</a> <em> * Covert SPF names to raw SPF results</em>
+<a name="80" href="#80">80</a> <em> * </em>
+<a name="81" href="#81">81</a> <em> * @param result The result which should converted</em>
+<a name="82" href="#82">82</a> <em> * @return coverted result</em>
+<a name="83" href="#83">83</a> <em> */</em>
+<a name="84" href="#84">84</a> <strong>protected</strong> <strong>static</strong> String nameToResult(String result) {
+<a name="85" href="#85">85</a>
+<a name="86" href="#86">86</a> <strong>if</strong> (result.equals(PASS_CONV)) {
+<a name="87" href="#87">87</a> <strong>return</strong> SPF1Constants.PASS;
+<a name="88" href="#88">88</a> } <strong>else</strong> <strong>if</strong> (result.equals(FAIL_CONV)) {
+<a name="89" href="#89">89</a> <strong>return</strong> SPF1Constants.FAIL;
+<a name="90" href="#90">90</a> } <strong>else</strong> <strong>if</strong> (result.equals(NEUTRAL_CONV)) {
+<a name="91" href="#91">91</a> <strong>return</strong> SPF1Constants.NEUTRAL;
+<a name="92" href="#92">92</a> } <strong>else</strong> <strong>if</strong> (result.equals(SOFTFAIL_CONV)) {
+<a name="93" href="#93">93</a> <strong>return</strong> SPF1Constants.SOFTFAIL;
+<a name="94" href="#94">94</a> } <strong>else</strong> <strong>if</strong> (result.equals(PERM_ERROR_CONV)) {
+<a name="95" href="#95">95</a> <strong>return</strong> PERM_ERROR_CONV;
+<a name="96" href="#96">96</a> } <strong>else</strong> <strong>if</strong> (result.equals(TEMP_ERROR_CONV)) {
+<a name="97" href="#97">97</a> <strong>return</strong> TEMP_ERROR_CONV;
+<a name="98" href="#98">98</a> } <strong>else</strong> <strong>if</strong> (result.equals(NONE_CONV)) {
+<a name="99" href="#99">99</a> <strong>return</strong> NONE_CONV;
+<a name="100" href="#100">100</a> } <strong>else</strong> {
+<a name="101" href="#101">101</a> <strong>return</strong> SPF1Constants.NEUTRAL;
+<a name="102" href="#102">102</a> }
+<a name="103" href="#103">103</a>
+<a name="104" href="#104">104</a> }
+<a name="105" href="#105">105</a>
+<a name="106" href="#106">106</a> <em>/**<em>*</em></em>
+<a name="107" href="#107">107</a> <em> * Check for valid FQDN</em>
+<a name="108" href="#108">108</a> <em> * </em>
+<a name="109" href="#109">109</a> <em> * @param host The hostname to check</em>
+<a name="110" href="#110">110</a> <em> * @return false or true</em>
+<a name="111" href="#111">111</a> <em> */</em>
+<a name="112" href="#112">112</a> <strong>public</strong> <strong>static</strong> <strong>boolean</strong> checkFQDN(String host) {
+<a name="113" href="#113">113</a> String regex = <span class="string">"(([a-zA-Z0-9//-])+//.)+([a-zA-Z]+)$"</span>;
+<a name="114" href="#114">114</a> <strong>if</strong> (host.matches(regex)) {
+<a name="115" href="#115">115</a> <strong>return</strong> <strong>true</strong>;
+<a name="116" href="#116">116</a> } <strong>else</strong> {
+<a name="117" href="#117">117</a> <strong>return</strong> false;
+<a name="118" href="#118">118</a> }
+<a name="119" href="#119">119</a> }
+<a name="120" href="#120">120</a>
+<a name="121" href="#121">121</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/jspf/xref/org/apache/james/jspf/SPFInternalResult.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPFInternalResult.html?view=diff&rev=449415&r1=449414&r2=449415
==============================================================================
--- james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPFInternalResult.html (original)
+++ james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPFInternalResult.html Sun Sep 24 08:35:04 2006
@@ -35,39 +35,44 @@
<a name="26" href="#26">26</a> <em> * This class is used to return the result of an SPF lookup.</em>
<a name="27" href="#27">27</a> <em> *</em>
<a name="28" href="#28">28</a> <em> */</em>
-<a name="29" href="#29">29</a>
-<a name="30" href="#30">30</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> {
-<a name="31" href="#31">31</a>
-<a name="32" href="#32">32</a> <strong>protected</strong> String explanation = <strong>null</strong>;
-<a name="33" href="#33">33</a>
-<a name="34" href="#34">34</a> <strong>private</strong> String resultChar = <strong>null</strong>;
-<a name="35" href="#35">35</a>
-<a name="36" href="#36">36</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a>(String resultChar, String explanation) {
-<a name="37" href="#37">37</a> <strong>this</strong>.resultChar = resultChar;
-<a name="38" href="#38">38</a> <strong>this</strong>.explanation = explanation;
-<a name="39" href="#39">39</a> }
-<a name="40" href="#40">40</a>
-<a name="41" href="#41">41</a> <em>/**<em>*</em></em>
-<a name="42" href="#42">42</a> <em> * Get the explanation. The explanation is only set if the result is "-" =</em>
-<a name="43" href="#43">43</a> <em> * fail</em>
-<a name="44" href="#44">44</a> <em> * </em>
-<a name="45" href="#45">45</a> <em> * @return explanation</em>
-<a name="46" href="#46">46</a> <em> */</em>
-<a name="47" href="#47">47</a> <strong>public</strong> String getExplanation() {
-<a name="48" href="#48">48</a> <strong>return</strong> explanation;
-<a name="49" href="#49">49</a> }
-<a name="50" href="#50">50</a>
-<a name="51" href="#51">51</a> <em>/**<em>*</em></em>
-<a name="52" href="#52">52</a> <em> * Get the result char "+-~?"</em>
-<a name="53" href="#53">53</a> <em> * </em>
-<a name="54" href="#54">54</a> <em> * @see SPF1Constants</em>
-<a name="55" href="#55">55</a> <em> * @return resultchar</em>
-<a name="56" href="#56">56</a> <em> */</em>
-<a name="57" href="#57">57</a> <strong>public</strong> String getResultChar() {
-<a name="58" href="#58">58</a> <strong>return</strong> resultChar != <strong>null</strong> ? resultChar : <span class="string">""</span>;
-<a name="59" href="#59">59</a> }
-<a name="60" href="#60">60</a>
-<a name="61" href="#61">61</a> }
+<a name="29" href="#29">29</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> {
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <strong>protected</strong> String explanation = <strong>null</strong>;
+<a name="32" href="#32">32</a>
+<a name="33" href="#33">33</a> <strong>private</strong> String resultChar = <strong>null</strong>;
+<a name="34" href="#34">34</a>
+<a name="35" href="#35">35</a> <em>/**<em>*</em></em>
+<a name="36" href="#36">36</a> <em> * Construct SPFInternalResult </em>
+<a name="37" href="#37">37</a> <em> * </em>
+<a name="38" href="#38">38</a> <em> * @param resultChar The result</em>
+<a name="39" href="#39">39</a> <em> * @param explanation The explanation</em>
+<a name="40" href="#40">40</a> <em> */</em>
+<a name="41" href="#41">41</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a>(String resultChar, String explanation) {
+<a name="42" href="#42">42</a> <strong>this</strong>.resultChar = resultChar;
+<a name="43" href="#43">43</a> <strong>this</strong>.explanation = explanation;
+<a name="44" href="#44">44</a> }
+<a name="45" href="#45">45</a>
+<a name="46" href="#46">46</a> <em>/**<em>*</em></em>
+<a name="47" href="#47">47</a> <em> * Get the explanation. The explanation is only set if the result is "-" =</em>
+<a name="48" href="#48">48</a> <em> * fail</em>
+<a name="49" href="#49">49</a> <em> * </em>
+<a name="50" href="#50">50</a> <em> * @return explanation</em>
+<a name="51" href="#51">51</a> <em> */</em>
+<a name="52" href="#52">52</a> <strong>public</strong> String getExplanation() {
+<a name="53" href="#53">53</a> <strong>return</strong> explanation;
+<a name="54" href="#54">54</a> }
+<a name="55" href="#55">55</a>
+<a name="56" href="#56">56</a> <em>/**<em>*</em></em>
+<a name="57" href="#57">57</a> <em> * Get the result char "+-~?"</em>
+<a name="58" href="#58">58</a> <em> * </em>
+<a name="59" href="#59">59</a> <em> * @see SPF1Constants</em>
+<a name="60" href="#60">60</a> <em> * @return resultchar</em>
+<a name="61" href="#61">61</a> <em> */</em>
+<a name="62" href="#62">62</a> <strong>public</strong> String getResultChar() {
+<a name="63" href="#63">63</a> <strong>return</strong> resultChar != <strong>null</strong> ? resultChar : <span class="string">""</span>;
+<a name="64" href="#64">64</a> }
+<a name="65" href="#65">65</a>
+<a name="66" href="#66">66</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/jspf/xref/org/apache/james/jspf/SPFResult.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPFResult.html?view=diff&rev=449415&r1=449414&r2=449415
==============================================================================
--- james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPFResult.html (original)
+++ james/site/trunk/www/jspf/xref/org/apache/james/jspf/SPFResult.html Sun Sep 24 08:35:04 2006
@@ -35,120 +35,126 @@
<a name="26" href="#26">26</a> <em> * This class is used to return the result of an SPF lookup.</em>
<a name="27" href="#27">27</a> <em> * </em>
<a name="28" href="#28">28</a> <em> */</em>
-<a name="29" href="#29">29</a>
-<a name="30" href="#30">30</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a> <strong>extends</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> {
-<a name="31" href="#31">31</a>
-<a name="32" href="#32">32</a> <strong>private</strong> String headerTextAsString = <span class="string">""</span>;
-<a name="33" href="#33">33</a>
-<a name="34" href="#34">34</a> <strong>private</strong> String headerName = <span class="string">"Received-SPF"</span>;
-<a name="35" href="#35">35</a>
-<a name="36" href="#36">36</a> <strong>private</strong> String result = <strong>null</strong>;
-<a name="37" href="#37">37</a>
-<a name="38" href="#38">38</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a>(String result, String resultChar, String explanation, SPF1Data spf1data) {
-<a name="39" href="#39">39</a> <strong>super</strong>(resultChar, explanation);
-<a name="40" href="#40">40</a> <strong>this</strong>.result = result;
-<a name="41" href="#41">41</a> <strong>this</strong>.headerTextAsString = generateHeader(result, spf1data);
-<a name="42" href="#42">42</a> }
-<a name="43" href="#43">43</a>
-<a name="44" href="#44">44</a> <em>/**<em>*</em></em>
-<a name="45" href="#45">45</a> <em> * Get the full SPF-Header (headername and headertext)</em>
-<a name="46" href="#46">46</a> <em> * </em>
-<a name="47" href="#47">47</a> <em> * @return SPF-Header</em>
-<a name="48" href="#48">48</a> <em> */</em>
-<a name="49" href="#49">49</a> <strong>public</strong> String getHeader() {
-<a name="50" href="#50">50</a> <strong>return</strong> headerName+<span class="string">": "</span>+getHeaderText();
-<a name="51" href="#51">51</a> }
-<a name="52" href="#52">52</a>
-<a name="53" href="#53">53</a> <em>/**<em>*</em></em>
-<a name="54" href="#54">54</a> <em> * Get the SPF-Headername</em>
-<a name="55" href="#55">55</a> <em> * </em>
-<a name="56" href="#56">56</a> <em> * @return headername</em>
-<a name="57" href="#57">57</a> <em> */</em>
-<a name="58" href="#58">58</a> <strong>public</strong> String getHeaderName() {
-<a name="59" href="#59">59</a> <strong>return</strong> headerName;
-<a name="60" href="#60">60</a> }
-<a name="61" href="#61">61</a>
-<a name="62" href="#62">62</a> <em>/**<em>*</em></em>
-<a name="63" href="#63">63</a> <em> * Get SPF-Headertext</em>
-<a name="64" href="#64">64</a> <em> * </em>
-<a name="65" href="#65">65</a> <em> * @return headertext</em>
-<a name="66" href="#66">66</a> <em> */</em>
-<a name="67" href="#67">67</a> <strong>public</strong> String getHeaderText() {
-<a name="68" href="#68">68</a> <strong>return</strong> headerTextAsString != <strong>null</strong> ? headerTextAsString : <span class="string">""</span>;
-<a name="69" href="#69">69</a> }
-<a name="70" href="#70">70</a>
-<a name="71" href="#71">71</a> <em>/**<em>*</em></em>
-<a name="72" href="#72">72</a> <em> * Generate a SPF-Result header</em>
-<a name="73" href="#73">73</a> <em> * </em>
-<a name="74" href="#74">74</a> <em> * @param result</em>
-<a name="75" href="#75">75</a> <em> * The result we should use to generate the header</em>
-<a name="76" href="#76">76</a> <em> */</em>
-<a name="77" href="#77">77</a> <strong>private</strong> String generateHeader(String result, SPF1Data spfData) {
-<a name="78" href="#78">78</a>
-<a name="79" href="#79">79</a> StringBuffer headerText = <strong>new</strong> StringBuffer();
-<a name="80" href="#80">80</a>
-<a name="81" href="#81">81</a> <strong>if</strong> (result.equals(SPF1Utils.PASS_CONV)) {
-<a name="82" href="#82">82</a> headerText.append(result + <span class="string">" (spfCheck: domain of "</span>
-<a name="83" href="#83">83</a> + spfData.getCurrentDomain() + <span class="string">" designates "</span>
-<a name="84" href="#84">84</a> + spfData.getIpAddress() + <span class="string">" as permitted sender) "</span>);
-<a name="85" href="#85">85</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.FAIL_CONV)) {
-<a name="86" href="#86">86</a> headerText.append(result + <span class="string">" (spfCheck: domain of "</span>
-<a name="87" href="#87">87</a> + spfData.getCurrentDomain() + <span class="string">" does not designate "</span>
-<a name="88" href="#88">88</a> + spfData.getIpAddress() + <span class="string">" as permitted sender) "</span>);
-<a name="89" href="#89">89</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.NEUTRAL_CONV)
-<a name="90" href="#90">90</a> || result.equals(SPF1Utils.NONE_CONV)) {
-<a name="91" href="#91">91</a> headerText.append(result + <span class="string">" (spfCheck: "</span> + spfData.getIpAddress()
-<a name="92" href="#92">92</a> + <span class="string">" is neither permitted nor denied by domain of "</span>
-<a name="93" href="#93">93</a> + spfData.getCurrentDomain() + <span class="string">") "</span>);
-<a name="94" href="#94">94</a>
-<a name="95" href="#95">95</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.SOFTFAIL_CONV)) {
-<a name="96" href="#96">96</a> headerText.append(result + <span class="string">" (spfCheck: transitioning domain of "</span>
-<a name="97" href="#97">97</a> + spfData.getCurrentDomain() + <span class="string">" does not designate "</span>
-<a name="98" href="#98">98</a> + spfData.getIpAddress() + <span class="string">" as permitted sender) "</span>);
-<a name="99" href="#99">99</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.PERM_ERROR_CONV)) {
-<a name="100" href="#100">100</a> headerText.append(result
-<a name="101" href="#101">101</a> + <span class="string">" (spfCheck: Error in processing SPF Record) "</span>);
-<a name="102" href="#102">102</a>
-<a name="103" href="#103">103</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.TEMP_ERROR_CONV)) {
-<a name="104" href="#104">104</a> headerText.append(result
-<a name="105" href="#105">105</a> + <span class="string">" (spfCheck: Error in retrieving data from DNS) "</span>);
-<a name="106" href="#106">106</a>
-<a name="107" href="#107">107</a> }
+<a name="29" href="#29">29</a> <strong>public</strong> <strong>class</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a> <strong>extends</strong> <a href="../../../../org/apache/james/jspf/SPFInternalResult.html">SPFInternalResult</a> {
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <strong>private</strong> String headerTextAsString = <span class="string">""</span>;
+<a name="32" href="#32">32</a>
+<a name="33" href="#33">33</a> <strong>private</strong> String headerName = <span class="string">"Received-SPF"</span>;
+<a name="34" href="#34">34</a>
+<a name="35" href="#35">35</a> <strong>private</strong> String result = <strong>null</strong>;
+<a name="36" href="#36">36</a>
+<a name="37" href="#37">37</a> <em>/**<em>*</em></em>
+<a name="38" href="#38">38</a> <em> * Construct SPFResult</em>
+<a name="39" href="#39">39</a> <em> * </em>
+<a name="40" href="#40">40</a> <em> * @param result the result </em>
+<a name="41" href="#41">41</a> <em> * @param resultChar the rawResult</em>
+<a name="42" href="#42">42</a> <em> * @param explanation the explanation</em>
+<a name="43" href="#43">43</a> <em> * @param spf1data the SPF1Data</em>
+<a name="44" href="#44">44</a> <em> */</em>
+<a name="45" href="#45">45</a> <strong>public</strong> <a href="../../../../org/apache/james/jspf/SPFResult.html">SPFResult</a>(String result, String resultChar, String explanation, SPF1Data spf1data) {
+<a name="46" href="#46">46</a> <strong>super</strong>(resultChar, explanation);
+<a name="47" href="#47">47</a> <strong>this</strong>.result = result;
+<a name="48" href="#48">48</a> <strong>this</strong>.headerTextAsString = generateHeader(result, spf1data);
+<a name="49" href="#49">49</a> }
+<a name="50" href="#50">50</a>
+<a name="51" href="#51">51</a> <em>/**<em>*</em></em>
+<a name="52" href="#52">52</a> <em> * Get the full SPF-Header (headername and headertext)</em>
+<a name="53" href="#53">53</a> <em> * </em>
+<a name="54" href="#54">54</a> <em> * @return SPF-Header</em>
+<a name="55" href="#55">55</a> <em> */</em>
+<a name="56" href="#56">56</a> <strong>public</strong> String getHeader() {
+<a name="57" href="#57">57</a> <strong>return</strong> headerName+<span class="string">": "</span>+getHeaderText();
+<a name="58" href="#58">58</a> }
+<a name="59" href="#59">59</a>
+<a name="60" href="#60">60</a> <em>/**<em>*</em></em>
+<a name="61" href="#61">61</a> <em> * Get the SPF-Headername</em>
+<a name="62" href="#62">62</a> <em> * </em>
+<a name="63" href="#63">63</a> <em> * @return headername</em>
+<a name="64" href="#64">64</a> <em> */</em>
+<a name="65" href="#65">65</a> <strong>public</strong> String getHeaderName() {
+<a name="66" href="#66">66</a> <strong>return</strong> headerName;
+<a name="67" href="#67">67</a> }
+<a name="68" href="#68">68</a>
+<a name="69" href="#69">69</a> <em>/**<em>*</em></em>
+<a name="70" href="#70">70</a> <em> * Get SPF-Headertext</em>
+<a name="71" href="#71">71</a> <em> * </em>
+<a name="72" href="#72">72</a> <em> * @return headertext</em>
+<a name="73" href="#73">73</a> <em> */</em>
+<a name="74" href="#74">74</a> <strong>public</strong> String getHeaderText() {
+<a name="75" href="#75">75</a> <strong>return</strong> headerTextAsString != <strong>null</strong> ? headerTextAsString : <span class="string">""</span>;
+<a name="76" href="#76">76</a> }
+<a name="77" href="#77">77</a>
+<a name="78" href="#78">78</a> <em>/**<em>*</em></em>
+<a name="79" href="#79">79</a> <em> * Generate a SPF-Result header</em>
+<a name="80" href="#80">80</a> <em> * </em>
+<a name="81" href="#81">81</a> <em> * @param result The result we should use to generate the header</em>
+<a name="82" href="#82">82</a> <em> */</em>
+<a name="83" href="#83">83</a> <strong>private</strong> String generateHeader(String result, SPF1Data spfData) {
+<a name="84" href="#84">84</a>
+<a name="85" href="#85">85</a> StringBuffer headerText = <strong>new</strong> StringBuffer();
+<a name="86" href="#86">86</a>
+<a name="87" href="#87">87</a> <strong>if</strong> (result.equals(SPF1Utils.PASS_CONV)) {
+<a name="88" href="#88">88</a> headerText.append(result + <span class="string">" (spfCheck: domain of "</span>
+<a name="89" href="#89">89</a> + spfData.getCurrentDomain() + <span class="string">" designates "</span>
+<a name="90" href="#90">90</a> + spfData.getIpAddress() + <span class="string">" as permitted sender) "</span>);
+<a name="91" href="#91">91</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.FAIL_CONV)) {
+<a name="92" href="#92">92</a> headerText.append(result + <span class="string">" (spfCheck: domain of "</span>
+<a name="93" href="#93">93</a> + spfData.getCurrentDomain() + <span class="string">" does not designate "</span>
+<a name="94" href="#94">94</a> + spfData.getIpAddress() + <span class="string">" as permitted sender) "</span>);
+<a name="95" href="#95">95</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.NEUTRAL_CONV)
+<a name="96" href="#96">96</a> || result.equals(SPF1Utils.NONE_CONV)) {
+<a name="97" href="#97">97</a> headerText.append(result + <span class="string">" (spfCheck: "</span> + spfData.getIpAddress()
+<a name="98" href="#98">98</a> + <span class="string">" is neither permitted nor denied by domain of "</span>
+<a name="99" href="#99">99</a> + spfData.getCurrentDomain() + <span class="string">") "</span>);
+<a name="100" href="#100">100</a>
+<a name="101" href="#101">101</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.SOFTFAIL_CONV)) {
+<a name="102" href="#102">102</a> headerText.append(result + <span class="string">" (spfCheck: transitioning domain of "</span>
+<a name="103" href="#103">103</a> + spfData.getCurrentDomain() + <span class="string">" does not designate "</span>
+<a name="104" href="#104">104</a> + spfData.getIpAddress() + <span class="string">" as permitted sender) "</span>);
+<a name="105" href="#105">105</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.PERM_ERROR_CONV)) {
+<a name="106" href="#106">106</a> headerText.append(result
+<a name="107" href="#107">107</a> + <span class="string">" (spfCheck: Error in processing SPF Record) "</span>);
<a name="108" href="#108">108</a>
-<a name="109" href="#109">109</a> String headerTextAsString;
-<a name="110" href="#110">110</a> <strong>if</strong> (headerText.length() > 0) {
-<a name="111" href="#111">111</a> headerText.append(<span class="string">"client-ip="</span> + spfData.getIpAddress()
-<a name="112" href="#112">112</a> + <span class="string">"; envelope-from="</span> + spfData.getMailFrom() + <span class="string">"; helo="</span>
-<a name="113" href="#113">113</a> + spfData.getHostName() + <span class="string">";"</span>);
-<a name="114" href="#114">114</a> headerTextAsString = headerText.toString();
-<a name="115" href="#115">115</a> } <strong>else</strong> {
-<a name="116" href="#116">116</a> headerTextAsString = <span class="string">""</span>;
-<a name="117" href="#117">117</a> }
-<a name="118" href="#118">118</a> <strong>return</strong> headerTextAsString;
-<a name="119" href="#119">119</a> }
-<a name="120" href="#120">120</a>
-<a name="121" href="#121">121</a> <em>/**<em>*</em></em>
-<a name="122" href="#122">122</a> <em> * Get the result string</em>
-<a name="123" href="#123">123</a> <em> * </em>
-<a name="124" href="#124">124</a> <em> * @see SPF1Utils</em>
-<a name="125" href="#125">125</a> <em> * @return result</em>
-<a name="126" href="#126">126</a> <em> */</em>
-<a name="127" href="#127">127</a> <strong>public</strong> String getResult() {
-<a name="128" href="#128">128</a> <strong>return</strong> result;
-<a name="129" href="#129">129</a> }
-<a name="130" href="#130">130</a>
-<a name="131" href="#131">131</a> <em>/**<em>*</em></em>
-<a name="132" href="#132">132</a> <em> * Get the explanation string</em>
-<a name="133" href="#133">133</a> <em> * If no explanation exists return the empty string</em>
-<a name="134" href="#134">134</a> <em> * </em>
-<a name="135" href="#135">135</a> <em> * @return explanation</em>
-<a name="136" href="#136">136</a> <em> */</em>
-<a name="137" href="#137">137</a> <strong>public</strong> String getExplanation() {
-<a name="138" href="#138">138</a> <strong>return</strong> explanation != <strong>null</strong> ? explanation : <span class="string">""</span>;
-<a name="139" href="#139">139</a> }
-<a name="140" href="#140">140</a>
-<a name="141" href="#141">141</a>
-<a name="142" href="#142">142</a> }
+<a name="109" href="#109">109</a> } <strong>else</strong> <strong>if</strong> (result.equals(SPF1Utils.TEMP_ERROR_CONV)) {
+<a name="110" href="#110">110</a> headerText.append(result
+<a name="111" href="#111">111</a> + <span class="string">" (spfCheck: Error in retrieving data from DNS) "</span>);
+<a name="112" href="#112">112</a>
+<a name="113" href="#113">113</a> }
+<a name="114" href="#114">114</a>
+<a name="115" href="#115">115</a> String headerTextAsString;
+<a name="116" href="#116">116</a> <strong>if</strong> (headerText.length() > 0) {
+<a name="117" href="#117">117</a> headerText.append(<span class="string">"client-ip="</span> + spfData.getIpAddress()
+<a name="118" href="#118">118</a> + <span class="string">"; envelope-from="</span> + spfData.getMailFrom() + <span class="string">"; helo="</span>
+<a name="119" href="#119">119</a> + spfData.getHostName() + <span class="string">";"</span>);
+<a name="120" href="#120">120</a> headerTextAsString = headerText.toString();
+<a name="121" href="#121">121</a> } <strong>else</strong> {
+<a name="122" href="#122">122</a> headerTextAsString = <span class="string">""</span>;
+<a name="123" href="#123">123</a> }
+<a name="124" href="#124">124</a> <strong>return</strong> headerTextAsString;
+<a name="125" href="#125">125</a> }
+<a name="126" href="#126">126</a>
+<a name="127" href="#127">127</a> <em>/**<em>*</em></em>
+<a name="128" href="#128">128</a> <em> * Get the result string</em>
+<a name="129" href="#129">129</a> <em> * </em>
+<a name="130" href="#130">130</a> <em> * @see SPF1Utils</em>
+<a name="131" href="#131">131</a> <em> * @return result</em>
+<a name="132" href="#132">132</a> <em> */</em>
+<a name="133" href="#133">133</a> <strong>public</strong> String getResult() {
+<a name="134" href="#134">134</a> <strong>return</strong> result;
+<a name="135" href="#135">135</a> }
+<a name="136" href="#136">136</a>
+<a name="137" href="#137">137</a> <em>/**<em>*</em></em>
+<a name="138" href="#138">138</a> <em> * Get the explanation string</em>
+<a name="139" href="#139">139</a> <em> * If no explanation exists return the empty string</em>
+<a name="140" href="#140">140</a> <em> * </em>
+<a name="141" href="#141">141</a> <em> * @return explanation</em>
+<a name="142" href="#142">142</a> <em> */</em>
+<a name="143" href="#143">143</a> <strong>public</strong> String getExplanation() {
+<a name="144" href="#144">144</a> <strong>return</strong> explanation != <strong>null</strong> ? explanation : <span class="string">""</span>;
+<a name="145" href="#145">145</a> }
+<a name="146" href="#146">146</a>
+<a name="147" href="#147">147</a>
+<a name="148" href="#148">148</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/jspf/xref/org/apache/james/jspf/core/Configurable.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/jspf/xref/org/apache/james/jspf/core/Configurable.html?view=diff&rev=449415&r1=449414&r2=449415
==============================================================================
--- james/site/trunk/www/jspf/xref/org/apache/james/jspf/core/Configurable.html (original)
+++ james/site/trunk/www/jspf/xref/org/apache/james/jspf/core/Configurable.html Sun Sep 24 08:35:04 2006
@@ -32,17 +32,20 @@
<a name="23" href="#23">23</a> <strong>import</strong> org.apache.james.jspf.exceptions.PermErrorException;
<a name="24" href="#24">24</a> <strong>import</strong> org.apache.james.jspf.util.ConfigurationMatch;
<a name="25" href="#25">25</a>
-<a name="26" href="#26">26</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/apache/james/jspf/core/Configurable.html">Configurable</a> {
-<a name="27" href="#27">27</a>
-<a name="28" href="#28">28</a> <em>/**<em>*</em></em>
-<a name="29" href="#29">29</a> <em> * Configuration</em>
-<a name="30" href="#30">30</a> <em> * </em>
-<a name="31" href="#31">31</a> <em> * @param params</em>
-<a name="32" href="#32">32</a> <em> * @throws PermErrorException</em>
-<a name="33" href="#33">33</a> <em> */</em>
-<a name="34" href="#34">34</a> <strong>void</strong> config(<a href="../../../../../org/apache/james/jspf/util/ConfigurationMatch.html">ConfigurationMatch</a> params) throws PermErrorException;
-<a name="35" href="#35">35</a>
-<a name="36" href="#36">36</a> }
+<a name="26" href="#26">26</a> <em>/**<em>*</em></em>
+<a name="27" href="#27">27</a> <em> * </em>
+<a name="28" href="#28">28</a> <em> */</em>
+<a name="29" href="#29">29</a> <strong>public</strong> <strong>interface</strong> <a href="../../../../../org/apache/james/jspf/core/Configurable.html">Configurable</a> {
+<a name="30" href="#30">30</a>
+<a name="31" href="#31">31</a> <em>/**<em>*</em></em>
+<a name="32" href="#32">32</a> <em> * Configuration</em>
+<a name="33" href="#33">33</a> <em> * </em>
+<a name="34" href="#34">34</a> <em> * @param params the ConfigurationMatch which should used</em>
+<a name="35" href="#35">35</a> <em> * @throws PermErrorException get thrown if a PermError should returned</em>
+<a name="36" href="#36">36</a> <em> */</em>
+<a name="37" href="#37">37</a> <strong>void</strong> config(<a href="../../../../../org/apache/james/jspf/util/ConfigurationMatch.html">ConfigurationMatch</a> params) throws PermErrorException;
+<a name="38" href="#38">38</a>
+<a name="39" href="#39">39</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>