1 | <!--
|
---|
2 | Licensed to the Apache Software Foundation (ASF) under one or more
|
---|
3 | contributor license agreements. See the NOTICE file distributed with
|
---|
4 | this work for additional information regarding copyright ownership.
|
---|
5 | The ASF licenses this file to You under the Apache License, Version 2.0
|
---|
6 | (the "License"); you may not use this file except in compliance with
|
---|
7 | the License. You may obtain a copy of the License at
|
---|
8 |
|
---|
9 | http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 |
|
---|
11 | Unless required by applicable law or agreed to in writing, software
|
---|
12 | distributed under the License is distributed on an "AS IS" BASIS,
|
---|
13 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
---|
14 | See the License for the specific language governing permissions and
|
---|
15 | limitations under the License.
|
---|
16 | -->
|
---|
17 |
|
---|
18 | <html>
|
---|
19 | <head>
|
---|
20 | <meta http-equiv="Content-Language" content="en-us">
|
---|
21 | <title>Setproxy Task</title>
|
---|
22 | <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
|
---|
23 | </head>
|
---|
24 |
|
---|
25 | <body>
|
---|
26 | <h2><a name="setproxy">Setproxy Task</a></h2>
|
---|
27 |
|
---|
28 | <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.<p>
|
---|
29 |
|
---|
30 | <!-- Applying task/long-description -->
|
---|
31 | <!-- Start Description -->
|
---|
32 |
|
---|
33 | <a name="description">
|
---|
34 | <h3>Description</h3></a>
|
---|
35 |
|
---|
36 | 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> Examples <pre><setproxy/></pre> do nothing <pre><setproxy proxyhost="firewall"/></pre> set the proxy to firewall:80 <pre><setproxy proxyhost="firewall" proxyport="81"/></pre> set the proxy to firewall:81 <pre><setproxy proxyhost=""/></pre> stop using the http proxy; don't change the socks settings <pre><setproxy socksproxyhost="socksy"/></pre> use socks via socksy:1080 <pre><setproxy socksproxyhost=""/></pre> stop using the socks server. <p> You can set a username and password for http with the <tt>proxyHost</tt> and <tt>proxyPassword</tt> attributes. On Java1.4 and above these can also be used against SOCKS5 servers. </p>
|
---|
37 |
|
---|
38 | <!-- End Description -->
|
---|
39 |
|
---|
40 | <!-- Ignore -->
|
---|
41 |
|
---|
42 |
|
---|
43 |
|
---|
44 | <!-- Start Attributes -->
|
---|
45 | <a name="attributes">
|
---|
46 | <h3>Parameters</h3></a>
|
---|
47 |
|
---|
48 | <table border="1" cellpadding="2" cellspacing="0">
|
---|
49 | <tr>
|
---|
50 | <td>
|
---|
51 | <b>Attribute</b>
|
---|
52 | </td>
|
---|
53 | <td>
|
---|
54 | <b>Description</b>
|
---|
55 | </td>
|
---|
56 | <td>
|
---|
57 | <b>Type</b>
|
---|
58 | </td>
|
---|
59 | <td>
|
---|
60 | <b>Requirement</b>
|
---|
61 | </td>
|
---|
62 | </tr>
|
---|
63 | <!-- Attribute Group -->
|
---|
64 |
|
---|
65 | <!-- Attribute Group -->
|
---|
66 | <!-- Attribute -->
|
---|
67 | <tr>
|
---|
68 | <td>
|
---|
69 | nonproxyhosts
|
---|
70 | </td>
|
---|
71 | <td>
|
---|
72 | A list of hosts to bypass the proxy on. These should be separated with the vertical bar character '|'. Only in Java 1.4 does ftp use this list. e.g. fozbot.corp.sun.com|*.eng.sun.com
|
---|
73 | </td>
|
---|
74 | <td>
|
---|
75 | String
|
---|
76 | </td>
|
---|
77 | <td>
|
---|
78 | Optional
|
---|
79 | </td>
|
---|
80 | </tr>
|
---|
81 | <!-- Attribute -->
|
---|
82 | <tr>
|
---|
83 | <td>
|
---|
84 | proxyhost
|
---|
85 | </td>
|
---|
86 | <td>
|
---|
87 | the HTTP/ftp proxy host. Set this to "" for the http proxy option to be disabled
|
---|
88 | </td>
|
---|
89 | <td>
|
---|
90 | String
|
---|
91 | </td>
|
---|
92 | </tr>
|
---|
93 | <!-- Attribute -->
|
---|
94 | <tr>
|
---|
95 | <td>
|
---|
96 | proxypassword
|
---|
97 | </td>
|
---|
98 | <td>
|
---|
99 | Set the password for the proxy. Used only if the proxyUser is set.
|
---|
100 | </td>
|
---|
101 | <td>
|
---|
102 | String
|
---|
103 | </td>
|
---|
104 | </tr>
|
---|
105 | <!-- Attribute -->
|
---|
106 | <tr>
|
---|
107 | <td>
|
---|
108 | proxyport
|
---|
109 | </td>
|
---|
110 | <td>
|
---|
111 | the HTTP/ftp proxy port number; default is 80
|
---|
112 | </td>
|
---|
113 | <td>
|
---|
114 | int
|
---|
115 | </td>
|
---|
116 | </tr>
|
---|
117 | <!-- Attribute -->
|
---|
118 | <tr>
|
---|
119 | <td>
|
---|
120 | proxyuser
|
---|
121 | </td>
|
---|
122 | <td>
|
---|
123 | set the proxy user. Probably requires a password to accompany this setting. Default=""
|
---|
124 | </td>
|
---|
125 | <td>
|
---|
126 | String
|
---|
127 | </td>
|
---|
128 | </tr>
|
---|
129 | <!-- Attribute -->
|
---|
130 | <tr>
|
---|
131 | <td>
|
---|
132 | socksproxyhost
|
---|
133 | </td>
|
---|
134 | <td>
|
---|
135 | The name of a Socks server. Set to "" to turn socks proxying off.
|
---|
136 | </td>
|
---|
137 | <td>
|
---|
138 | String
|
---|
139 | </td>
|
---|
140 | </tr>
|
---|
141 | <!-- Attribute -->
|
---|
142 | <tr>
|
---|
143 | <td>
|
---|
144 | socksproxyport
|
---|
145 | </td>
|
---|
146 | <td>
|
---|
147 | Set the ProxyPort for socks connections. The default value is 1080
|
---|
148 | </td>
|
---|
149 | <td>
|
---|
150 | int
|
---|
151 | </td>
|
---|
152 | </tr>
|
---|
153 |
|
---|
154 |
|
---|
155 | </table>
|
---|
156 |
|
---|
157 | <!-- End Attributes -->
|
---|
158 |
|
---|
159 | <h3>Parameters as nested elements</h3></a>
|
---|
160 |
|
---|
161 |
|
---|
162 | </table>
|
---|
163 |
|
---|
164 | </body>
|
---|
165 | </html>
|
---|