org.netbeans.modules.proxy.ConnectivitySettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org-netbeans-modules-versioning-util
There is a newer version: RELEASE240
/*
 * 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.netbeans.modules.proxy;

import java.net.InetSocketAddress;

/**
 * This data object encapsulates parameters that are needed to establish connection to an arbitrary remote IP address.
 * There are basically 2 types of connectivity:
 * 
 * direct connection (without any firewall or proxy, or with a transparent proxy)
 * 
mediated connection that routes via a firewall or proxy
 * 
 * If this object represents a direct connection type, no further parameters are required. If this object
 * represents a proxy connection, it also hold the proxy type, address, and port. Other optional parameters
 * include proxy username and password.
 *
 * @author Maros Sandor
 */
public class ConnectivitySettings {
    /**
     * Connection type constant for a direct connection.
     */
    public static final int CONNECTION_DIRECT = 0;

    /**
     * Connection type constant for connection via SOCKS proxies.
     */
    public static final int CONNECTION_VIA_SOCKS = 1;

    /**
     * Connection type constant for connection via HTTP proxies.
     */
    public static final int CONNECTION_VIA_HTTPS = 2;

    private static final int CONNECTION_TYPE_MIN = CONNECTION_DIRECT;
    private static final int CONNECTION_TYPE_MAX = CONNECTION_VIA_HTTPS;

    private int     mConnectionType;
    private String  mProxyHost;
    private int     mProxyPort;
    private String  mProxyUsername;
    private char[]  mProxyPassword;
    private int     mKeepAliveIntervalSeconds;

    public String toString() {
        return "Type: " + mConnectionType + " Proxy: " + mProxyUsername + "@" + mProxyHost + ":" + mProxyPort;
    }

    /**
     * Constructs connectivity settings with the default connection setting (direct connection).
     */
    public ConnectivitySettings() {
        mConnectionType = CONNECTION_DIRECT;
        mKeepAliveIntervalSeconds = 60;
    }

    /**
     * Changes configuration of this connectivity settings.
     *
     * @param type          one of the connection type constants
     * @param host          proxy hostname, must not be null for proxy configurations, is ignored for direct connectivity.
     * @param port          proxy port, must be in range 1-65535 for proxy configurations, is ignored for direct connectivity.
     * @param username      a username to supply to proxy when it request user authentication, may be null if the proxy
     *                      does not require authentication or we use direct connection
     * @param proxyPassword password to supply to proxy when it request user authentication, may be null if the proxy
     *                      does not require authentication or we use direct connection
     * @throws java.lang.IllegalArgumentException
     *          if the connection type constant is illegal, the proxy number is out of range or
     *          the proxy host is empty or null (for non-direct connections)
     */
    public void setProxy(int type, String host, int port, String username, char[] proxyPassword) {
        if (type < CONNECTION_TYPE_MIN || type > CONNECTION_TYPE_MAX) throw new IllegalArgumentException("Illegal connection type");

        if (type != CONNECTION_DIRECT) {
            if (port < 1 || port > 65535) throw new IllegalArgumentException("Illegal proxy port number: " + port);
            if (host == null || (host = host.trim()).length() == 0) throw new IllegalArgumentException("A proxy host must be specified");
        }

        mConnectionType = type;
        mProxyHost = host;
        mProxyPort = port;
        mProxyUsername = username;
        mProxyPassword = proxyPassword;
    }

    public int getKeepAliveIntervalSeconds() {
        return mKeepAliveIntervalSeconds;
    }

    public void setKeepAliveIntervalSeconds(int keepAliveIntervalSeconds) {
        mKeepAliveIntervalSeconds = keepAliveIntervalSeconds;
    }

    public int getConnectionType() {
        return mConnectionType;
    }

    public void setConnectionType(int connectionType) {
        mConnectionType = connectionType;
    }

    public String getProxyHost() {
        return mProxyHost;
    }

    public void setProxyHost(String proxyHost) {
        mProxyHost = proxyHost;
    }

    public int getProxyPort() {
        return mProxyPort;
    }

    public void setProxyPort(int proxyPort) {
        mProxyPort = proxyPort;
    }

    public String getProxyUsername() {
        return mProxyUsername;
    }

    public void setProxyUsername(String proxyUsername) {
        mProxyUsername = proxyUsername;
    }

    public char[] getProxyPassword() {
        return mProxyPassword;
    }

    public void setProxyPassword(char[] proxyPassword) {
        mProxyPassword = proxyPassword;
    }
}