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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
<!--
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.
-->
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>ServerDeploy Task</title>
</head>
<body>
<h1><a name="serverdeploy">Apache Ant ServerDeploy User Manual</a></h1>
<p>by</p>
<!-- Names are in alphabetical order, on last name -->
<ul>
<li>Christopher A. Longo (<a href="mailto:cal@cloud9.net">cal@cloud9.net</a>)</li>
<li>Cyrille Morvan (<a href="mailto:cmorvan@ingenosya.com">cmorvan@ingenosya.com</a>)</li>
</ul>
</p>
<hr>
<p> At present the tasks support:<br>
<ul>
<li><a href="http://www.bea.com" target="_top">Weblogic</a> servers</li>
<li><a href="http://www.objectweb.org/jonas/" target="_top">JOnAS</a>
2.4 Open Source EJB server</li>
</ul>
Over time we expect further optional tasks to support additional J2EE Servers.
</p>
<hr>
<table border="1" cellpadding="5">
<tr><td>Task</td><td colspan="2">Application Servers</td></tr>
<tr><td rowspan="4"><a href="#serverdeploy_element">serverdeploy</a></td><td colspan="2" align="center"><b>Nested Elements</b></td></tr>
<tr><td><a href="#serverdeploy_generic">generic</a></td><td>Generic task</td></tr>
<tr><td><a href="#serverdeploy_jonas">jonas</a></td><td>JOnAS 2.4</td></tr>
<tr><td><a href="#serverdeploy_weblogic">weblogic</a></td><td>Weblogic</td></tr>
</table>
<a name="serverdeploy_element">
<h2>ServerDeploy element</h2>
<h3><b>Description:</b></h3>
<p>The <code>serverdeploy</code> task is used to run a "hot" deployment tool for
vendor-specific J2EE server. The task requires nested elements which define
the attributes of the vendor-specific deployment tool being executed.
Vendor-specific deployment tools elements may enforce rules for which
attributes are required, depending on the tool.
</p>
<h3>Parameters:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">action</td>
<td valign="top">This is the action to be performed. For most cases this
will be "deploy". Some tools support additional actions, such as "delete", "list",
"undeploy", "update"...</td>
<td>Yes</td>
</tr>
<tr>
<td valign="top">source</td>
<td valign="top">A fully qualified path/filename of the component to be deployed.
This may be an .ear, .jar, .war, or any other type that is supported by the server.
</td>
<td>Tool dependent</td>
</tr>
</table>
<h3>Nested Elements</h3>
<p>The serverdeploy task supports a nested <code>classpath</code> element to set the classpath.</p>
<h3>Vendor-specific nested elements</h3>
<h3>Parameters used for all tools:</h3>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">classpath</td>
<td valign="top">The classpath to be passed to the JVM running the tool.
The classpath may also be supplied as a nested element.</td>
<td>Tool dependent</td>
</tr>
<tr>
<td valign="top">server</td>
<td valign="top">The address or URL for the server where the component will be deployed.</td>
<td>Tool dependent</td>
</tr>
<tr>
<td valign="top">username</td>
<td valign="top">The user with privileges to deploy applications to the server.</td>
<td>Tool dependent</td>
</tr>
<tr>
<td valign="top">password</td>
<td valign="top">The password of the user with privileges to deploy applications to the server.</td>
<td>Tool dependent</td>
</tr>
</table>
<p>Also supported are nested vendor-specific elements.</p>
<a name="serverdeploy_generic">
<h3>Generic element</h3>
This element is provided for generic Java-based deployment tools.
The generic task accepts (but does not require) nested <code>arg</code>
and <code>jvmarg</code> elements.
A JVM will be spawned with the provided attributes. It is recommended
that a vendor-specific element be used over the generic one if at all
possible.
<p>The following attributes are supported by the generic element.</p>
<p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">classname</td>
<td valign="top">This is the fully qualified classname of the Java based
deployment tool to execute.</td>
<td>Yes</td>
</tr>
</table>
</p>
<h3>Nested Elements</h3>
<p>The generic element supports nested <code><arg></code> and <code><jvmarg></code> elements.</p>
<h3>Example</h3>
<p>This example shows the use of generic deploy element to deploy a component
using a Java based deploy tool:</p>
<pre>
<serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear">
<generic classname="com.yamato.j2ee.tools.deploy.DeployTool"
classpath="${classpath}"
username="${user.name}"
password="${user.password}">
<arg value="-component=WildStar"/>
<arg value="-force"/>
<jvmarg value="-ms64m"/>
<jvmarg value="-mx128m"/>
</generic>
</serverdeploy>
</pre>
<a name="serverdeploy_weblogic">
<h3>WebLogic element</h3>
<p>
The WebLogic element contains additional attributes to run the
<code>weblogic.deploy</code> deployment tool.
<p>Valid actions for the tool are <code>deploy</code>, <code>undeploy</code>,
<code>list</code>, <code>update</code>, and <code>delete</code>.
<p>If the action is <code>deploy</code> or <code>update</code>,
the <code>application</code> and <code>source</code> attributes must be set.
If the action is <code>undeploy</code> or <code>delete</code>,
the <code>application</code> attribute must be set. If the <code>username</code>
attribute is omitted, it defaults to "system". The <code>password</code> attribute is
required for all actions.
<p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">application</td>
<td valign="top">This is the name of the application being deployed</td>
<td>Yes</td>
</tr>
<tr>
<td valign="top">component</td>
<td valign="top">This is the component string for deployment targets.
It is in the form <code><component>:<target1>,<target2>...</code>
Where component is the archive name (minus the .jar, .ear, .war
extension). Targets are the servers where the components will be deployed</td>
<td>no</td>
</tr>
<tr>
<td valign="top">debug</td>
<td valign="top">If set to true, additional information will be
printed during the deployment process.</td>
<td>No</td>
</tr>
</table>
<h3>Examples</h3>
<p>This example shows the use of serverdeploy to deploy a component to a WebLogic server:</p>
<pre>
<serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.ear">
<weblogic application="myapp"
server="t3://myserver:7001"
classpath="${weblogic.home}/lib/weblogic.jar"
username="${user.name}"
password="${user.password}"
component="ejb_foobar:myserver,productionserver"
debug="true"/>
</serverdeploy>
</pre>
<p>This example shows serverdeploy being used to delete a component from a
WebLogic server:</p>
<pre>
<serverdeploy action="delete" source="${lib.dir}/ejb_myApp.jar"/>
<weblogic application="myapp"
server="t3://myserver:7001"
classpath="${weblogic.home}/lib/weblogic.jar"
username="${user.name}"
password="${user.password}"/>
</serverdeploy>
</pre>
<a name="serverdeploy_jonas">
<h3>JOnAS (Java Open Application Server) element</h3>
<p>
The JOnAS element contains additional attributes to run the
<code>JonasAdmin</code> deployment tool.
<p>Valid actions for the tool are <code>deploy</code>, <code>undeploy</code>,
<code>list</code> and <code>update</code>.
<p>You can't use <code>user</code> and <code>password</code> property with this
task.
<p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td valign="top"><b>Required</b></td>
</tr>
<tr>
<td valign="top">jonasroot</td>
<td valign="top">The root directory for JOnAS.</td>
<td>Yes</td>
</tr>
<tr>
<td valign="top">orb</td>
<td valign="top">Choose your ORB : RMI, JEREMIE, DAVID, ... If omitted, it defaults
to the one present in classpath. The corresponding JOnAS JAR is
automatically added to the classpath. If your orb is DAVID (RMI/IIOP) you must
specify davidhost and davidport properties.</td>
<td>No</td>
</tr>
<tr>
<td valign="top">davidhost</td>
<td valign="top">The value for the system property : <code>david.CosNaming.default_host</code> .</td>
<td>No</td>
</tr>
<tr>
<td valign="top">davidport</td>
<td valign="top">The value for the system property : <code>david.CosNaming.default_port</code> .</td>
<td>No</td>
</tr>
<tr>
<td valign="top">classname</td>
<td valign="top">This is the fully qualified classname of the Java based
deployment tool to execute. Default to <code>org.objectweb.jonas.adm.JonasAdmin</code></td>
<td>No</td>
</tr>
</table>
<h3>Nested Elements</h3>
<p>The jonas element supports nested <code><arg></code> and <code><jvmarg></code> elements.</p>
<h3>Examples</h3>
<p>This example shows the use of serverdeploy to deploy a component to a JOnAS server:</p>
<pre>
<serverdeploy action="deploy" source="${lib.dir}/ejb_myApp.jar">
<jonas server="MyJOnAS" jonasroot="${jonas.root}">
<classpath>
<pathelement path="${jonas.root}/lib/RMI_jonas.jar"/>
<pathelement path="${jonas.root}/config/"/>
</classpath>
</jonas>
</serverdeploy>
</pre>
<p>This example shows serverdeploy being used to list the components from a
JOnAS server and a WebLogic server:</p>
<pre>
<serverdeploy action="list"/>
<jonas jonasroot="${jonas.root}" orb="JEREMIE"/>
<weblogic application="myapp"
server="t3://myserver:7001"
classpath="${weblogic.home}/lib/weblogic.jar"
username="${user.name}"
password="${user.password}"/>
</serverdeploy>
</pre>
</body>
</html>
|
