org.htmlunit.httpclient.HtmlUnitUsernamePasswordCredentials Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2002-2024 Gargoyle Software Inc.
 *
 * Licensed 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
 * https://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.htmlunit.httpclient;

import java.io.Serializable;
import java.security.Principal;

import org.apache.http.auth.Credentials;
import org.apache.http.auth.UsernamePasswordCredentials;
import org.apache.http.util.LangUtils;

/**
 * Wrapper for {@link UsernamePasswordCredentials} to avoid direct references spread around.
 *
 * @author Ronald Brill
 */
public class HtmlUnitUsernamePasswordCredentials implements Credentials, Serializable {

    private final UsernamePasswordCredentials httpClientUsernamePasswordCredentials_;

    /**
     * The constructor with the username and password arguments.
     *
     * @param userName the user name
     * @param password the password
     *
     * @deprecated as of version 3.4.0; use HtmlUnitUsernamePasswordCredentials(String, char[]) instead
     */
    @Deprecated
    public HtmlUnitUsernamePasswordCredentials(final String userName, final String password) {
        httpClientUsernamePasswordCredentials_ = new UsernamePasswordCredentials(userName, password);
    }

    /**
     * The constructor with the username and password arguments.
     *
     * @param userName the user name
     * @param password the password
     */
    public HtmlUnitUsernamePasswordCredentials(final String userName, final char[] password) {
        httpClientUsernamePasswordCredentials_ = new UsernamePasswordCredentials(userName, String.valueOf(password));
    }

    @Override
    public String getPassword() {
        return httpClientUsernamePasswordCredentials_.getPassword();
    }

    @Override
    public Principal getUserPrincipal() {
        return httpClientUsernamePasswordCredentials_.getUserPrincipal();
    }

    @Override
    public int hashCode() {
        return getUserPrincipal().hashCode();
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o instanceof HtmlUnitUsernamePasswordCredentials) {
            final HtmlUnitUsernamePasswordCredentials that = (HtmlUnitUsernamePasswordCredentials) o;
            if (LangUtils.equals(this.getUserPrincipal(), that.getUserPrincipal())) {
                return true;
            }
        }
        return false;
    }

    @Override
    public String toString() {
        return getUserPrincipal().toString();
    }
}