View Javadoc

1   /*
2    * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/AuthSchemeBase.java,v 1.3.2.1 2004/02/22 18:21:14 olegk Exp $
3    * $Revision: 1.3.2.1 $
4    * $Date: 2004/02/22 18:21:14 $
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   * [Additional notices, if required by prior licensing conditions]
29   *
30   */
31  
32  package org.apache.commons.httpclient.auth;
33  
34  /***
35   * <p>
36   * Abstract authentication scheme class that implements {@link AuthScheme}
37   * interface and provides a default contstructor.
38   * </p>
39   *
40   * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
41   */
42  public abstract class AuthSchemeBase implements AuthScheme {
43  
44      /***
45       * Original challenge string as received from the server.
46       */
47      private String challenge = null;
48  
49      /***
50       * Constructor for an abstract authetication schemes.
51       * 
52       * @param challenge authentication challenge
53       * 
54       * @throws MalformedChallengeException is thrown if the authentication challenge
55       * is malformed
56       */
57      public AuthSchemeBase(final String challenge) 
58        throws MalformedChallengeException {
59          super();
60          if (challenge == null) {
61              throw new IllegalArgumentException("Challenge may not be null"); 
62          }
63          this.challenge = challenge;
64      }
65  
66      /***
67       * @see java.lang.Object#equals(Object)
68       */
69      public boolean equals(Object obj) {
70          if (obj instanceof AuthSchemeBase) {
71              return this.challenge.equals(((AuthSchemeBase) obj).challenge);
72          } else {
73              return super.equals(obj);
74          }
75      }
76  
77      /***
78       * @see java.lang.Object#hashCode()
79       */
80      public int hashCode() {
81          return this.challenge.hashCode();
82      }
83  
84      /***
85       * @see java.lang.Object#toString()
86       */
87      public String toString() {
88          return this.challenge;
89      }
90  }