~ubuntu-branches/ubuntu/lucid/commons-httpclient/lucid

<a name="2" href="#2">2</a> * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/protocol/Protocol.java,v 1.5.2.2 2004/02/22 18:21:16 olegk Exp $

<a name="3" href="#3">3</a> * $Revision: 1.5.2.2 $

<a name="4" href="#4">4</a> * $Date: 2004/02/22 18:21:16 $

<a name="5" href="#5">5</a> *

<a name="6" href="#6">6</a> * ====================================================================

<a name="7" href="#7">7</a> *

<a name="9" href="#9">9</a> *

<a name="10" href="#10">10</a> * Licensed under the Apache License, Version 2.0 (the "License");

<a name="11" href="#11">11</a> * you may not use this file except in compliance with the License.

<a name="12" href="#12">12</a> * You may obtain a copy of the License at

<a name="13" href="#13">13</a> *

<a name="14" href="#14">14</a> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a>

<a name="15" href="#15">15</a> *

<a name="16" href="#16">16</a> * Unless required by applicable law or agreed to in writing, software

<a name="17" href="#17">17</a> * distributed under the License is distributed on an "AS IS" BASIS,

<a name="18" href="#18">18</a> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

<a name="19" href="#19">19</a> * See the License for the specific language governing permissions and

<a name="20" href="#20">20</a> * limitations under the License.

<a name="21" href="#21">21</a> * ====================================================================

<a name="22" href="#22">22</a> *

<a name="23" href="#23">23</a> * This software consists of voluntary contributions made by many

<a name="24" href="#24">24</a> * individuals on behalf of the Apache Software Foundation. For more

<a name="25" href="#25">25</a> * information on the Apache Software Foundation, please see

<a name="26" href="#26">26</a> * <<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.

<a name="27" href="#27">27</a> *

<a name="28" href="#28">28</a> * [Additional notices, if required by prior licensing conditions]

<a name="29" href="#29">29</a> *

<a name="30" href="#30">30</a> */

<a name="31" href="#31">31</a> package <a href="../../../../../org/apache/commons/httpclient/protocol/package-summary.html">org.apache.commons.httpclient.protocol</a>;

<a name="33" href="#33">33</a> import java.util.Collections;

<a name="34" href="#34">34</a> import java.util.HashMap;

<a name="35" href="#35">35</a> import java.util.Map;

<a name="37" href="#37">37</a> /***

<a name="38" href="#38">38</a> * A class to encapsulate the specifics of a protocol. This class class also

<a name="39" href="#39">39</a> * provides the ability to customize the set and characteristics of the

<a name="40" href="#40">40</a> * protocols used.

<a name="41" href="#41">41</a> *

<a name="42" href="#42">42</a> * One use case for modifying the default set of protocols would be to set a

<a name="43" href="#43">43</a> * custom SSL socket factory. This would look something like the following:

<a name="45" href="#45">45</a> * Protocol myHTTPS = new Protocol( "https", new MySSLSocketFactory(), 443 );

<a name="46" href="#46">46</a> *

<a name="47" href="#47">47</a> * Protocol.registerProtocol( "https", myHTTPS );

<a name="49" href="#49">49</a> *

<a name="50" href="#50">50</a> * @author Michael Becke

<a name="51" href="#51">51</a> * @author Jeff Dever

<a name="52" href="#52">52</a> * @author <a href="<a href="mailto:mbowler@GargoyleSoftware.com" target="alexandria_uri">mailto:mbowler@GargoyleSoftware.com</a>">Mike Bowler</a>

<a name="53" href="#53">53</a> *

<a name="54" href="#54">54</a> * @since 2.0

<a name="55" href="#55">55</a> */

