001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: *
017: */
018:
019: package org.apache.tools.ant.util;
020:
021: import org.apache.tools.ant.Project;
022:
023: /**
024: * Code to do proxy setup. This is just factored out of the main system just to
025: * keep everything else less convoluted.
026: * @since Ant1.7
027: */
028:
029: public class ProxySetup {
030:
031: /**
032: * owner project; used for logging and extracting properties
033: */
034: private Project owner;
035:
036: /**
037: * Java1.5 property that enables use of system proxies.
038: * @value
039: */
040: public static final String USE_SYSTEM_PROXIES = "java.net.useSystemProxies";
041: /** the http proxyhost property */
042: public static final String HTTP_PROXY_HOST = "http.proxyHost";
043: /** the http proxyport property */
044: public static final String HTTP_PROXY_PORT = "http.proxyPort";
045: /** the https proxyhost property */
046: public static final String HTTPS_PROXY_HOST = "https.proxyHost";
047: /** the https proxyport property */
048: public static final String HTTPS_PROXY_PORT = "https.proxyPort";
049: /** the ftp proxyhost property */
050: public static final String FTP_PROXY_HOST = "ftp.proxyHost";
051: /** the ftp proxyport property */
052: public static final String FTP_PROXY_PORT = "ftp.proxyPort";
053: /** the ftp proxyport property */
054: public static final String HTTP_NON_PROXY_HOSTS = "http.nonProxyHosts";
055: /** the http hosts not to be proxied property */
056: public static final String HTTPS_NON_PROXY_HOSTS = "https.nonProxyHosts";
057: /** the ftp hosts not to be proxied property */
058: public static final String FTP_NON_PROXY_HOSTS = "ftp.nonProxyHosts";
059: /** the http proxy username property */
060: public static final String HTTP_PROXY_USERNAME = "http.proxyUser";
061: /** the http proxy password property */
062: public static final String HTTP_PROXY_PASSWORD = "http.proxyPassword";
063: /** the socks proxy host property */
064: public static final String SOCKS_PROXY_HOST = "socksProxyHost";
065: /** the socks proxy port property */
066: public static final String SOCKS_PROXY_PORT = "socksProxyPort";
067: /** the socks proxy username property */
068: public static final String SOCKS_PROXY_USERNAME = "java.net.socks.username";
069: /** the socks proxy password property */
070: public static final String SOCKS_PROXY_PASSWORD = "java.net.socks.password";
071:
072: /**
073: * create a proxy setup class bound to this project
074: * @param owner the project that owns this setup.
075: */
076: public ProxySetup(Project owner) {
077: this .owner = owner;
078: }
079:
080: /**
081: * Get the current system property settings
082: * @return current value; null for none or no access
083: */
084: public static String getSystemProxySetting() {
085: try {
086: return System.getProperty(USE_SYSTEM_PROXIES);
087: } catch (SecurityException e) {
088: //if you cannot read it, you won't be able to write it either
089: return null;
090: }
091: }
092:
093: /**
094: * turn proxies on;
095: * if the proxy key is already set to some value: leave alone.
096: * if an ant property of the value {@link #USE_SYSTEM_PROXIES}
097: * is set, use that instead. Else set to "true".
098: */
099: public void enableProxies() {
100: if (!(getSystemProxySetting() != null)) {
101: String proxies = owner.getProperty(USE_SYSTEM_PROXIES);
102: if (proxies == null || Project.toBoolean(proxies)) {
103: proxies = "true";
104: }
105: String message = "setting " + USE_SYSTEM_PROXIES + " to "
106: + proxies;
107: try {
108: owner.log(message, Project.MSG_DEBUG);
109: System.setProperty(USE_SYSTEM_PROXIES, proxies);
110: } catch (SecurityException e) {
111: //log security exceptions and continue; it aint that
112: //important and may be quite common running Ant embedded.
113: owner.log("Security Exception when " + message);
114: }
115: }
116: }
117:
118: }
|