001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.proxy;
043:
044: import java.net.InetSocketAddress;
045:
046: /**
047: * This data object encapsulates parameters that are needed to establish connection to an arbitrary remote IP address.
048: * There are basically 2 types of connectivity:
049: * <ul>
050: * <li>direct connection (without any firewall or proxy, or with a transparent proxy)
051: * <li>mediated connection that routes via a firewall or proxy
052: * </ul>
053: * If this object represents a direct connection type, no further parameters are required. If this object
054: * represents a proxy connection, it also hold the proxy type, address, and port. Other optional parameters
055: * include proxy username and password.
056: *
057: * @author Maros Sandor
058: */
059: public class ConnectivitySettings {
060: /**
061: * Connection type constant for a direct connection.
062: */
063: public static final int CONNECTION_DIRECT = 0;
064:
065: /**
066: * Connection type constant for connection via SOCKS proxies.
067: */
068: public static final int CONNECTION_VIA_SOCKS = 1;
069:
070: /**
071: * Connection type constant for connection via HTTP proxies.
072: */
073: public static final int CONNECTION_VIA_HTTPS = 2;
074:
075: private static final int CONNECTION_TYPE_MIN = CONNECTION_DIRECT;
076: private static final int CONNECTION_TYPE_MAX = CONNECTION_VIA_HTTPS;
077:
078: private int mConnectionType;
079: private String mProxyHost;
080: private int mProxyPort;
081: private String mProxyUsername;
082: private char[] mProxyPassword;
083: private int mKeepAliveIntervalSeconds;
084:
085: public String toString() {
086: return "Type: " + mConnectionType + " Proxy: " + mProxyUsername
087: + "@" + mProxyHost + ":" + mProxyPort;
088: }
089:
090: /**
091: * Constructs connectivity settings with the default connection setting (direct connection).
092: */
093: public ConnectivitySettings() {
094: mConnectionType = CONNECTION_DIRECT;
095: mKeepAliveIntervalSeconds = 60;
096: }
097:
098: /**
099: * Changes configuration of this connectivity settings.
100: *
101: * @param type one of the connection type constants
102: * @param host proxy hostname, must not be null for proxy configurations, is ignored for direct connectivity.
103: * @param port proxy port, must be in range 1-65535 for proxy configurations, is ignored for direct connectivity.
104: * @param username a username to supply to proxy when it request user authentication, may be null if the proxy
105: * does not require authentication or we use direct connection
106: * @param proxyPassword password to supply to proxy when it request user authentication, may be null if the proxy
107: * does not require authentication or we use direct connection
108: * @throws java.lang.IllegalArgumentException
109: * if the connection type constant is illegal, the proxy number is out of range or
110: * the proxy host is empty or null (for non-direct connections)
111: */
112: public void setProxy(int type, String host, int port,
113: String username, char[] proxyPassword) {
114: if (type < CONNECTION_TYPE_MIN || type > CONNECTION_TYPE_MAX)
115: throw new IllegalArgumentException(
116: "Illegal connection type");
117:
118: if (type != CONNECTION_DIRECT) {
119: if (port < 1 || port > 65535)
120: throw new IllegalArgumentException(
121: "Illegal proxy port number: " + port);
122: if (host == null || (host = host.trim()).length() == 0)
123: throw new IllegalArgumentException(
124: "A proxy host must be specified");
125: }
126:
127: mConnectionType = type;
128: mProxyHost = host;
129: mProxyPort = port;
130: mProxyUsername = username;
131: mProxyPassword = proxyPassword;
132: }
133:
134: public int getKeepAliveIntervalSeconds() {
135: return mKeepAliveIntervalSeconds;
136: }
137:
138: public void setKeepAliveIntervalSeconds(int keepAliveIntervalSeconds) {
139: mKeepAliveIntervalSeconds = keepAliveIntervalSeconds;
140: }
141:
142: public int getConnectionType() {
143: return mConnectionType;
144: }
145:
146: public void setConnectionType(int connectionType) {
147: mConnectionType = connectionType;
148: }
149:
150: public String getProxyHost() {
151: return mProxyHost;
152: }
153:
154: public void setProxyHost(String proxyHost) {
155: mProxyHost = proxyHost;
156: }
157:
158: public int getProxyPort() {
159: return mProxyPort;
160: }
161:
162: public void setProxyPort(int proxyPort) {
163: mProxyPort = proxyPort;
164: }
165:
166: public String getProxyUsername() {
167: return mProxyUsername;
168: }
169:
170: public void setProxyUsername(String proxyUsername) {
171: mProxyUsername = proxyUsername;
172: }
173:
174: public char[] getProxyPassword() {
175: return mProxyPassword;
176: }
177:
178: public void setProxyPassword(char[] proxyPassword) {
179: mProxyPassword = proxyPassword;
180: }
181: }
|