org.eclipse.aether.repository.Proxy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of standalone-sisu-uber Show documentation
There is a newer version: 3.0.0-alpha-3
/*
 * 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.eclipse.aether.repository;

import java.util.Objects;

/**
 * A proxy to use for connections to a repository.
 */
public final class Proxy {

    /**
     * Type denoting a proxy for HTTP transfers.
     */
    public static final String TYPE_HTTP = "http";

    /**
     * Type denoting a proxy for HTTPS transfers.
     */
    public static final String TYPE_HTTPS = "https";

    private final String type;

    private final String host;

    private final int port;

    private final Authentication auth;

    /**
     * Creates a new proxy with the specified properties and no authentication.
     *
     * @param type The type of the proxy, e.g. "http", may be {@code null}.
     * @param host The host of the proxy, may be {@code null}.
     * @param port The port of the proxy.
     */
    public Proxy(String type, String host, int port) {
        this(type, host, port, null);
    }

    /**
     * Creates a new proxy with the specified properties.
     *
     * @param type The type of the proxy, e.g. "http", may be {@code null}.
     * @param host The host of the proxy, may be {@code null}.
     * @param port The port of the proxy.
     * @param auth The authentication to use for the proxy connection, may be {@code null}.
     */
    public Proxy(String type, String host, int port, Authentication auth) {
        this.type = (type != null) ? type : "";
        this.host = (host != null) ? host : "";
        this.port = port;
        this.auth = auth;
    }

    /**
     * Gets the type of this proxy.
     *
     * @return The type of this proxy, never {@code null}.
     */
    public String getType() {
        return type;
    }

    /**
     * Gets the host for this proxy.
     *
     * @return The host for this proxy, never {@code null}.
     */
    public String getHost() {
        return host;
    }

    /**
     * Gets the port number for this proxy.
     *
     * @return The port number for this proxy.
     */
    public int getPort() {
        return port;
    }

    /**
     * Gets the authentication to use for the proxy connection.
     *
     * @return The authentication to use or {@code null} if none.
     */
    public Authentication getAuthentication() {
        return auth;
    }

    @Override
    public String toString() {
        return getHost() + ':' + getPort();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null || !getClass().equals(obj.getClass())) {
            return false;
        }

        Proxy that = (Proxy) obj;

        return Objects.equals(type, that.type)
                && Objects.equals(host, that.host)
                && port == that.port
                && Objects.equals(auth, that.auth);
    }

    @Override
    public int hashCode() {
        int hash = 17;
        hash = hash * 31 + hash(host);
        hash = hash * 31 + hash(type);
        hash = hash * 31 + port;
        hash = hash * 31 + hash(auth);
        return hash;
    }

    private static int hash(Object obj) {
        return obj != null ? obj.hashCode() : 0;
    }
}