1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Ant-contrib Server Tasks</title>
</head>
<body>
<h1>Ant-Contrib Server Tasks</h1>
<p>The following tasks exist for running Ant server on one machine, and
calling that server from another (or possibly the same) machine, to
execute tasks.</p>
<hr width="100%" />
<h1>AntServer</h1>
<p>
Starts an ANT server in current process. This server will wait for
client connections, and when received, it will execute the commands
that the client has sent. NOTE: This is a blocking call, and this
task will not return until someone sends the server a shutdown command.
</p>
<h2>Parameters</h2>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top">port</td>
<td valign="top">The port on which the server will listen.</td>
<td align="center" valign="top">No. Defaults to 17000</td>
</tr>
</table>
<h2>Example:</h2>
<pre>
<code>
<antserver port="12345" />
</code>
</pre>
<h1>RemoteAnt</h1>
<p>
Sends command requests to a running instance of an AntServer which
was started using the <antserver> task.
These commands are executed in the space of the server, and therefore
have no access to any variables or references in the currently executing
project.
</p>
<h2>Parameters</h2>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top">machine</td>
<td valign="top">The machine name on which the server is running.</td>
<td align="center" valign="top">No. Defaults to "localhost"</td>
</tr>
<tr>
<td valign="top">port</td>
<td valign="top">The port on which the server is listening.</td>
<td align="center" valign="top">No. Defaults to 17000</td>
</tr>
<tr>
<td valign="top">persistant</td>
<td valign="top">Should we execute all commands, regardless of whether
or not one of them fails. If false, as soon as a failure is encountered,
we will stop execution.</td>
<td align="center" valign="top">No. Defaults to false</td>
</tr>
<tr>
<td valign="top">failonerror</td>
<td valign="top">If any of the sent commands encounters a build failure on
the server, should we fail this task.</td>
<td align="center" valign="top">No. Defaults to true.</td>
</tr>
</table>
<h2>Parameters Specified as Nested Elements</h2>
<p>
The commands to send are represented as nested elements as described
below
</p>
<h3>runtarget</h3>
<p>Runs a target which is contained in the same buildfile where the
<antserver> task was called. This element may contain nested
<property> elements for sending parameters to the target, and
nested <reference> elements for sending references to the target.</p>
<h4>Parameters</h4>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top">target</td>
<td valign="top">The name of the target to run.</td>
<td align="center" valign="top">Yes.</td>
</tr>
</table>
<h3>runant</h3>
<p>Runs a target in an arbitrary buildfile on the machine where the
<antserver> task was called. If a relative pathname is given,
then the path of the buildfile is relative to the base directory of
the project where the <antserver> task was called. This element
may contain nested <property> elements for sending text parameters
to the target, and nested <reference> elements for sending references
to the target.</p>
<h4>Parameters</h4>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top">antfile</td>
<td valign="top">The path of the ant file to run (if relative, then
the filename is computed relative to the buildfile of the server
task's base directory</td>
<td align="center" valign="top">No. Defaults to "build.xml" in the
directory where the buildfile is to execute (specified by the dir
attribute)</td>
</tr>
<tr>
<td valign="top">target</td>
<td valign="top">The name of the target to run.</td>
<td align="center" valign="top">No. Defaults to the default target of
the specified antfile.</td>
</tr>
<tr>
<td valign="top">dir</td>
<td valign="top">the directory to use as a basedir for the new Ant project. Defaults to
the server project's basedir, unless inheritall has been set to false, in which
case it doesn't have a default value. This will override the basedir setting of
the called project.</td>
<td align="center" valign="top">No.</td>
</tr>
<tr>
<td valign="top">inheritall</td>
<td valign="top">Should the target task inherit all of
the server's properties. This is equivalent to the flag of
the same name on the <ant> task.</td>
<td align="center" valign="top">No. Defaults to false</td>
</tr>
<tr>
<td valign="top">inheritrefs</td>
<td valign="top">Should the target task inherit all of
the server's references. This is equivalent to the flag of
the same name on the <ant> task.</td>
<td align="center" valign="top">No. Defaults to false</td>
</tr>
</table>
<h3>shutdown</h3>
<p>Instructs the <antserver> task to shut itself down. Control
will return to the ANT engine and will procede as necessary in the
server's buildfile.</p>
<h2>Example:</h2>
<pre>
<code>
<remoteant machine="localhost" port="12345">
<runtarget target="execute.build">
<property name="build.type" value="full" />
</runtarget>
<runant dir="tests" target="build.tests">
<property name="build.type" value="full" />
<reference refid="my.ref" torefid="inherited.ref" />
</runtarget>
</remoteant>
</code>
</pre>
<p>
would be the equivalent of running the following directly on
the server machine, from within the same buildfile where the
<antserver> task was run
</p>
<pre>
<code>
<antcall target="execute.build">
<param name="build.type" value="full" />
</antcall>
<ant dir="tests">
<property name="build.type" value="full" />
<reference refid="my.ref" torefid="inherited.ref" />
</antcall>
</code>
</pre>
<h3>sendfile</h3>
<p>Sends a file from the client to the server</p>
<h4>Parameters</h4>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Required</th>
</tr>
<tr>
<td valign="top">file</td>
<td valign="top">The path of the file to send.</td>
<td align="center" valign="top">Yes.</td>
</tr>
<tr>
<td valign="top">tofile</td>
<td valign="top">The filename where the file is to be stored
on the server, if a relative path, then it is stored relative
to the server project's base directory.</td>
<td align="center" valign="top">No. If todir is specified</td>
</tr>
<tr>
<td valign="top">tofile</td>
<td valign="top">The directory where the file is to be stored
on the server, if a relative path, then it is stored relative
to the server project's base directory. The name of the file
will be the same name as the source file</td>
<td align="center" valign="top">No. If tofile is specified</td>
</tr>
</table>
<hr>
<p align="center">Copyright © 2003 Ant-Contrib Project. All
rights Reserved.</p>
</body>
</html>
|
