All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.httpclient.UsernamePasswordCredentials Maven / Gradle / Ivy

There is a newer version: 2024.11.18751.20241128T090041Z-241100
Show newest version
/*
 * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/UsernamePasswordCredentials.java,v 1.14 2004/04/18 23:51:35 jsdever Exp $
 * $Revision: 480424 $
 * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
 *
 * ====================================================================
 *
 *  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.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * .
 *
 */

package org.apache.commons.httpclient;

import org.apache.commons.httpclient.util.LangUtils;

/**
 * 

Username and password {@link Credentials}.

* * @author Remy Maucherat * @author Sean C. Sullivan * @author Mike Bowler * @author Oleg Kalnichevski * * @version $Revision: 480424 $ $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $ * * @deprecated Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. * It is not recommended to use it in any new code. * Instead, use HTTP client API plugins as a dependency in your code. * E.g. * Apache HttpComponents Client API 4.x Plugin or * Async HTTP Client Plugin. * */ @Deprecated public class UsernamePasswordCredentials implements Credentials { // ----------------------------------------------------------- Constructors /** * Default constructor. * * @deprecated Do not use. Null user name no longer allowed */ public UsernamePasswordCredentials() { super(); } /** * The constructor with the username and password combined string argument. * * @param usernamePassword the username:password formed string * @see #toString */ public UsernamePasswordCredentials(String usernamePassword) { super(); if (usernamePassword == null) { throw new IllegalArgumentException("Username:password string may not be null"); } int atColon = usernamePassword.indexOf(':'); if (atColon >= 0) { this.userName = usernamePassword.substring(0, atColon); this.password = usernamePassword.substring(atColon + 1); } else { this.userName = usernamePassword; } } /** * The constructor with the username and password arguments. * * @param userName the user name * @param password the password */ public UsernamePasswordCredentials(String userName, String password) { super(); if (userName == null) { throw new IllegalArgumentException("Username may not be null"); } this.userName = userName; this.password = password; } // ----------------------------------------------------- Instance Variables /** * User name. */ private String userName; /** * Password. */ private String password; // ------------------------------------------------------------- Properties /** * User name property setter. User name may not be null. * * @param userName * @see #getUserName() * * @deprecated Do not use. The UsernamePasswordCredentials objects should be immutable */ public void setUserName(String userName) { if (userName == null) { throw new IllegalArgumentException("Username may not be null"); } this.userName = userName; } /** * User name property getter. * * @return the userName * @see #setUserName(String) */ public String getUserName() { return userName; } /** * Password property setter. * * @param password * @see #getPassword() * * @deprecated Do not use. The UsernamePasswordCredentials objects should be immutable */ public void setPassword(String password) { this.password = password; } /** * Password property getter. * * @return the password * @see #setPassword(String) */ public String getPassword() { return password; } /** * Get this object string. * * @return the username:password formed string */ public String toString() { StringBuffer result = new StringBuffer(); result.append(this.userName); result.append(":"); result.append((this.password == null) ? "null" : this.password); return result.toString(); } /** * Does a hash of both user name and password. * * @return The hash code including user name and password. */ public int hashCode() { int hash = LangUtils.HASH_SEED; hash = LangUtils.hashCode(hash, this.userName); hash = LangUtils.hashCode(hash, this.password); return hash; } /** * These credentials are assumed equal if the username and password are the * same. * * @param o The other object to compare with. * * @return true if the object is equivalent. */ public boolean equals(Object o) { if (o == null) return false; if (this == o) return true; // note - to allow for sub-classing, this checks that class is the same // rather than do "instanceof". if (this.getClass().equals(o.getClass())) { UsernamePasswordCredentials that = (UsernamePasswordCredentials) o; if (LangUtils.equals(this.userName, that.userName) && LangUtils.equals(this.password, that.password) ) { return true; } } return false; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy