/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.dbcp.datasources;

import java.io.Serializable;

Holds a username, password pair.  Serves as a poolable object key for the KeyedObjectPool
backing a SharedPoolDataSource.  Two instances with the same username are considered equal.
This ensures that there will be only one keyed pool for each user in the pool.  The password
is used (along with the username) by the KeyedCPDSConnectionFactory when creating new connections.
InstanceKeyDataSource.getConnection(String, String) validates that the password used to create a connection matches the password provided by the client.
Version:
$Revision: 907288 $ $Date: 2010-02-06 14:42:58 -0500 (Sat, 06 Feb 2010) $/**
 * <p>Holds a username, password pair.  Serves as a poolable object key for the KeyedObjectPool
 * backing a SharedPoolDataSource.  Two instances with the same username are considered equal.
 * This ensures that there will be only one keyed pool for each user in the pool.  The password
 * is used (along with the username) by the KeyedCPDSConnectionFactory when creating new connections.</p>
 * 
 * <p>{@link InstanceKeyDataSource#getConnection(String, String)} validates that the password used to create
 * a connection matches the password provided by the client.</p>
 * 
 * @version $Revision: 907288 $ $Date: 2010-02-06 14:42:58 -0500 (Sat, 06 Feb 2010) $
 */
class UserPassKey implements Serializable {
    private static final long serialVersionUID = 5142970911626584817L;
    private final String password;
    private final String username;
    
    UserPassKey(String username, String password) {
        this.username = username;
        this.password = password;
    }
        
    
Get the value of password.
Returns:
value of password./**
     * Get the value of password.
     * @return value of password.
     */
    public String getPassword() {
        return password;
    }
    
    
Get the value of username.
Returns:
value of username./**
     * Get the value of username.
     * @return value of username.
     */
    public String getUsername() {
        return username;
    }
    
    
See Also:
Object.equals(Object)
Returns:
true if the username fields for both 
objects are equal.  Two instances with the same username
but different passwords are considered equal./**
     * @return <code>true</code> if the username fields for both 
     * objects are equal.  Two instances with the same username
     * but different passwords are considered equal.
     * 
     * @see java.lang.Object#equals(java.lang.Object)
     */
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }

        if (obj == this) {
            return true;
        }
        
        if (!(obj instanceof UserPassKey)) {
            return false;
        }
        
        UserPassKey key = (UserPassKey) obj;
        
        return this.username == null ?
                key.username == null :
                this.username.equals(key.username);       
    }

    
Returns the hash of the username. 
/**
     * Returns the hash of the username. 
     */
    public int hashCode() {
        return (this.username != null ?
                (this.username).hashCode() : 0);
    }

    public String toString() {
        StringBuffer sb = new StringBuffer(50);
        sb.append("UserPassKey(");
        sb.append(username).append(", ").append(password).append(')');
        return sb.toString();
    }
}