jgit/org.eclipse.jgit.ssh.apache/src/org/eclipse/jgit/transport/sshd/ProxyData.java

/*
 * Copyright (C) 2018, Thomas Wolf <thomas.wolf@paranor.ch>
 * and other copyright owners as documented in the project's IP log.
 *
 * This program and the accompanying materials are made available
 * under the terms of the Eclipse Distribution License v1.0 which
 * accompanies this distribution, is reproduced below, and is
 * available at http://www.eclipse.org/org/documents/edl-v10.php
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above
 *   copyright notice, this list of conditions and the following
 *   disclaimer in the documentation and/or other materials provided
 *   with the distribution.
 *
 * - Neither the name of the Eclipse Foundation, Inc. nor the
 *   names of its contributors may be used to endorse or promote
 *   products derived from this software without specific prior
 *   written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.eclipse.jgit.transport.sshd;

import java.net.InetSocketAddress;
import java.net.Proxy;
import java.util.Arrays;

import org.eclipse.jgit.annotations.NonNull;

/**
 * A DTO encapsulating the data needed to connect through a proxy server.
 *
 * @since 5.2
 */
public class ProxyData {

	private final @NonNull Proxy proxy;

	private final String proxyUser;

	private final char[] proxyPassword;

	/**
	 * Creates a new {@link ProxyData} instance without user name or password.
	 *
	 * @param proxy
	 *            to connect to; must not be {@link java.net.Proxy.Type#DIRECT}
	 *            and must have an {@link InetSocketAddress}.
	 */
	public ProxyData(@NonNull Proxy proxy) {
		this(proxy, null, null);
	}

	/**
	 * Creates a new {@link ProxyData} instance.
	 *
	 * @param proxy
	 *            to connect to; must not be {@link java.net.Proxy.Type#DIRECT}
	 *            and must have an {@link InetSocketAddress}.
	 * @param proxyUser
	 *            to use for log-in to the proxy, may be {@code null}
	 * @param proxyPassword
	 *            to use for log-in to the proxy, may be {@code null}
	 */
	public ProxyData(@NonNull Proxy proxy, String proxyUser,
			char[] proxyPassword) {
		this.proxy = proxy;
		if (!(proxy.address() instanceof InetSocketAddress)) {
			// Internal error not translated
			throw new IllegalArgumentException(
					"Proxy does not have an InetSocketAddress"); //$NON-NLS-1$
		}
		this.proxyUser = proxyUser;
		this.proxyPassword = proxyPassword == null ? null
				: proxyPassword.clone();
	}

	/**
	 * Obtains the remote {@link InetSocketAddress} of the proxy to connect to.
	 *
	 * @return the remote address of the proxy
	 */
	@NonNull
	public Proxy getProxy() {
		return proxy;
	}

	/**
	 * Obtains the user to log in at the proxy with.
	 *
	 * @return the user name, or {@code null} if none
	 */
	public String getUser() {
		return proxyUser;
	}

	/**
	 * Obtains a copy of the internally stored password.
	 *
	 * @return the password or {@code null} if none
	 */
	public char[] getPassword() {
		return proxyPassword == null ? null : proxyPassword.clone();
	}

	/**
	 * Clears the stored password, if any.
	 */
	public void clearPassword() {
		if (proxyPassword != null) {
			Arrays.fill(proxyPassword, '\000');
		}
	}

}