<a name="56" href="#56">56</a> public class <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> {

<a name="58" href="#58">58</a> /*** The available protocols */

<a name="59" href="#59">59</a> private static final Map PROTOCOLS = Collections.synchronizedMap(new HashMap());

<a name="61" href="#61">61</a> /***

<a name="62" href="#62">62</a> * Registers a new protocol with the given identifier. If a protocol with

<a name="63" href="#63">63</a> * the given ID already exists it will be overridden. This ID is the same

<a name="64" href="#64">64</a> * one used to retrieve the protocol from getProtocol(String).

<a name="65" href="#65">65</a> *

<a name="66" href="#66">66</a> * @param id the identifier for this protocol

<a name="67" href="#67">67</a> * @param protocol the protocol to register

<a name="68" href="#68">68</a> *

<a name="69" href="#69">69</a> * @see #getProtocol(String)

<a name="70" href="#70">70</a> */

<a name="71" href="#71">71</a> public static void registerProtocol(String id, <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol) {

<a name="73" href="#73">73</a> if (id == null) {

<a name="74" href="#74">74</a> throw new IllegalArgumentException("id is null");

<a name="75" href="#75">75</a> }

<a name="76" href="#76">76</a> if (protocol == null) {

<a name="77" href="#77">77</a> throw new IllegalArgumentException("protocol is null");

<a name="78" href="#78">78</a> }

<a name="80" href="#80">80</a> PROTOCOLS.put(id, protocol);

<a name="81" href="#81">81</a> }

<a name="83" href="#83">83</a> /***

<a name="84" href="#84">84</a> * Unregisters the protocol with the given ID.

<a name="85" href="#85">85</a> *

<a name="86" href="#86">86</a> * @param id the ID of the protocol to remove

<a name="87" href="#87">87</a> */

<a name="88" href="#88">88</a> public static void unregisterProtocol(String id) {

<a name="90" href="#90">90</a> if (id == null) {

100

<a name="91" href="#91">91</a> throw new IllegalArgumentException("id is null");

101

<a name="92" href="#92">92</a> }

102

103

<a name="94" href="#94">94</a> PROTOCOLS.remove(id);

104

<a name="95" href="#95">95</a> }

105

106

<a name="97" href="#97">97</a> /***

107

<a name="98" href="#98">98</a> * Gets the protocol with the given ID.

108

<a name="99" href="#99">99</a> *

109

<a name="100" href="#100">100</a> * @param id the protocol ID

110

<a name="101" href="#101">101</a> *

111

<a name="102" href="#102">102</a> * @return Protocol a protocol

112

<a name="103" href="#103">103</a> *

113

<a name="104" href="#104">104</a> * @throws IllegalStateException if a protocol with the ID cannot be found

114

<a name="105" href="#105">105</a> */

115

<a name="106" href="#106">106</a> public static <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> getProtocol(String id)

116

<a name="107" href="#107">107</a> throws IllegalStateException {

117

118

<a name="109" href="#109">109</a> if (id == null) {

119

<a name="110" href="#110">110</a> throw new IllegalArgumentException("id is null");

120

<a name="111" href="#111">111</a> }

121

122

<a name="113" href="#113">113</a> <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> protocol = (Protocol) PROTOCOLS.get(id);

123

124

<a name="115" href="#115">115</a> if (protocol == null) {

125

<a name="116" href="#116">116</a> protocol = lazyRegisterProtocol(id);

126

<a name="117" href="#117">117</a> }

127

128

<a name="119" href="#119">119</a> return protocol;

129

<a name="120" href="#120">120</a> }

130

131

<a name="122" href="#122">122</a> /***

132

<a name="123" href="#123">123</a> * Lazily registers the protocol with the given id.

133

<a name="124" href="#124">124</a> *

134

<a name="125" href="#125">125</a> * @param id the protocol ID

135

<a name="126" href="#126">126</a> *

136

<a name="127" href="#127">127</a> * @return the lazily registered protocol

137

<a name="128" href="#128">128</a> *

138

<a name="129" href="#129">129</a> * @throws IllegalStateException if the protocol with id is not recognized

139

<a name="130" href="#130">130</a> */

140

<a name="131" href="#131">131</a> private static <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> lazyRegisterProtocol(String id)

141

<a name="132" href="#132">132</a> throws IllegalStateException {

142

143

<a name="134" href="#134">134</a> if ("http".equals(id)) {

144

<a name="135" href="#135">135</a> final <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> http

145

<a name="136" href="#136">136</a> = new <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a>("http", DefaultProtocolSocketFactory.getSocketFactory(), 80);

146

<a name="137" href="#137">137</a> Protocol.registerProtocol("http", http);

147

<a name="138" href="#138">138</a> return http;

148

<a name="139" href="#139">139</a> }

149

150

<a name="141" href="#141">141</a> if ("https".equals(id)) {

151

<a name="142" href="#142">142</a> final <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> https

152

<a name="143" href="#143">143</a> = new <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a>("https", SSLProtocolSocketFactory.getSocketFactory(), 443);

153

<a name="144" href="#144">144</a> Protocol.registerProtocol("https", https);

154

<a name="145" href="#145">145</a> return https;

155

<a name="146" href="#146">146</a> }

156

157

<a name="148" href="#148">148</a> throw new IllegalStateException("unsupported protocol: '" + id + "'");

158

<a name="149" href="#149">149</a> }

159

160

161

<a name="152" href="#152">152</a> /*** the scheme of this protocol (e.g. http, https) */

162

<a name="153" href="#153">153</a> private String scheme;

163

164

<a name="155" href="#155">155</a> /*** The socket factory for this protocol */

165

<a name="156" href="#156">156</a> private <a href="../../../../../org/apache/commons/httpclient/protocol/ProtocolSocketFactory.html">ProtocolSocketFactory</a> socketFactory;

166

167

<a name="158" href="#158">158</a> /*** The default port for this protocol */

168

<a name="159" href="#159">159</a> private int defaultPort;

169

170

<a name="161" href="#161">161</a> /*** True if this protocol is secure */

171

<a name="162" href="#162">162</a> private boolean secure;

172

173

<a name="164" href="#164">164</a> /***

174

<a name="165" href="#165">165</a> * Constructs a new Protocol. The created protcol is insecure.

175

<a name="166" href="#166">166</a> *

176

<a name="167" href="#167">167</a> * @param scheme the scheme (e.g. http, https)

177

<a name="168" href="#168">168</a> * @param factory the factory for creating sockets for communication using

178

<a name="169" href="#169">169</a> * this protocol

179

<a name="170" href="#170">170</a> * @param defaultPort the port this protocol defaults to

180

<a name="171" href="#171">171</a> */

181

<a name="172" href="#172">172</a> public <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a>(String scheme, <a href="../../../../../org/apache/commons/httpclient/protocol/ProtocolSocketFactory.html">ProtocolSocketFactory</a> factory, int defaultPort) {

182

183

<a name="174" href="#174">174</a> if (scheme == null) {

184

<a name="175" href="#175">175</a> throw new IllegalArgumentException("scheme is null");

185

<a name="176" href="#176">176</a> }

186

<a name="177" href="#177">177</a> if (factory == null) {

187

<a name="178" href="#178">178</a> throw new IllegalArgumentException("socketFactory is null");

188

<a name="179" href="#179">179</a> }

189

<a name="180" href="#180">180</a> if (defaultPort <= 0) {

190

<a name="181" href="#181">181</a> throw new IllegalArgumentException("port is invalid: " + defaultPort);

191

<a name="182" href="#182">182</a> }

192

193

<a name="184" href="#184">184</a> this.scheme = scheme;

194

<a name="185" href="#185">185</a> this.socketFactory = factory;

195

<a name="186" href="#186">186</a> this.defaultPort = defaultPort;

196

<a name="187" href="#187">187</a> this.secure = false;

197

<a name="188" href="#188">188</a> }

198

199

<a name="190" href="#190">190</a> /***

200

<a name="191" href="#191">191</a> * Constructs a new Protocol. The created protcol is secure.

201

<a name="192" href="#192">192</a> *

202

<a name="193" href="#193">193</a> * @param scheme the scheme (e.g. http, https)

203

<a name="194" href="#194">194</a> * @param factory the factory for creating sockets for communication using

204

<a name="195" href="#195">195</a> * this protocol

205

<a name="196" href="#196">196</a> * @param defaultPort the port this protocol defaults to

206

<a name="197" href="#197">197</a> */

207

<a name="198" href="#198">198</a> public <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a>(String scheme,

208

<a name="199" href="#199">199</a> <a href="../../../../../org/apache/commons/httpclient/protocol/SecureProtocolSocketFactory.html">SecureProtocolSocketFactory</a> factory, int defaultPort) {

209

210

<a name="201" href="#201">201</a> if (scheme == null) {

211

<a name="202" href="#202">202</a> throw new IllegalArgumentException("scheme is null");

212

<a name="203" href="#203">203</a> }

213

<a name="204" href="#204">204</a> if (factory == null) {

214

<a name="205" href="#205">205</a> throw new IllegalArgumentException("socketFactory is null");

215

<a name="206" href="#206">206</a> }

216

<a name="207" href="#207">207</a> if (defaultPort <= 0) {

217

<a name="208" href="#208">208</a> throw new IllegalArgumentException("port is invalid: " + defaultPort);

218

<a name="209" href="#209">209</a> }

219

220

<a name="211" href="#211">211</a> this.scheme = scheme;

221

<a name="212" href="#212">212</a> this.socketFactory = factory;

222

<a name="213" href="#213">213</a> this.defaultPort = defaultPort;

223

<a name="214" href="#214">214</a> this.secure = true;

224

<a name="215" href="#215">215</a> }

225

226

<a name="217" href="#217">217</a> /***

227

<a name="218" href="#218">218</a> * Returns the defaultPort.

228

<a name="219" href="#219">219</a> * @return int

229

<a name="220" href="#220">220</a> */

230

<a name="221" href="#221">221</a> public int getDefaultPort() {

231

<a name="222" href="#222">222</a> return defaultPort;

232

<a name="223" href="#223">223</a> }

233

234

<a name="225" href="#225">225</a> /***

235

<a name="226" href="#226">226</a> * Returns the socketFactory. If secure the factory is a

236

<a name="227" href="#227">227</a> * SecureProtocolSocketFactory.

237

<a name="228" href="#228">228</a> * @return SocketFactory

238

<a name="229" href="#229">229</a> */

239

<a name="230" href="#230">230</a> public <a href="../../../../../org/apache/commons/httpclient/protocol/ProtocolSocketFactory.html">ProtocolSocketFactory</a> getSocketFactory() {

240

<a name="231" href="#231">231</a> return socketFactory;

241

<a name="232" href="#232">232</a> }

242

243

<a name="234" href="#234">234</a> /***

244

<a name="235" href="#235">235</a> * Returns the scheme.

245

<a name="236" href="#236">236</a> * @return The scheme

246

<a name="237" href="#237">237</a> */

247

<a name="238" href="#238">238</a> public String getScheme() {

248

<a name="239" href="#239">239</a> return scheme;

249

<a name="240" href="#240">240</a> }

250

251

<a name="242" href="#242">242</a> /***

252

<a name="243" href="#243">243</a> * Returns true if this protocol is secure

253

<a name="244" href="#244">244</a> * @return true if this protocol is secure

254

<a name="245" href="#245">245</a> */

255

<a name="246" href="#246">246</a> public boolean isSecure() {

256

<a name="247" href="#247">247</a> return secure;

257

<a name="248" href="#248">248</a> }

258

259

<a name="250" href="#250">250</a> /***

260

<a name="251" href="#251">251</a> * Resolves the correct port for this protocol. Returns the given port if

261

<a name="252" href="#252">252</a> * valid or the default port otherwise.

262

<a name="253" href="#253">253</a> *

263

<a name="254" href="#254">254</a> * @param port the port to be resolved

264

<a name="255" href="#255">255</a> *

265

<a name="256" href="#256">256</a> * @return the given port or the defaultPort

266

<a name="257" href="#257">257</a> */

267

<a name="258" href="#258">258</a> public int resolvePort(int port) {

268

<a name="259" href="#259">259</a> return port <= 0 ? getDefaultPort() : port;

269

<a name="260" href="#260">260</a> }

270

271

<a name="262" href="#262">262</a> /***

272

<a name="263" href="#263">263</a> * Return a string representation of this object.

273

<a name="264" href="#264">264</a> * @return a string representation of this object.

274

<a name="265" href="#265">265</a> */

275

<a name="266" href="#266">266</a> public String toString() {

276

<a name="267" href="#267">267</a> return scheme + ":" + defaultPort;

277

<a name="268" href="#268">268</a> }

278

279

<a name="270" href="#270">270</a> /***

280

<a name="271" href="#271">271</a> * Return true if the specified object equals this object.

281

<a name="272" href="#272">272</a> * @param obj The object to compare against.

282

<a name="273" href="#273">273</a> * @return true if the objects are equal.

283

<a name="274" href="#274">274</a> */

284

<a name="275" href="#275">275</a> public boolean equals(Object obj) {

285

286

<a name="277" href="#277">277</a> if (obj instanceof Protocol) {

287

288

<a name="279" href="#279">279</a> <a href="../../../../../org/apache/commons/httpclient/protocol/Protocol.html">Protocol</a> p = (Protocol) obj;

289

290

<a name="281" href="#281">281</a> return (

291

<a name="282" href="#282">282</a> defaultPort == p.getDefaultPort()

292

<a name="283" href="#283">283</a> && scheme.equalsIgnoreCase(p.getScheme())

293

<a name="284" href="#284">284</a> && secure == p.isSecure()

294

<a name="285" href="#285">285</a> && socketFactory.equals(p.getSocketFactory()));

295

296

<a name="287" href="#287">287</a> } else {

297

<a name="288" href="#288">288</a> return false;

298

<a name="289" href="#289">289</a> }

299

300

<a name="291" href="#291">291</a> }

301

302

<a name="293" href="#293">293</a> /***

303

<a name="294" href="#294">294</a> * Return a hash code for this object

304

<a name="295" href="#295">295</a> * @return The hash code.

305

<a name="296" href="#296">296</a> */

306

<a name="297" href="#297">297</a> public int hashCode() {

307

<a name="298" href="#298">298</a> return scheme.hashCode();

308

<a name="299" href="#299">299</a> }

309

<a name="300" href="#300">300</a> }

310

</pre>

311

<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>

312

</html>

313

Older »