| <!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>AbstractSimpleScriptedTestProtocol xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../../../../../protocol-tester/target/site/apidocs/org/apache/james/mpt/AbstractSimpleScriptedTestProtocol.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> <strong class="jxr_keyword">package</strong> org.apache.james.mpt; |
| <a name="21" href="#21">21</a> |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.InputStream; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Locale; |
| <a name="24" href="#24">24</a> |
| <a name="25" href="#25">25</a> |
| <a name="26" href="#26">26</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * A Protocol test which reads the test protocol session from a file. The file</em> |
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * read is taken as "<test-name>.test", where <test-name> is the value passed</em> |
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * into the constructor. Subclasses of this test can set up pre-</em> |
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * and post elements for extra elements not defined in the protocol</em> |
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * session file.</em> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/james/mpt/AbstractSimpleScriptedTestProtocol.html">AbstractSimpleScriptedTestProtocol</a> <strong class="jxr_keyword">extends</strong> |
| <a name="34" href="#34">34</a> <a href="../../../../org/apache/james/mpt/AbstractProtocolTestFramework.html">AbstractProtocolTestFramework</a> { |
| <a name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/james/mpt/ProtocolSessionBuilder.html">ProtocolSessionBuilder</a> builder = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/james/mpt/ProtocolSessionBuilder.html">ProtocolSessionBuilder</a>(); |
| <a name="36" href="#36">36</a> |
| <a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Locale BASE_DEFAULT_LOCALE = Locale.getDefault(); |
| <a name="38" href="#38">38</a> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * Constructs a scripted test.</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param hostSystem not null</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param userName user name</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @param password password for user</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/james/mpt/AbstractSimpleScriptedTestProtocol.html">AbstractSimpleScriptedTestProtocol</a>(<a href="../../../../org/apache/james/mpt/HostSystem.html">HostSystem</a> hostSystem, String userName, String password) { |
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">super</strong>(hostSystem, userName, password); |
| <a name="47" href="#47">47</a> } |
| <a name="48" href="#48">48</a> |
| <a name="49" href="#49">49</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> tearDown() <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="50" href="#50">50</a> Locale.setDefault(BASE_DEFAULT_LOCALE); |
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">super</strong>.tearDown(); |
| <a name="52" href="#52">52</a> } |
| <a name="53" href="#53">53</a> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * Reads test elements from the protocol session file and adds them to the</em> |
| <a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * ProtocolSession. Then calls {@link #runSessions()}.</em> |
| <a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param locale test under this default locale, not null</em> |
| <a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> scriptTest(String fileName, Locale locale) <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="61" href="#61">61</a> Locale.setDefault(locale); |
| <a name="62" href="#62">62</a> addTestFile(fileName + <span class="jxr_string">".test"</span>, runner.getTestElements()); |
| <a name="63" href="#63">63</a> runSessions(); |
| <a name="64" href="#64">64</a> } |
| <a name="65" href="#65">65</a> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * Finds the protocol session file identified by the test name, and builds</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * protocol elements from it. All elements from the definition file are</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * added to the supplied ProtocolSession.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param fileName</em> |
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * The name of the file to read</em> |
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @param session</em> |
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * The ProtocolSession to add elements to.</em> |
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addTestFile(String fileName, <a href="../../../../org/apache/james/mpt/ProtocolInteractor.html">ProtocolInteractor</a> session) |
| <a name="77" href="#77">77</a> <strong class="jxr_keyword">throws</strong> Exception { |
| <a name="78" href="#78">78</a> <em class="jxr_comment">// Need to find local resource.</em> |
| <a name="79" href="#79">79</a> InputStream is = <strong class="jxr_keyword">this</strong>.getClass().getResourceAsStream(fileName); |
| <a name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> (is == <strong class="jxr_keyword">null</strong>) { |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Exception(<span class="jxr_string">"Test Resource '"</span> + fileName + <span class="jxr_string">"' not found."</span>); |
| <a name="82" href="#82">82</a> } |
| <a name="83" href="#83">83</a> |
| <a name="84" href="#84">84</a> builder.addProtocolLines(fileName, is, session); |
| <a name="85" href="#85">85</a> } |
| <a name="86" href="#86">86</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
