Google Git
Sign in
apache / james-site / a92fa6ef34b4ad4bdd3caff9c602c28281ff6677 / . / content / mpt / xref / org / apache / james / mpt / ExternalSession.html
blob: a331aa307a90ad363e0ad4fc64e8d3fd5153b3e2 [file] [log] [blame]
<!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>ExternalSession 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/ExternalSession.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.nio.ByteBuffer;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.nio.channels.SocketChannel;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/james/mpt/ExternalSession.html">ExternalSession</a> implements <a href="../../../../org/apache/james/mpt/Session.html">Session</a> {
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Number of milliseconds to sleep after empty read */</em>
<a name="29" href="#29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> SHORT_WAIT_FOR_INPUT = 10;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> byte[] CRLF = { '\r', '\n' };
<a name="32" href="#32">32</a>
<a name="33" href="#33">33</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> SocketChannel socket;
<a name="34" href="#34">34</a>
<a name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/james/mpt/Monitor.html">Monitor</a> monitor;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ByteBuffer readBuffer;
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Charset ascii;
<a name="40" href="#40">40</a>
<a name="41" href="#41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> ByteBuffer lineEndBuffer;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> first = <strong class="jxr_keyword">true</strong>;
<a name="44" href="#44">44</a>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String shabang;
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/james/mpt/ExternalSession.html">ExternalSession</a>(<strong class="jxr_keyword">final</strong> SocketChannel socket, <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/james/mpt/Monitor.html">Monitor</a> monitor, String shabang) {
<a name="48" href="#48">48</a> <strong class="jxr_keyword">this</strong>(socket, monitor, shabang, false);
<a name="49" href="#49">49</a> }
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/james/mpt/ExternalSession.html">ExternalSession</a>(<strong class="jxr_keyword">final</strong> SocketChannel socket, <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/james/mpt/Monitor.html">Monitor</a> monitor, String shabang, <strong class="jxr_keyword">boolean</strong> debug) {
<a name="52" href="#52">52</a> <strong class="jxr_keyword">super</strong>();
<a name="53" href="#53">53</a> <strong class="jxr_keyword">this</strong>.socket = socket;
<a name="54" href="#54">54</a> <strong class="jxr_keyword">this</strong>.monitor = monitor;
<a name="55" href="#55">55</a> readBuffer = ByteBuffer.allocateDirect(2048);
<a name="56" href="#56">56</a> ascii = Charset.forName(<span class="jxr_string">"US-ASCII"</span>);
<a name="57" href="#57">57</a> lineEndBuffer = ByteBuffer.wrap(CRLF);
<a name="58" href="#58">58</a> <strong class="jxr_keyword">this</strong>.shabang = shabang;
<a name="59" href="#59">59</a> }
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <strong class="jxr_keyword">public</strong> String readLine() <strong class="jxr_keyword">throws</strong> Exception {
<a name="62" href="#62">62</a> StringBuffer buffer = <strong class="jxr_keyword">new</strong> StringBuffer();
<a name="63" href="#63">63</a> readlineInto(buffer);
<a name="64" href="#64">64</a> <strong class="jxr_keyword">final</strong> String result;
<a name="65" href="#65">65</a> <strong class="jxr_keyword">if</strong> (first &amp;&amp; shabang != <strong class="jxr_keyword">null</strong>) {
<a name="66" href="#66">66</a> <em class="jxr_comment">// fake shabang</em>
<a name="67" href="#67">67</a> monitor.note(<span class="jxr_string">"&lt;-"</span> + buffer.toString());
<a name="68" href="#68">68</a> result = shabang;
<a name="69" href="#69">69</a> first = false;
<a name="70" href="#70">70</a> } <strong class="jxr_keyword">else</strong> {
<a name="71" href="#71">71</a> result = buffer.toString();
<a name="72" href="#72">72</a> monitor.note(<span class="jxr_string">"&lt;-"</span> + result);
<a name="73" href="#73">73</a> }
<a name="74" href="#74">74</a> <strong class="jxr_keyword">return</strong> result;
<a name="75" href="#75">75</a> }
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> readlineInto(StringBuffer buffer) <strong class="jxr_keyword">throws</strong> Exception {
<a name="78" href="#78">78</a> monitor.debug(<span class="jxr_string">"[Reading line]"</span>);
<a name="79" href="#79">79</a> readBuffer.flip();
<a name="80" href="#80">80</a> <strong class="jxr_keyword">while</strong> (oneFromLine(buffer))
<a name="81" href="#81">81</a> ;
<a name="82" href="#82">82</a> <em class="jxr_comment">// May have partial read</em>
<a name="83" href="#83">83</a> readBuffer.compact();
<a name="84" href="#84">84</a> monitor.debug(<span class="jxr_string">"[Done]"</span>);
<a name="85" href="#85">85</a> }
<a name="86" href="#86">86</a>
<a name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> oneFromLine(StringBuffer buffer) <strong class="jxr_keyword">throws</strong> Exception {
<a name="88" href="#88">88</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> result;
<a name="89" href="#89">89</a> <strong class="jxr_keyword">if</strong> (readBuffer.hasRemaining()) {
<a name="90" href="#90">90</a> <strong class="jxr_keyword">char</strong> next = (<strong class="jxr_keyword">char</strong>) readBuffer.get();
<a name="91" href="#91">91</a> <strong class="jxr_keyword">if</strong> (next == '\n') {
<a name="92" href="#92">92</a> monitor.debug(<span class="jxr_string">"[LF]"</span>);
<a name="93" href="#93">93</a> <em class="jxr_comment">// Reached end of the line</em>
<a name="94" href="#94">94</a> result = false;
<a name="95" href="#95">95</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (next == '\r') {
<a name="96" href="#96">96</a> <em class="jxr_comment">// CRLF line endings so drop</em>
<a name="97" href="#97">97</a> monitor.debug(<span class="jxr_string">"[CR]"</span>);
<a name="98" href="#98">98</a> result = <strong class="jxr_keyword">true</strong>;
<a name="99" href="#99">99</a> } <strong class="jxr_keyword">else</strong> {
<a name="100" href="#100">100</a> <em class="jxr_comment">// Load buffer</em>
<a name="101" href="#101">101</a> monitor.debug(next);
<a name="102" href="#102">102</a> buffer.append(next);
<a name="103" href="#103">103</a> result = <strong class="jxr_keyword">true</strong>;
<a name="104" href="#104">104</a> }
<a name="105" href="#105">105</a> } <strong class="jxr_keyword">else</strong> {
<a name="106" href="#106">106</a> monitor.debug(<span class="jxr_string">"[Reading into buffer]"</span>);
<a name="107" href="#107">107</a> readBuffer.clear();
<a name="108" href="#108">108</a> <strong class="jxr_keyword">while</strong> (socket.read(readBuffer) == 0) {
<a name="109" href="#109">109</a> <em class="jxr_comment">// No response yet</em>
<a name="110" href="#110">110</a> <em class="jxr_comment">// Wait a little while</em>
<a name="111" href="#111">111</a> Thread.sleep(SHORT_WAIT_FOR_INPUT);
<a name="112" href="#112">112</a> }
<a name="113" href="#113">113</a> <em class="jxr_comment">// Reset for transfer into string buffer</em>
<a name="114" href="#114">114</a> readBuffer.flip();
<a name="115" href="#115">115</a> monitor.debug(<span class="jxr_string">"[Done]"</span>);
<a name="116" href="#116">116</a> result = <strong class="jxr_keyword">true</strong>;
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> result;
<a name="119" href="#119">119</a> }
<a name="120" href="#120">120</a>
<a name="121" href="#121">121</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> start() <strong class="jxr_keyword">throws</strong> Exception {
<a name="122" href="#122">122</a> <strong class="jxr_keyword">while</strong> (!socket.finishConnect()) {
<a name="123" href="#123">123</a> monitor.note(<span class="jxr_string">"connecting..."</span>);
<a name="124" href="#124">124</a> Thread.sleep(10);
<a name="125" href="#125">125</a> }
<a name="126" href="#126">126</a> }
<a name="127" href="#127">127</a>
<a name="128" href="#128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> stop() <strong class="jxr_keyword">throws</strong> Exception {
<a name="129" href="#129">129</a> monitor.note(<span class="jxr_string">"closing"</span>);
<a name="130" href="#130">130</a> socket.close();
<a name="131" href="#131">131</a> }
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> writeLine(String line) <strong class="jxr_keyword">throws</strong> Exception {
<a name="134" href="#134">134</a> monitor.note(<span class="jxr_string">"-&gt; "</span> + line);
<a name="135" href="#135">135</a> monitor.debug(<span class="jxr_string">"[Writing line]"</span>);
<a name="136" href="#136">136</a> ByteBuffer writeBuffer = ascii.encode(line);
<a name="137" href="#137">137</a> <strong class="jxr_keyword">while</strong> (writeBuffer.hasRemaining()) {
<a name="138" href="#138">138</a> socket.write(writeBuffer);
<a name="139" href="#139">139</a> }
<a name="140" href="#140">140</a> lineEndBuffer.rewind();
<a name="141" href="#141">141</a> <strong class="jxr_keyword">while</strong> (lineEndBuffer.hasRemaining()) {
<a name="142" href="#142">142</a> socket.write(lineEndBuffer);
<a name="143" href="#143">143</a> }
<a name="144" href="#144">144</a> monitor.debug(<span class="jxr_string">"[Done]"</span>);
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment">/**</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * Constructs a &lt;code&gt;String&lt;/code&gt; with all attributes</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * in name = value format.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> *</em>
<a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * @return a &lt;code&gt;String&lt;/code&gt; representation </em>
<a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * of this object.</em>
<a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em>
<a name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> String toString()
<a name="155" href="#155">155</a> {
<a name="156" href="#156">156</a> <strong class="jxr_keyword">final</strong> String TAB = <span class="jxr_string">" "</span>;
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> String result = <span class="jxr_string">"External ( "</span>
<a name="159" href="#159">159</a> + <span class="jxr_string">"socket = "</span> + <strong class="jxr_keyword">this</strong>.socket + TAB
<a name="160" href="#160">160</a> + <span class="jxr_string">"monitor = "</span> + <strong class="jxr_keyword">this</strong>.monitor + TAB
<a name="161" href="#161">161</a> + <span class="jxr_string">"readBuffer = "</span> + <strong class="jxr_keyword">this</strong>.readBuffer + TAB
<a name="162" href="#162">162</a> + <span class="jxr_string">"ascii = "</span> + <strong class="jxr_keyword">this</strong>.ascii + TAB
<a name="163" href="#163">163</a> + <span class="jxr_string">"lineEndBuffer = "</span> + <strong class="jxr_keyword">this</strong>.lineEndBuffer + TAB
<a name="164" href="#164">164</a> + <span class="jxr_string">"first = "</span> + <strong class="jxr_keyword">this</strong>.first + TAB
<a name="165" href="#165">165</a> + <span class="jxr_string">"shabang = "</span> + <strong class="jxr_keyword">this</strong>.shabang + TAB
<a name="166" href="#166">166</a> + <span class="jxr_string">" )"</span>;
<a name="167" href="#167">167</a>
<a name="168" href="#168">168</a> <strong class="jxr_keyword">return</strong> result;
<a name="169" href="#169">169</a> }
<a name="170" href="#170">170</a>
<a name="171" href="#171">171</a>
<a name="172" href="#172">172</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>