~ubuntu-branches/ubuntu/hardy/commons-httpclient/hardy

« back to all changes in this revision

Viewing changes to docs/xref/org/apache/commons/httpclient/auth/AuthScope.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Meskes
  • Date: 2006-09-15 20:07:43 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20060915200743-t2md4cgfsb07wgn7
Tags: 3.0.1-0.1
* Non-maintainer upload.
* Bump debhelper Build-Depends to (>= 4.1.0) as required by cdbs' 
  debhelper.mk
* Put the coppyright holders in debian/copyright
* Include the jar file in the package. (Closes: #381354)
* Only include one copy of the docs.
  done by James Westby <jw+debian@jameswestby.net>  Mon, 14 Aug 2006 02:29:47 +0100

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
3
<head>
 
4
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>AuthScope xref</title>
 
5
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
 
6
</head>
 
7
<body>
 
8
<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/httpclient/auth/AuthScope.html">View Javadoc</a></div><pre>
 
9
 
 
10
<a name="1" href="#1">1</a>   <em class="comment">/*</em>
 
11
<a name="2" href="#2">2</a>   <em class="comment"> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/auth/AuthScope.java,v 1.2 2004/06/23 06:50:25 olegk Exp $</em>
 
12
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 354155 $</em>
 
13
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2005-12-05 15:18:10 -0500 (Mon, 05 Dec 2005) $</em>
 
14
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
 
15
<a name="6" href="#6">6</a>   <em class="comment"> * ====================================================================</em>
 
16
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
 
17
<a name="8" href="#8">8</a>   <em class="comment"> *  Copyright 1999-2004 The Apache Software Foundation</em>
 
18
<a name="9" href="#9">9</a>   <em class="comment"> *</em>
 
19
<a name="10" href="#10">10</a>  <em class="comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
 
20
<a name="11" href="#11">11</a>  <em class="comment"> *  you may not use this file except in compliance with the License.</em>
 
21
<a name="12" href="#12">12</a>  <em class="comment"> *  You may obtain a copy of the License at</em>
 
22
<a name="13" href="#13">13</a>  <em class="comment"> *</em>
 
23
<a name="14" href="#14">14</a>  <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
 
24
<a name="15" href="#15">15</a>  <em class="comment"> *</em>
 
25
<a name="16" href="#16">16</a>  <em class="comment"> *  Unless required by applicable law or agreed to in writing, software</em>
 
26
<a name="17" href="#17">17</a>  <em class="comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
 
27
<a name="18" href="#18">18</a>  <em class="comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
 
28
<a name="19" href="#19">19</a>  <em class="comment"> *  See the License for the specific language governing permissions and</em>
 
29
<a name="20" href="#20">20</a>  <em class="comment"> *  limitations under the License.</em>
 
30
<a name="21" href="#21">21</a>  <em class="comment"> * ====================================================================</em>
 
31
<a name="22" href="#22">22</a>  <em class="comment"> *</em>
 
32
<a name="23" href="#23">23</a>  <em class="comment"> * This software consists of voluntary contributions made by many</em>
 
33
<a name="24" href="#24">24</a>  <em class="comment"> * individuals on behalf of the Apache Software Foundation.  For more</em>
 
34
<a name="25" href="#25">25</a>  <em class="comment"> * information on the Apache Software Foundation, please see</em>
 
35
<a name="26" href="#26">26</a>  <em class="comment"> * &lt;<a href="http://www.apache.org/" target="alexandria_uri">http://www.apache.org/</a>>.</em>
 
36
<a name="27" href="#27">27</a>  <em class="comment"> *</em>
 
37
<a name="28" href="#28">28</a>  <em class="comment"> */</em>
 
38
<a name="29" href="#29">29</a>  
 
39
<a name="30" href="#30">30</a>  <strong>package</strong> <a href="../../../../../org/apache/commons/httpclient/auth/package-summary.html">org.apache.commons.httpclient.auth</a>;
 
40
<a name="31" href="#31">31</a>  
 
41
<a name="32" href="#32">32</a>  <strong>import</strong> org.apache.commons.httpclient.util.LangUtils;
 
42
<a name="33" href="#33">33</a>  
 
43
<a name="34" href="#34">34</a>  <em>/**<em>* </em></em>
 
44
<a name="35" href="#35">35</a>  <em> * The class represents an authentication scope consisting of a host name,</em>
 
45
<a name="36" href="#36">36</a>  <em> * a port number, a realm name and an authentication scheme name which </em>
 
46
<a name="37" href="#37">37</a>  <em> * {@link org.apache.commons.httpclient.Credentials} apply to.</em>
 
47
<a name="38" href="#38">38</a>  <em> * </em>
 
48
<a name="39" href="#39">39</a>  <em> * @author &lt;a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski&lt;/a></em>
 
49
<a name="40" href="#40">40</a>  <em> * @author &lt;a href="<a href="mailto:adrian@intencha.com" target="alexandria_uri">mailto:adrian@intencha.com</a>">Adrian Sutton&lt;/a></em>
 
50
<a name="41" href="#41">41</a>  <em> * </em>
 
51
<a name="42" href="#42">42</a>  <em> * @since 3.0</em>
 
52
<a name="43" href="#43">43</a>  <em> */</em>
 
53
<a name="44" href="#44">44</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> {
 
54
<a name="45" href="#45">45</a>      
 
55
<a name="46" href="#46">46</a>      <em>/**<em>* </em></em>
 
56
<a name="47" href="#47">47</a>  <em>     * The &lt;tt>null&lt;/tt> value represents any host. In the future versions of </em>
 
57
<a name="48" href="#48">48</a>  <em>     * HttpClient the use of this parameter will be discontinued.  </em>
 
58
<a name="49" href="#49">49</a>  <em>     */</em>
 
59
<a name="50" href="#50">50</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ANY_HOST = <strong>null</strong>;
 
60
<a name="51" href="#51">51</a>  
 
61
<a name="52" href="#52">52</a>      <em>/**<em>* </em></em>
 
62
<a name="53" href="#53">53</a>  <em>     * The &lt;tt>-1&lt;/tt> value represents any port.  </em>
 
63
<a name="54" href="#54">54</a>  <em>     */</em>
 
64
<a name="55" href="#55">55</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>int</strong> ANY_PORT = -1;
 
65
<a name="56" href="#56">56</a>  
 
66
<a name="57" href="#57">57</a>      <em>/**<em>* </em></em>
 
67
<a name="58" href="#58">58</a>  <em>     * The &lt;tt>null&lt;/tt> value represents any realm.  </em>
 
68
<a name="59" href="#59">59</a>  <em>     */</em>
 
69
<a name="60" href="#60">60</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ANY_REALM = <strong>null</strong>;
 
70
<a name="61" href="#61">61</a>  
 
71
<a name="62" href="#62">62</a>      <em>/**<em>* </em></em>
 
72
<a name="63" href="#63">63</a>  <em>     * The &lt;tt>null&lt;/tt> value represents any authentication scheme.  </em>
 
73
<a name="64" href="#64">64</a>  <em>     */</em>
 
74
<a name="65" href="#65">65</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> String ANY_SCHEME = <strong>null</strong>;
 
75
<a name="66" href="#66">66</a>      
 
76
<a name="67" href="#67">67</a>      <em>/**<em>* </em></em>
 
77
<a name="68" href="#68">68</a>  <em>     * Default scope matching any host, port, realm and authentication scheme. </em>
 
78
<a name="69" href="#69">69</a>  <em>     * In the future versions of HttpClient the use of this parameter will be </em>
 
79
<a name="70" href="#70">70</a>  <em>     * discontinued.  </em>
 
80
<a name="71" href="#71">71</a>  <em>     */</em>
 
81
<a name="72" href="#72">72</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> ANY = <strong>new</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(ANY_HOST, ANY_PORT, ANY_REALM, ANY_SCHEME);
 
82
<a name="73" href="#73">73</a>  
 
83
<a name="74" href="#74">74</a>      <em>/**<em>* The authentication scheme the credentials apply to. */</em></em>
 
84
<a name="75" href="#75">75</a>      <strong>private</strong> String scheme = <strong>null</strong>;
 
85
<a name="76" href="#76">76</a>      
 
86
<a name="77" href="#77">77</a>      <em>/**<em>* The realm the credentials apply to. */</em></em>
 
87
<a name="78" href="#78">78</a>      <strong>private</strong> String realm = <strong>null</strong>;
 
88
<a name="79" href="#79">79</a>      
 
89
<a name="80" href="#80">80</a>      <em>/**<em>* The host the credentials apply to. */</em></em>
 
90
<a name="81" href="#81">81</a>      <strong>private</strong> String host = <strong>null</strong>;
 
91
<a name="82" href="#82">82</a>          
 
92
<a name="83" href="#83">83</a>      <em>/**<em>* The port the credentials apply to. */</em></em>
 
93
<a name="84" href="#84">84</a>      <strong>private</strong> <strong>int</strong> port = -1;
 
94
<a name="85" href="#85">85</a>          
 
95
<a name="86" href="#86">86</a>      <em>/**<em>* Creates a new credentials scope for the given </em></em>
 
96
<a name="87" href="#87">87</a>  <em>     * &lt;tt>host&lt;/tt>, &lt;tt>port&lt;/tt>, &lt;tt>realm&lt;/tt>, and </em>
 
97
<a name="88" href="#88">88</a>  <em>     * &lt;tt>authentication scheme&lt;/tt>.</em>
 
98
<a name="89" href="#89">89</a>  <em>     * </em>
 
99
<a name="90" href="#90">90</a>  <em>     * @param host the host the credentials apply to. May be set</em>
 
100
<a name="91" href="#91">91</a>  <em>     *   to &lt;tt>null&lt;/tt> if credenticals are applicable to</em>
 
101
<a name="92" href="#92">92</a>  <em>     *   any host. </em>
 
102
<a name="93" href="#93">93</a>  <em>     * @param port the port the credentials apply to. May be set</em>
 
103
<a name="94" href="#94">94</a>  <em>     *   to negative value if credenticals are applicable to</em>
 
104
<a name="95" href="#95">95</a>  <em>     *   any port. </em>
 
105
<a name="96" href="#96">96</a>  <em>     * @param realm the realm the credentials apply to. May be set </em>
 
106
<a name="97" href="#97">97</a>  <em>     *   to &lt;tt>null&lt;/tt> if credenticals are applicable to</em>
 
107
<a name="98" href="#98">98</a>  <em>     *   any realm. </em>
 
108
<a name="99" href="#99">99</a>  <em>     * @param scheme the authentication scheme the credentials apply to. </em>
 
109
<a name="100" href="#100">100</a> <em>     *   May be set to &lt;tt>null&lt;/tt> if credenticals are applicable to</em>
 
110
<a name="101" href="#101">101</a> <em>     *   any authentication scheme. </em>
 
111
<a name="102" href="#102">102</a> <em>     * </em>
 
112
<a name="103" href="#103">103</a> <em>     * @since 3.0</em>
 
113
<a name="104" href="#104">104</a> <em>     */</em>
 
114
<a name="105" href="#105">105</a>     <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(<strong>final</strong> String host, <strong>int</strong> port, 
 
115
<a name="106" href="#106">106</a>         <strong>final</strong> String realm, <strong>final</strong> String scheme)
 
116
<a name="107" href="#107">107</a>     {
 
117
<a name="108" href="#108">108</a>         <strong>this</strong>.host =   (host == <strong>null</strong>)   ? ANY_HOST: host.toLowerCase();
 
118
<a name="109" href="#109">109</a>         <strong>this</strong>.port =   (port &lt; 0)       ? ANY_PORT: port;
 
119
<a name="110" href="#110">110</a>         <strong>this</strong>.realm =  (realm == <strong>null</strong>)  ? ANY_REALM: realm;
 
120
<a name="111" href="#111">111</a>         <strong>this</strong>.scheme = (scheme == <strong>null</strong>) ? ANY_SCHEME: scheme.toUpperCase();;
 
121
<a name="112" href="#112">112</a>     }
 
122
<a name="113" href="#113">113</a>     
 
123
<a name="114" href="#114">114</a>     <em>/**<em>* Creates a new credentials scope for the given </em></em>
 
124
<a name="115" href="#115">115</a> <em>     * &lt;tt>host&lt;/tt>, &lt;tt>port&lt;/tt>, &lt;tt>realm&lt;/tt>, and any</em>
 
125
<a name="116" href="#116">116</a> <em>     * authentication scheme.</em>
 
126
<a name="117" href="#117">117</a> <em>     * </em>
 
127
<a name="118" href="#118">118</a> <em>     * @param host the host the credentials apply to. May be set</em>
 
128
<a name="119" href="#119">119</a> <em>     *   to &lt;tt>null&lt;/tt> if credenticals are applicable to</em>
 
129
<a name="120" href="#120">120</a> <em>     *   any host. </em>
 
130
<a name="121" href="#121">121</a> <em>     * @param port the port the credentials apply to. May be set</em>
 
131
<a name="122" href="#122">122</a> <em>     *   to negative value if credenticals are applicable to</em>
 
132
<a name="123" href="#123">123</a> <em>     *   any port. </em>
 
133
<a name="124" href="#124">124</a> <em>     * @param realm the realm the credentials apply to. May be set </em>
 
134
<a name="125" href="#125">125</a> <em>     *   to &lt;tt>null&lt;/tt> if credenticals are applicable to</em>
 
135
<a name="126" href="#126">126</a> <em>     *   any realm. </em>
 
136
<a name="127" href="#127">127</a> <em>     * </em>
 
137
<a name="128" href="#128">128</a> <em>     * @since 3.0</em>
 
138
<a name="129" href="#129">129</a> <em>     */</em>
 
139
<a name="130" href="#130">130</a>     <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(<strong>final</strong> String host, <strong>int</strong> port, <strong>final</strong> String realm) {
 
140
<a name="131" href="#131">131</a>         <strong>this</strong>(host, port, realm, ANY_SCHEME);
 
141
<a name="132" href="#132">132</a>     }
 
142
<a name="133" href="#133">133</a>     
 
143
<a name="134" href="#134">134</a>     <em>/**<em>* Creates a new credentials scope for the given </em></em>
 
144
<a name="135" href="#135">135</a> <em>     * &lt;tt>host&lt;/tt>, &lt;tt>port&lt;/tt>, any realm name, and any</em>
 
145
<a name="136" href="#136">136</a> <em>     * authentication scheme.</em>
 
146
<a name="137" href="#137">137</a> <em>     * </em>
 
147
<a name="138" href="#138">138</a> <em>     * @param host the host the credentials apply to. May be set</em>
 
148
<a name="139" href="#139">139</a> <em>     *   to &lt;tt>null&lt;/tt> if credenticals are applicable to</em>
 
149
<a name="140" href="#140">140</a> <em>     *   any host. </em>
 
150
<a name="141" href="#141">141</a> <em>     * @param port the port the credentials apply to. May be set</em>
 
151
<a name="142" href="#142">142</a> <em>     *   to negative value if credenticals are applicable to</em>
 
152
<a name="143" href="#143">143</a> <em>     *   any port. </em>
 
153
<a name="144" href="#144">144</a> <em>     * </em>
 
154
<a name="145" href="#145">145</a> <em>     * @since 3.0</em>
 
155
<a name="146" href="#146">146</a> <em>     */</em>
 
156
<a name="147" href="#147">147</a>     <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(<strong>final</strong> String host, <strong>int</strong> port) {
 
157
<a name="148" href="#148">148</a>         <strong>this</strong>(host, port, ANY_REALM, ANY_SCHEME);
 
158
<a name="149" href="#149">149</a>     }
 
159
<a name="150" href="#150">150</a>     
 
160
<a name="151" href="#151">151</a>     <em>/**<em>* </em></em>
 
161
<a name="152" href="#152">152</a> <em>     * Creates a copy of the given credentials scope.</em>
 
162
<a name="153" href="#153">153</a> <em>     * </em>
 
163
<a name="154" href="#154">154</a> <em>     * @since 3.0</em>
 
164
<a name="155" href="#155">155</a> <em>     */</em>
 
165
<a name="156" href="#156">156</a>     <strong>public</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a>(<strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> authscope) {
 
166
<a name="157" href="#157">157</a>         <strong>super</strong>();
 
167
<a name="158" href="#158">158</a>         <strong>if</strong> (authscope == <strong>null</strong>) {
 
168
<a name="159" href="#159">159</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Scope may not be null"</span>);
 
169
<a name="160" href="#160">160</a>         }
 
170
<a name="161" href="#161">161</a>         <strong>this</strong>.host = authscope.getHost();
 
171
<a name="162" href="#162">162</a>         <strong>this</strong>.port = authscope.getPort();
 
172
<a name="163" href="#163">163</a>         <strong>this</strong>.realm = authscope.getRealm();
 
173
<a name="164" href="#164">164</a>         <strong>this</strong>.scheme = authscope.getScheme();
 
174
<a name="165" href="#165">165</a>     }
 
175
<a name="166" href="#166">166</a>     
 
176
<a name="167" href="#167">167</a>     <em>/**<em>*</em></em>
 
177
<a name="168" href="#168">168</a> <em>     * @return the host</em>
 
178
<a name="169" href="#169">169</a> <em>     * </em>
 
179
<a name="170" href="#170">170</a> <em>     * @since 3.0</em>
 
180
<a name="171" href="#171">171</a> <em>     */</em>
 
181
<a name="172" href="#172">172</a>     <strong>public</strong> String getHost() {
 
182
<a name="173" href="#173">173</a>         <strong>return</strong> <strong>this</strong>.host;
 
183
<a name="174" href="#174">174</a>     }
 
184
<a name="175" href="#175">175</a> 
 
185
<a name="176" href="#176">176</a>     <em>/**<em>*</em></em>
 
186
<a name="177" href="#177">177</a> <em>     * @return the port</em>
 
187
<a name="178" href="#178">178</a> <em>     * </em>
 
188
<a name="179" href="#179">179</a> <em>     * @since 3.0</em>
 
189
<a name="180" href="#180">180</a> <em>     */</em>
 
190
<a name="181" href="#181">181</a>     <strong>public</strong> <strong>int</strong> getPort() {
 
191
<a name="182" href="#182">182</a>         <strong>return</strong> <strong>this</strong>.port;
 
192
<a name="183" href="#183">183</a>     }
 
193
<a name="184" href="#184">184</a> 
 
194
<a name="185" href="#185">185</a>     <em>/**<em>*</em></em>
 
195
<a name="186" href="#186">186</a> <em>     * @return the realm name</em>
 
196
<a name="187" href="#187">187</a> <em>     * </em>
 
197
<a name="188" href="#188">188</a> <em>     * @since 3.0</em>
 
198
<a name="189" href="#189">189</a> <em>     */</em>
 
199
<a name="190" href="#190">190</a>     <strong>public</strong> String getRealm() {
 
200
<a name="191" href="#191">191</a>         <strong>return</strong> <strong>this</strong>.realm;
 
201
<a name="192" href="#192">192</a>     }
 
202
<a name="193" href="#193">193</a> 
 
203
<a name="194" href="#194">194</a>     <em>/**<em>*</em></em>
 
204
<a name="195" href="#195">195</a> <em>     * @return the scheme type</em>
 
205
<a name="196" href="#196">196</a> <em>     * </em>
 
206
<a name="197" href="#197">197</a> <em>     * @since 3.0</em>
 
207
<a name="198" href="#198">198</a> <em>     */</em>
 
208
<a name="199" href="#199">199</a>     <strong>public</strong> String getScheme() {
 
209
<a name="200" href="#200">200</a>         <strong>return</strong> <strong>this</strong>.scheme;
 
210
<a name="201" href="#201">201</a>     }
 
211
<a name="202" href="#202">202</a> 
 
212
<a name="203" href="#203">203</a>     <em>/**<em>* Determines if the given parameters are equal.</em></em>
 
213
<a name="204" href="#204">204</a> <em>     * </em>
 
214
<a name="205" href="#205">205</a> <em>     * @param p1 the parameter</em>
 
215
<a name="206" href="#206">206</a> <em>     * @param p2 the other parameter</em>
 
216
<a name="207" href="#207">207</a> <em>     * @return boolean true if the parameters are equal, otherwise false.</em>
 
217
<a name="208" href="#208">208</a> <em>     */</em>
 
218
<a name="209" href="#209">209</a>     <strong>private</strong> <strong>static</strong> <strong>boolean</strong> paramsEqual(<strong>final</strong> String p1, <strong>final</strong> String p2) {
 
219
<a name="210" href="#210">210</a>         <strong>if</strong> (p1 == <strong>null</strong>) {
 
220
<a name="211" href="#211">211</a>             <strong>return</strong> p1 == p2;
 
221
<a name="212" href="#212">212</a>         } <strong>else</strong> {
 
222
<a name="213" href="#213">213</a>             <strong>return</strong> p1.equals(p2);
 
223
<a name="214" href="#214">214</a>         }
 
224
<a name="215" href="#215">215</a>     }
 
225
<a name="216" href="#216">216</a> 
 
226
<a name="217" href="#217">217</a>     <em>/**<em>* Determines if the given parameters are equal.  </em></em>
 
227
<a name="218" href="#218">218</a> <em>     * </em>
 
228
<a name="219" href="#219">219</a> <em>     * @param p1 the parameter</em>
 
229
<a name="220" href="#220">220</a> <em>     * @param p2 the other parameter</em>
 
230
<a name="221" href="#221">221</a> <em>     * @return boolean true if the parameters are equal, otherwise false.</em>
 
231
<a name="222" href="#222">222</a> <em>     */</em>
 
232
<a name="223" href="#223">223</a>     <strong>private</strong> <strong>static</strong> <strong>boolean</strong> paramsEqual(<strong>int</strong> p1, <strong>int</strong> p2) {
 
233
<a name="224" href="#224">224</a>         <strong>return</strong> p1 == p2;
 
234
<a name="225" href="#225">225</a>     }
 
235
<a name="226" href="#226">226</a> 
 
236
<a name="227" href="#227">227</a>     <em>/**<em>*</em></em>
 
237
<a name="228" href="#228">228</a> <em>     * Tests if the authentication scopes match. </em>
 
238
<a name="229" href="#229">229</a> <em>     * </em>
 
239
<a name="230" href="#230">230</a> <em>     * @return the match factor. Negative value signifies no match. </em>
 
240
<a name="231" href="#231">231</a> <em>     *    Non-negative signifies a match. The greater the returned value </em>
 
241
<a name="232" href="#232">232</a> <em>     *    the closer the match.</em>
 
242
<a name="233" href="#233">233</a> <em>     * </em>
 
243
<a name="234" href="#234">234</a> <em>     * @since 3.0</em>
 
244
<a name="235" href="#235">235</a> <em>     */</em>
 
245
<a name="236" href="#236">236</a>     <strong>public</strong> <strong>int</strong> match(<strong>final</strong> <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> that) {
 
246
<a name="237" href="#237">237</a>         <strong>int</strong> factor = 0;
 
247
<a name="238" href="#238">238</a>         <strong>if</strong> (paramsEqual(<strong>this</strong>.scheme, that.scheme)) {
 
248
<a name="239" href="#239">239</a>             factor += 1;
 
249
<a name="240" href="#240">240</a>         } <strong>else</strong> {
 
250
<a name="241" href="#241">241</a>             <strong>if</strong> (<strong>this</strong>.scheme != ANY_SCHEME &amp;&amp; that.scheme != ANY_SCHEME) {
 
251
<a name="242" href="#242">242</a>                 <strong>return</strong> -1;
 
252
<a name="243" href="#243">243</a>             }
 
253
<a name="244" href="#244">244</a>         }
 
254
<a name="245" href="#245">245</a>         <strong>if</strong> (paramsEqual(<strong>this</strong>.realm, that.realm)) {
 
255
<a name="246" href="#246">246</a>             factor += 2;
 
256
<a name="247" href="#247">247</a>         } <strong>else</strong> {
 
257
<a name="248" href="#248">248</a>             <strong>if</strong> (<strong>this</strong>.realm != ANY_REALM &amp;&amp; that.realm != ANY_REALM) {
 
258
<a name="249" href="#249">249</a>                 <strong>return</strong> -1;
 
259
<a name="250" href="#250">250</a>             }
 
260
<a name="251" href="#251">251</a>         }
 
261
<a name="252" href="#252">252</a>         <strong>if</strong> (paramsEqual(<strong>this</strong>.port, that.port)) {
 
262
<a name="253" href="#253">253</a>             factor += 4;
 
263
<a name="254" href="#254">254</a>         } <strong>else</strong> {
 
264
<a name="255" href="#255">255</a>             <strong>if</strong> (<strong>this</strong>.port != ANY_PORT &amp;&amp; that.port != ANY_PORT) {
 
265
<a name="256" href="#256">256</a>                 <strong>return</strong> -1;
 
266
<a name="257" href="#257">257</a>             }
 
267
<a name="258" href="#258">258</a>         }
 
268
<a name="259" href="#259">259</a>         <strong>if</strong> (paramsEqual(<strong>this</strong>.host, that.host)) {
 
269
<a name="260" href="#260">260</a>             factor += 8;
 
270
<a name="261" href="#261">261</a>         } <strong>else</strong> {
 
271
<a name="262" href="#262">262</a>             <strong>if</strong> (<strong>this</strong>.host != ANY_HOST &amp;&amp; that.host != ANY_HOST) {
 
272
<a name="263" href="#263">263</a>                 <strong>return</strong> -1;
 
273
<a name="264" href="#264">264</a>             }
 
274
<a name="265" href="#265">265</a>         }
 
275
<a name="266" href="#266">266</a>         <strong>return</strong> factor;
 
276
<a name="267" href="#267">267</a>     }
 
277
<a name="268" href="#268">268</a> 
 
278
<a name="269" href="#269">269</a>     <em>/**<em>*</em></em>
 
279
<a name="270" href="#270">270</a> <em>     * @see java.lang.Object#equals(Object)</em>
 
280
<a name="271" href="#271">271</a> <em>     */</em>
 
281
<a name="272" href="#272">272</a>     <strong>public</strong> <strong>boolean</strong> equals(Object o) {
 
282
<a name="273" href="#273">273</a>         <strong>if</strong> (o == <strong>null</strong>) {
 
283
<a name="274" href="#274">274</a>             <strong>return</strong> false;
 
284
<a name="275" href="#275">275</a>         }
 
285
<a name="276" href="#276">276</a>         <strong>if</strong> (o == <strong>this</strong>) {
 
286
<a name="277" href="#277">277</a>             <strong>return</strong> <strong>true</strong>;
 
287
<a name="278" href="#278">278</a>         }
 
288
<a name="279" href="#279">279</a>         <strong>if</strong> (!(o instanceof AuthScope)) {
 
289
<a name="280" href="#280">280</a>             <strong>return</strong> <strong>super</strong>.equals(o);
 
290
<a name="281" href="#281">281</a>         }
 
291
<a name="282" href="#282">282</a>         <a href="../../../../../org/apache/commons/httpclient/auth/AuthScope.html">AuthScope</a> that = (AuthScope) o;
 
292
<a name="283" href="#283">283</a>         <strong>return</strong> 
 
293
<a name="284" href="#284">284</a>         paramsEqual(<strong>this</strong>.host, that.host) 
 
294
<a name="285" href="#285">285</a>           &amp;&amp; paramsEqual(<strong>this</strong>.port, that.port)
 
295
<a name="286" href="#286">286</a>           &amp;&amp; paramsEqual(<strong>this</strong>.realm, that.realm)
 
296
<a name="287" href="#287">287</a>           &amp;&amp; paramsEqual(<strong>this</strong>.scheme, that.scheme);
 
297
<a name="288" href="#288">288</a>     }
 
298
<a name="289" href="#289">289</a> 
 
299
<a name="290" href="#290">290</a>     <em>/**<em>*</em></em>
 
300
<a name="291" href="#291">291</a> <em>     * @see java.lang.Object#toString()</em>
 
301
<a name="292" href="#292">292</a> <em>     */</em>
 
302
<a name="293" href="#293">293</a>     <strong>public</strong> String toString() {
 
303
<a name="294" href="#294">294</a>         StringBuffer buffer = <strong>new</strong> StringBuffer();
 
304
<a name="295" href="#295">295</a>         <strong>if</strong> (<strong>this</strong>.scheme != <strong>null</strong>) {
 
305
<a name="296" href="#296">296</a>             buffer.append(<strong>this</strong>.scheme.toUpperCase());
 
306
<a name="297" href="#297">297</a>             buffer.append(' ');
 
307
<a name="298" href="#298">298</a>         }
 
308
<a name="299" href="#299">299</a>         <strong>if</strong> (<strong>this</strong>.realm != <strong>null</strong>) {
 
309
<a name="300" href="#300">300</a>             buffer.append('\'');
 
310
<a name="301" href="#301">301</a>             buffer.append(<strong>this</strong>.realm);
 
311
<a name="302" href="#302">302</a>             buffer.append('\'');
 
312
<a name="303" href="#303">303</a>         } <strong>else</strong> {
 
313
<a name="304" href="#304">304</a>             buffer.append(<span class="string">"&lt;any realm>"</span>);
 
314
<a name="305" href="#305">305</a>         }
 
315
<a name="306" href="#306">306</a>         <strong>if</strong> (<strong>this</strong>.host != <strong>null</strong>) {
 
316
<a name="307" href="#307">307</a>             buffer.append('@');
 
317
<a name="308" href="#308">308</a>             buffer.append(<strong>this</strong>.host);
 
318
<a name="309" href="#309">309</a>             <strong>if</strong> (<strong>this</strong>.port >= 0) {
 
319
<a name="310" href="#310">310</a>                 buffer.append(':');
 
320
<a name="311" href="#311">311</a>                 buffer.append(<strong>this</strong>.port);
 
321
<a name="312" href="#312">312</a>             }
 
322
<a name="313" href="#313">313</a>         }
 
323
<a name="314" href="#314">314</a>         <strong>return</strong> buffer.toString();
 
324
<a name="315" href="#315">315</a>     }
 
325
<a name="316" href="#316">316</a>     
 
326
<a name="317" href="#317">317</a>     <em>/**<em>*</em></em>
 
327
<a name="318" href="#318">318</a> <em>     * @see java.lang.Object#hashCode()</em>
 
328
<a name="319" href="#319">319</a> <em>     */</em>
 
329
<a name="320" href="#320">320</a>     <strong>public</strong> <strong>int</strong> hashCode() {
 
330
<a name="321" href="#321">321</a>         <strong>int</strong> hash = LangUtils.HASH_SEED;
 
331
<a name="322" href="#322">322</a>         hash = LangUtils.hashCode(hash, <strong>this</strong>.host);
 
332
<a name="323" href="#323">323</a>         hash = LangUtils.hashCode(hash, <strong>this</strong>.port);
 
333
<a name="324" href="#324">324</a>         hash = LangUtils.hashCode(hash, <strong>this</strong>.realm);
 
334
<a name="325" href="#325">325</a>         hash = LangUtils.hashCode(hash, <strong>this</strong>.scheme);
 
335
<a name="326" href="#326">326</a>         <strong>return</strong> hash;
 
336
<a name="327" href="#327">327</a>     }
 
337
<a name="328" href="#328">328</a> }
 
338
</pre>
 
339
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
 
340
</html>
 
341