1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/auth/HttpAuthRealm.java,v 1.3.2.1 2003/12/14 22:41:37 mbecke Exp $
3 * $Revision: 1.3.2.1 $
4 * $Date: 2003/12/14 22:41:37 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient.auth;
65
66 /*** The key used to look up authentication credentials.
67 *
68 * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
69 * @author <a href="mailto:adrian@intencha.com">Adrian Sutton</a>
70 */
71 public class HttpAuthRealm {
72
73 /*** The realm the credentials apply to. */
74 private String realm = null;
75
76 /*** The domain the credentials apply to. */
77 private String domain = null;
78
79 /*** Creates a new HttpAuthRealm for the given <tt>domain</tt> and
80 * <tt>realm</tt>.
81 *
82 * @param domain the domain the credentials apply to. May be set
83 * to <tt>null</tt> if credenticals are applicable to
84 * any domain.
85 * @param realm the realm the credentials apply to. May be set
86 * to <tt>null</tt> if credenticals are applicable to
87 * any realm.
88 *
89 */
90 public HttpAuthRealm(final String domain, final String realm) {
91 this.domain = domain;
92 this.realm = realm;
93 }
94
95 /*** Determines if the given domains match. Note that <tt>null</tt> acts as a
96 * wildcard so if either of the domains are <tt>null</tt>, it is considered a match.
97 *
98 * @param d1 the domain
99 * @param d2 the other domain
100 * @return boolean true if the domains match, otherwise false.
101 */
102 private static boolean domainAttribMatch(final String d1, final String d2) {
103 return d1 == null || d2 == null || d1.equalsIgnoreCase(d2);
104 }
105
106 /*** Determines if the given realms match. Note that <tt>null</tt> acts as a
107 * wildcard so if either realm is <tt>null</tt>, this function will return <tt>true</tt>.
108 *
109 * @param r1 the realm
110 * @param r2 the other realm
111 * @return boolean true if the realms match, otherwise false.
112 */
113 private static boolean realmAttribMatch(final String r1, final String r2) {
114 return r1 == null || r2 == null || r1.equals(r2);
115 }
116
117
118 /***
119 * @see java.lang.Object#equals(Object)
120 */
121 public boolean equals(Object o) {
122 if (o == null) {
123 return false;
124 }
125 if (o == this) {
126 return true;
127 }
128 if (!(o instanceof HttpAuthRealm)) {
129 return super.equals(o);
130 }
131 HttpAuthRealm that = (HttpAuthRealm) o;
132 return
133 domainAttribMatch(this.domain, that.domain)
134 && realmAttribMatch(this.realm, that.realm);
135 }
136
137 /***
138 * @see java.lang.Object#toString()
139 */
140 public String toString() {
141 StringBuffer buffer = new StringBuffer();
142 buffer.append("Authentication domain: '");
143 buffer.append(this.domain);
144 buffer.append("', authentication realm: '");
145 buffer.append(this.realm);
146 buffer.append("'");
147 return buffer.toString();
148 }
149 /***
150 * @see java.lang.Object#hashCode()
151 */
152 public int hashCode() {
153 StringBuffer buffer = new StringBuffer();
154 buffer.append(this.domain);
155 buffer.append(this.realm);
156 return buffer.toString().hashCode();
157 }
158
159 }
This page was automatically generated by Maven