2006-09-11 04:19:00 +00:00
|
|
|
<!--
|
|
|
|
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.
|
|
|
|
-->
|
2018-01-22 09:10:26 +01:00
|
|
|
|
2002-06-01 12:26:43 +00:00
|
|
|
<html>
|
|
|
|
<head>
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2018-01-22 09:10:26 +01:00
|
|
|
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
2015-06-10 08:48:33 +02:00
|
|
|
<title>Setproxy Task</title>
|
2002-06-01 12:26:43 +00:00
|
|
|
</head>
|
|
|
|
|
2018-01-22 09:10:26 +01:00
|
|
|
<body>
|
|
|
|
<h2>Setproxy Task</h2>
|
|
|
|
|
|
|
|
<h3 id="description">Description</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<p>Sets Java's web proxy properties, so that tasks and code run in the same JVM can have
|
|
|
|
through-the-firewall access to remote web sites, and remote FTP sites. You can nominate an HTTP and
|
|
|
|
FTP proxy, or a SOCKS server, reset the server settings, or do nothing at all.</p>
|
2018-01-22 09:10:26 +01:00
|
|
|
|
|
|
|
<h3 id="attributes">Parameters</h3>
|
2018-02-28 07:58:59 +01:00
|
|
|
<table class="attr">
|
2002-06-01 12:26:43 +00:00
|
|
|
<tr>
|
2018-05-15 10:29:27 +02:00
|
|
|
<th scope="col">Attribute</th>
|
|
|
|
<th scope="col">Description</th>
|
|
|
|
<th scope="col">Type</th>
|
|
|
|
<th scope="col">Required</th>
|
2002-06-01 12:26:43 +00:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>nonproxyhosts</td>
|
|
|
|
<td>A list of hosts to bypass the proxy on. These should be separated with the vertical bar
|
|
|
|
character <q>|</q>. Only in Java 1.4 does FTP use this
|
|
|
|
list. e.g. <samp>fozbot.corp.sun.com|*.eng.sun.com</samp></td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>No</td>
|
2018-01-22 09:10:26 +01:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>proxyhost</td>
|
|
|
|
<td>the HTTP/FTP proxy host. Set this to <q></q> for the HTTP proxy option to be disabled.</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>No</td>
|
2018-01-22 09:10:26 +01:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>proxypassword</td>
|
|
|
|
<td>Set the password for the proxy. Used only if the <var>proxyUser</var> is set.</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>No</td>
|
2018-01-22 09:10:26 +01:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>proxyport</td>
|
|
|
|
<td>the HTTP/FTP proxy port number</td>
|
|
|
|
<td>int</td>
|
|
|
|
<td>No; default is <q>80</q></td>
|
2018-01-22 09:10:26 +01:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>proxyuser</td>
|
|
|
|
<td>set the proxy user. Probably requires a password to accompany this setting.</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>No; default is <q></q></td>
|
2018-01-22 09:10:26 +01:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>socksproxyhost</td>
|
|
|
|
<td>The name of a SOCKS server. Set to <q></q> to turn SOCKS proxying off.</td>
|
|
|
|
<td>String</td>
|
|
|
|
<td>No</td>
|
2018-01-22 09:10:26 +01:00
|
|
|
</tr>
|
|
|
|
<tr>
|
2018-02-28 07:58:59 +01:00
|
|
|
<td>socksproxyport</td>
|
|
|
|
<td>Set the ProxyPort for SOCKS connections.</td>
|
|
|
|
<td>int</td>
|
|
|
|
<td>No; default is <q>1080</q></td>
|
2002-06-01 12:26:43 +00:00
|
|
|
</tr>
|
|
|
|
</table>
|
2018-02-28 07:58:59 +01:00
|
|
|
|
|
|
|
<h3>Examples</h3>
|
2018-05-15 09:51:58 +02:00
|
|
|
|
|
|
|
<p>Do nothing</p>
|
|
|
|
<pre><setproxy/></pre>
|
|
|
|
|
|
|
|
<p>Set the proxy to <samp>firewall:80</samp></p>
|
|
|
|
<pre><setproxy proxyhost="firewall"/></pre>
|
|
|
|
|
|
|
|
<p>Set the proxy to <samp>firewall:81</samp></p>
|
|
|
|
<pre><setproxy proxyhost="firewall" proxyport="81"/></pre>
|
|
|
|
|
|
|
|
<p>Stop using HTTP proxy; don't change SOCKS settings</p>
|
|
|
|
<pre><setproxy proxyhost=""/></pre>
|
|
|
|
|
|
|
|
<p>Use SOCKS via <samp>socksy:1080</samp></p>
|
|
|
|
<pre><setproxy socksproxyhost="socksy"/></pre>
|
|
|
|
|
|
|
|
<p>Stop using the SOCKS server</p>
|
|
|
|
<pre><setproxy socksproxyhost=""/></pre>
|
|
|
|
|
|
|
|
<p>You can set a username and password for HTTP with the <var>proxyHost</var>
|
|
|
|
and <var>proxyPassword</var> attributes. On Java 1.4 and above, these can also be used against SOCKS
|
2018-02-28 07:58:59 +01:00
|
|
|
5 servers.</p>
|
|
|
|
|
2002-06-01 12:26:43 +00:00
|
|
|
</body>
|
|
|
|
</html>
|