source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/net/SetProxy.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 26.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:29 NZST 2007 -->
6<TITLE>
7SetProxy (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.net.SetProxy class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="SetProxy (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecWrite.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="SetProxy.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.net</FONT>
85<BR>
86Class SetProxy</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.net.SetProxy</B>
92</PRE>
93<HR>
94<DL>
95<DT>public class <B>SetProxy</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
96
97<P>
98Sets Java's web proxy properties, so that tasks and code run in
99 the same JVM can have through-the-firewall access to remote web sites,
100 and remote ftp sites.
101 You can nominate an http and ftp proxy, or a socks server, reset the server
102 settings, or do nothing at all.
103 <p>
104 Examples
105 <pre>&lt;setproxy/&gt;</pre>
106 do nothing
107 <pre>&lt;setproxy proxyhost="firewall"/&gt;</pre>
108 set the proxy to firewall:80
109 <pre>&lt;setproxy proxyhost="firewall" proxyport="81"/&gt;</pre>
110 set the proxy to firewall:81
111 <pre>&lt;setproxy proxyhost=""/&gt;</pre>
112 stop using the http proxy; don't change the socks settings
113 <pre>&lt;setproxy socksproxyhost="socksy"/&gt;</pre>
114 use socks via socksy:1080
115 <pre>&lt;setproxy socksproxyhost=""/&gt;</pre>
116 stop using the socks server.
117 <p>
118 You can set a username and password for http with the <tt>proxyHost</tt>
119 and <tt>proxyPassword</tt> attributes. On Java1.4 and above these can also be
120 used against SOCKS5 servers.
121 </p>
122<P>
123
124<P>
125<DL>
126<DT><B>Since:</B></DT>
127 <DD>Ant 1.5</DD>
128<DT><B>See Also:</B><DD><a href="http://java.sun.com/j2se/1.4/docs/guide/net/properties.html">
129 java 1.4 network property list</a></DL>
130<HR>
131
132<P>
133<!-- ======== NESTED CLASS SUMMARY ======== -->
134
135
136<!-- =========== FIELD SUMMARY =========== -->
137
138<A NAME="field_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TD COLSPAN=2><FONT SIZE="+2">
142<B>Field Summary</B></FONT></TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#proxyHost">proxyHost</A></B></CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;proxy details</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>protected &nbsp;int</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#proxyPort">proxyPort</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;name of proxy port</TD>
159</TR>
160</TABLE>
161&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
162<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
163<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
164<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
168</TR>
169</TABLE>
170&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
173<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ======== CONSTRUCTOR SUMMARY ======== -->
181
182<A NAME="constructor_summary"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TD COLSPAN=2><FONT SIZE="+2">
186<B>Constructor Summary</B></FONT></TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#SetProxy()">SetProxy</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
193</TR>
194</TABLE>
195&nbsp;
196<!-- ========== METHOD SUMMARY =========== -->
197
198<A NAME="method_summary"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TD COLSPAN=2><FONT SIZE="+2">
202<B>Method Summary</B></FONT></TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;void</CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#applyWebProxySettings()">applyWebProxySettings</A></B>()</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if the proxy port and host settings are not null, then the settings
211 get applied these settings last beyond the life of the object and
212 apply to all network connections
213 Relevant docs: buglist #4183340</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;void</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#execute()">execute</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Does the work.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>protected &nbsp;boolean</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#legacyResetProxySettingsCall(boolean)">legacyResetProxySettingsCall</A></B>(boolean&nbsp;setProxy)</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;make a call to sun.net.www.http.HttpClient.resetProperties();
230 this is only needed for java 1.1; reflection is used to stop the compiler
231 whining, and in case cleanroom JVMs dont have the class.</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;void</CODE></FONT></TD>
236<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setNonProxyHosts(java.lang.String)">setNonProxyHosts</A></B>(java.lang.String&nbsp;nonProxyHosts)</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A list of hosts to bypass the proxy on.</TD>
240</TR>
241<TR BGCOLOR="white" CLASS="TableRowColor">
242<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243<CODE>&nbsp;void</CODE></FONT></TD>
244<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setProxyHost(java.lang.String)">setProxyHost</A></B>(java.lang.String&nbsp;hostname)</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the HTTP/ftp proxy host.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&nbsp;void</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setProxyPassword(java.lang.String)">setProxyPassword</A></B>(java.lang.String&nbsp;proxyPassword)</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the password for the proxy.</TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<CODE>&nbsp;void</CODE></FONT></TD>
260<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setProxyPort(int)">setProxyPort</A></B>(int&nbsp;port)</CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the HTTP/ftp proxy port number; default is 80</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>&nbsp;void</CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setProxyUser(java.lang.String)">setProxyUser</A></B>(java.lang.String&nbsp;proxyUser)</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set the proxy user.</TD>
272</TR>
273<TR BGCOLOR="white" CLASS="TableRowColor">
274<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
275<CODE>&nbsp;void</CODE></FONT></TD>
276<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setSocksProxyHost(java.lang.String)">setSocksProxyHost</A></B>(java.lang.String&nbsp;host)</CODE>
277
278<BR>
279&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of a Socks server.</TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>&nbsp;void</CODE></FONT></TD>
284<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/SetProxy.html#setSocksProxyPort(int)">setSocksProxyPort</A></B>(int&nbsp;port)</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the ProxyPort for socks connections.</TD>
288</TR>
289</TABLE>
290&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
291<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
292<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
293<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
294</TR>
295<TR BGCOLOR="white" CLASS="TableRowColor">
296<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
297</TR>
298</TABLE>
299&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
300<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
301<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
302<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
303</TR>
304<TR BGCOLOR="white" CLASS="TableRowColor">
305<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
306</TR>
307</TABLE>
308&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
311<TD><B>Methods inherited from class java.lang.Object</B></TD>
312</TR>
313<TR BGCOLOR="white" CLASS="TableRowColor">
314<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
315</TR>
316</TABLE>
317&nbsp;
318<P>
319
320<!-- ============ FIELD DETAIL =========== -->
321
322<A NAME="field_detail"><!-- --></A>
323<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
324<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
325<TD COLSPAN=1><FONT SIZE="+2">
326<B>Field Detail</B></FONT></TD>
327</TR>
328</TABLE>
329
330<A NAME="proxyHost"><!-- --></A><H3>
331proxyHost</H3>
332<PRE>
333protected java.lang.String <B>proxyHost</B></PRE>
334<DL>
335<DD>proxy details
336<P>
337<DL>
338</DL>
339</DL>
340<HR>
341
342<A NAME="proxyPort"><!-- --></A><H3>
343proxyPort</H3>
344<PRE>
345protected int <B>proxyPort</B></PRE>
346<DL>
347<DD>name of proxy port
348<P>
349<DL>
350</DL>
351</DL>
352
353<!-- ========= CONSTRUCTOR DETAIL ======== -->
354
355<A NAME="constructor_detail"><!-- --></A>
356<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
357<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
358<TD COLSPAN=1><FONT SIZE="+2">
359<B>Constructor Detail</B></FONT></TD>
360</TR>
361</TABLE>
362
363<A NAME="SetProxy()"><!-- --></A><H3>
364SetProxy</H3>
365<PRE>
366public <B>SetProxy</B>()</PRE>
367<DL>
368</DL>
369
370<!-- ============ METHOD DETAIL ========== -->
371
372<A NAME="method_detail"><!-- --></A>
373<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
374<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
375<TD COLSPAN=1><FONT SIZE="+2">
376<B>Method Detail</B></FONT></TD>
377</TR>
378</TABLE>
379
380<A NAME="setProxyHost(java.lang.String)"><!-- --></A><H3>
381setProxyHost</H3>
382<PRE>
383public void <B>setProxyHost</B>(java.lang.String&nbsp;hostname)</PRE>
384<DL>
385<DD>the HTTP/ftp proxy host. Set this to "" for the http proxy
386 option to be disabled
387<P>
388<DD><DL>
389<DT><B>Parameters:</B><DD><CODE>hostname</CODE> - the new proxy hostname</DL>
390</DD>
391</DL>
392<HR>
393
394<A NAME="setProxyPort(int)"><!-- --></A><H3>
395setProxyPort</H3>
396<PRE>
397public void <B>setProxyPort</B>(int&nbsp;port)</PRE>
398<DL>
399<DD>the HTTP/ftp proxy port number; default is 80
400<P>
401<DD><DL>
402<DT><B>Parameters:</B><DD><CODE>port</CODE> - port number of the proxy</DL>
403</DD>
404</DL>
405<HR>
406
407<A NAME="setSocksProxyHost(java.lang.String)"><!-- --></A><H3>
408setSocksProxyHost</H3>
409<PRE>
410public void <B>setSocksProxyHost</B>(java.lang.String&nbsp;host)</PRE>
411<DL>
412<DD>The name of a Socks server. Set to "" to turn socks
413 proxying off.
414<P>
415<DD><DL>
416<DT><B>Parameters:</B><DD><CODE>host</CODE> - The new SocksProxyHost value</DL>
417</DD>
418</DL>
419<HR>
420
421<A NAME="setSocksProxyPort(int)"><!-- --></A><H3>
422setSocksProxyPort</H3>
423<PRE>
424public void <B>setSocksProxyPort</B>(int&nbsp;port)</PRE>
425<DL>
426<DD>Set the ProxyPort for socks connections. The default value is 1080
427<P>
428<DD><DL>
429<DT><B>Parameters:</B><DD><CODE>port</CODE> - The new SocksProxyPort value</DL>
430</DD>
431</DL>
432<HR>
433
434<A NAME="setNonProxyHosts(java.lang.String)"><!-- --></A><H3>
435setNonProxyHosts</H3>
436<PRE>
437public void <B>setNonProxyHosts</B>(java.lang.String&nbsp;nonProxyHosts)</PRE>
438<DL>
439<DD>A list of hosts to bypass the proxy on. These should be separated
440 with the vertical bar character '|'. Only in Java 1.4 does ftp use
441 this list.
442 e.g. fozbot.corp.sun.com|*.eng.sun.com
443<P>
444<DD><DL>
445<DT><B>Parameters:</B><DD><CODE>nonProxyHosts</CODE> - lists of hosts to talk direct to</DL>
446</DD>
447</DL>
448<HR>
449
450<A NAME="setProxyUser(java.lang.String)"><!-- --></A><H3>
451setProxyUser</H3>
452<PRE>
453public void <B>setProxyUser</B>(java.lang.String&nbsp;proxyUser)</PRE>
454<DL>
455<DD>set the proxy user. Probably requires a password to accompany this
456 setting. Default=""
457<P>
458<DD><DL>
459<DT><B>Parameters:</B><DD><CODE>proxyUser</CODE> - username<DT><B>Since:</B></DT>
460 <DD>Ant1.6</DD>
461</DL>
462</DD>
463</DL>
464<HR>
465
466<A NAME="setProxyPassword(java.lang.String)"><!-- --></A><H3>
467setProxyPassword</H3>
468<PRE>
469public void <B>setProxyPassword</B>(java.lang.String&nbsp;proxyPassword)</PRE>
470<DL>
471<DD>Set the password for the proxy. Used only if the proxyUser is set.
472<P>
473<DD><DL>
474<DT><B>Parameters:</B><DD><CODE>proxyPassword</CODE> - password to go with the username<DT><B>Since:</B></DT>
475 <DD>Ant1.6</DD>
476</DL>
477</DD>
478</DL>
479<HR>
480
481<A NAME="applyWebProxySettings()"><!-- --></A><H3>
482applyWebProxySettings</H3>
483<PRE>
484public void <B>applyWebProxySettings</B>()</PRE>
485<DL>
486<DD>if the proxy port and host settings are not null, then the settings
487 get applied these settings last beyond the life of the object and
488 apply to all network connections
489 Relevant docs: buglist #4183340
490<P>
491<DD><DL>
492</DL>
493</DD>
494</DL>
495<HR>
496
497<A NAME="legacyResetProxySettingsCall(boolean)"><!-- --></A><H3>
498legacyResetProxySettingsCall</H3>
499<PRE>
500protected boolean <B>legacyResetProxySettingsCall</B>(boolean&nbsp;setProxy)</PRE>
501<DL>
502<DD>make a call to sun.net.www.http.HttpClient.resetProperties();
503 this is only needed for java 1.1; reflection is used to stop the compiler
504 whining, and in case cleanroom JVMs dont have the class.
505<P>
506<DD><DL>
507
508<DT><B>Returns:</B><DD>true if we did something</DL>
509</DD>
510</DL>
511<HR>
512
513<A NAME="execute()"><!-- --></A><H3>
514execute</H3>
515<PRE>
516public void <B>execute</B>()
517 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
518<DL>
519<DD>Does the work.
520<P>
521<DD><DL>
522<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
523</DD>
524<DD><DL>
525
526<DT><B>Throws:</B>
527<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - thrown in unrecoverable error.</DL>
528</DD>
529</DL>
530<!-- ========= END OF CLASS DATA ========= -->
531<HR>
532
533
534<!-- ======= START OF BOTTOM NAVBAR ====== -->
535<A NAME="navbar_bottom"><!-- --></A>
536<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
537<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
538<TR>
539<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
540<A NAME="navbar_bottom_firstrow"><!-- --></A>
541<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
542 <TR ALIGN="center" VALIGN="top">
543 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
544 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
545 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
546 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
547 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
548 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
549 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
550 </TR>
551</TABLE>
552</TD>
553<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
554</EM>
555</TD>
556</TR>
557
558<TR>
559<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
560&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/RExecTask.RExecWrite.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>PREV CLASS</B></A>&nbsp;
561&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/net/TelnetTask.html" title="class in org.apache.tools.ant.taskdefs.optional.net"><B>NEXT CLASS</B></A></FONT></TD>
562<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
563 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
564&nbsp;<A HREF="SetProxy.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
565&nbsp;<SCRIPT type="text/javascript">
566 <!--
567 if(window==top) {
568 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
569 }
570 //-->
571</SCRIPT>
572<NOSCRIPT>
573 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
574</NOSCRIPT>
575
576</FONT></TD>
577</TR>
578<TR>
579<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
580 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
581<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
582DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
583</TR>
584</TABLE>
585<A NAME="skip-navbar_bottom"></A>
586<!-- ======== END OF BOTTOM NAVBAR ======= -->
587
588<HR>
589Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
590</BODY>
591</HTML>
Note: See TracBrowser for help on using the repository browser.