~testplan-team/testplan/source-collection

<a name="2" href="#2">2</a> * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/auth/CredentialsProvider.java,v 1.6 2004/07/05 22:46:59 olegk Exp $

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

<a name="4" href="#4">4</a> * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $

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

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

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

<a name="8" href="#8">8</a> * Licensed to the Apache Software Foundation (ASF) under one or more

<a name="9" href="#9">9</a> * contributor license agreements. See the NOTICE file distributed with

<a name="10" href="#10">10</a> * this work for additional information regarding copyright ownership.

<a name="11" href="#11">11</a> * The ASF licenses this file to You under the Apache License, Version 2.0

<a name="12" href="#12">12</a> * (the "License"); you may not use this file except in compliance with

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

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

<a name="15" href="#15">15</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="16" href="#16">16</a> *

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

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

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

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

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

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

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

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

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

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

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

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

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

<a name="31" href="#31">31</a> package org.apache.commons.httpclient.auth;

<a name="33" href="#33">33</a> import org.apache.commons.httpclient.Credentials;

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

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

<a name="37" href="#37">37</a> * Credentials provider interface can be used to provide {@link

<a name="38" href="#38">38</a> * org.apache.commons.httpclient.HttpMethod HTTP method} with a means to request

<a name="39" href="#39">39</a> * authentication credentials if no credentials have been given or given

<a name="40" href="#40">40</a> * credentials are incorrect.

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

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

<a name="43" href="#43">43</a> * HttpClient makes no provisions to check whether the same credentials have

<a name="44" href="#44">44</a> * been tried already. It is a responsibility of the custom credentials provider

<a name="45" href="#45">45</a> * to keep track of authentication attempts and to ensure that credentials known

<a name="46" href="#46">46</a> * to be invalid are not retried. HttpClient will simply store the set of

<a name="47" href="#47">47</a> * credentials returned by the custom credentials provider in the

<a name="48" href="#48">48</a> * {@link org.apache.commons.httpclient.HttpState http state} object and will

<a name="49" href="#49">49</a> * attempt to use these credentials for all subsequent requests with the given

<a name="50" href="#50">50</a> * authentication scope.

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

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

<a name="53" href="#53">53</a> * Classes implementing this interface must synchronize access to shared data as

<a name="54" href="#54">54</a> * methods of this interfrace may be executed from multiple threads

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

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

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

<a name="58" href="#58">58</a> * @author Ortwin Glueck

<a name="59" href="#59">59</a> * @author <a href="<a href="mailto:oleg@ural.ru" target="alexandria_uri">mailto:oleg@ural.ru</a>">Oleg Kalnichevski</a>

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

<a name="61" href="#61">61</a> * @since 3.0

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

<a name="63" href="#63">63</a> public interface <a href="../../../../../org/apache/commons/httpclient/auth/CredentialsProvider.html">CredentialsProvider</a> {

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

<a name="66" href="#66">66</a> * Sets the credentials provider parameter.

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

<a name="68" href="#68">68</a> * This parameter expects a value of type {@link CredentialsProvider}.

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

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

<a name="71" href="#71">71</a> public static final String PROVIDER = "http.authentication.credential-provider";

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

<a name="74" href="#74">74</a> * Requests additional {@link Credentials authentication credentials}.

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

<a name="76" href="#76">76</a> * @param scheme the {@link AuthScheme authentication scheme}

<a name="77" href="#77">77</a> * @param host the authentication host

<a name="78" href="#78">78</a> * @param port the port of the authentication host

<a name="79" href="#79">79</a> * @param proxy <tt>true</tt> if authenticating with a proxy,

<a name="80" href="#80">80</a> * <tt>false</tt> otherwise

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

<a name="82" href="#82">82</a> public <a href="../../../../../org/apache/commons/httpclient/Credentials.html">Credentials</a> getCredentials(

<a name="83" href="#83">83</a> final <a href="../../../../../org/apache/commons/httpclient/auth/AuthScheme.html">AuthScheme</a> scheme,

<a name="84" href="#84">84</a> final String host,

<a name="85" href="#85">85</a> int port,

<a name="86" href="#86">86</a> boolean proxy) throws CredentialsNotAvailableException;

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

</pre>

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

100

</html>

101

Older »