View Javadoc

1   /*
2    * $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 $
3    * $Revision: 155418 $
4    * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
5    *
6    * ====================================================================
7    *
8    *  Copyright 2002-2004 The Apache Software Foundation
9    *
10   *  Licensed under the Apache License, Version 2.0 (the "License");
11   *  you may not use this file except in compliance with the License.
12   *  You may obtain a copy of the License at
13   *
14   *      http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *  Unless required by applicable law or agreed to in writing, software
17   *  distributed under the License is distributed on an "AS IS" BASIS,
18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *  See the License for the specific language governing permissions and
20   *  limitations under the License.
21   * ====================================================================
22   *
23   * This software consists of voluntary contributions made by many
24   * individuals on behalf of the Apache Software Foundation.  For more
25   * information on the Apache Software Foundation, please see
26   * <http://www.apache.org/>.
27   *
28   */
29  
30  package org.apache.commons.httpclient.auth;
31  
32  import org.apache.commons.httpclient.Credentials;
33  
34  /***
35   * <p>
36   * Credentials provider interface can be used to provide {@link 
37   * org.apache.commons.httpclient.HttpMethod HTTP method} with a means 
38   * to request authentication credentials if no credentials have been given 
39   * or given credentials are incorrect. 
40   * </p>
41   * 
42   * Classes implementing this interface must synchronize access to shared
43   * data as methods of this interfrace may be executed from multiple threads 
44   * 
45   * @author Ortwin Glueck
46   * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
47   * 
48   * @since 3.0
49   */
50  public interface CredentialsProvider {
51  
52      /***
53       * Sets the credentials provider parameter.
54       * <p>
55       * This parameter expects a value of type {@link CredentialsProvider}.
56       * </p>
57       */ 
58      public static final String PROVIDER = "http.authentication.credential-provider";
59      
60      /***
61       * Requests additional {@link Credentials authentication credentials}.
62       * 
63       * @param scheme the {@link AuthScheme authentication scheme}
64       * @param host the authentication host
65       * @param port the port of the authentication host
66       * @param proxy <tt>true</tt> if authenticating with a proxy,
67       *              <tt>false</tt> otherwise
68       */ 
69      public Credentials getCredentials(
70          final AuthScheme scheme, 
71          final String host, 
72          int port, 
73          boolean proxy) throws CredentialsNotAvailableException; 
74  
75  }