source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 15.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:27 NZST 2007 -->
6<TITLE>
7HotDeploymentTool (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool interface">
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="HotDeploymentTool (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;PREV CLASS&nbsp;
53&nbsp;NEXT CLASS</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="HotDeploymentTool.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;CONSTR&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;CONSTR&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.j2ee</FONT>
85<BR>
86Interface HotDeploymentTool</H2>
87<DL>
88<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">AbstractHotDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/JonasHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">JonasHotDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/WebLogicHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">WebLogicHotDeploymentTool</A></DD>
89</DL>
90<HR>
91<DL>
92<DT>public interface <B>HotDeploymentTool</B></DL>
93
94<P>
95An interface for vendor-specific "hot" deployment tools.
96<P>
97
98<P>
99<DL>
100<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee"><CODE>AbstractHotDeploymentTool</CODE></A>,
101<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee"><CODE>ServerDeploy</CODE></A></DL>
102<HR>
103
104<P>
105<!-- ======== NESTED CLASS SUMMARY ======== -->
106
107
108<!-- =========== FIELD SUMMARY =========== -->
109
110<A NAME="field_summary"><!-- --></A>
111<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
112<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
113<TD COLSPAN=2><FONT SIZE="+2">
114<B>Field Summary</B></FONT></TD>
115</TR>
116<TR BGCOLOR="white" CLASS="TableRowColor">
117<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
118<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
119<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_DELETE">ACTION_DELETE</A></B></CODE>
120
121<BR>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The delete action String</TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
127<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_DEPLOY">ACTION_DEPLOY</A></B></CODE>
128
129<BR>
130&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The deploy action String</TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_LIST">ACTION_LIST</A></B></CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The list action String</TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_UNDEPLOY">ACTION_UNDEPLOY</A></B></CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The undeploy action String</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_UPDATE">ACTION_UPDATE</A></B></CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The update action String</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ======== CONSTRUCTOR SUMMARY ======== -->
159
160
161<!-- ========== METHOD SUMMARY =========== -->
162
163<A NAME="method_summary"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TD COLSPAN=2><FONT SIZE="+2">
167<B>Method Summary</B></FONT></TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#deploy()">deploy</A></B>()</CODE>
173
174<BR>
175&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Perform the actual deployment.</TD>
176</TR>
177<TR BGCOLOR="white" CLASS="TableRowColor">
178<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
179<CODE>&nbsp;void</CODE></FONT></TD>
180<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#setTask(org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy)">setTask</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">ServerDeploy</A>&nbsp;task)</CODE>
181
182<BR>
183&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the parent task.</TD>
184</TR>
185<TR BGCOLOR="white" CLASS="TableRowColor">
186<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
187<CODE>&nbsp;void</CODE></FONT></TD>
188<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#validateAttributes()">validateAttributes</A></B>()</CODE>
189
190<BR>
191&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validates the passed in attributes.</TD>
192</TR>
193</TABLE>
194&nbsp;
195<P>
196
197<!-- ============ FIELD DETAIL =========== -->
198
199<A NAME="field_detail"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TD COLSPAN=1><FONT SIZE="+2">
203<B>Field Detail</B></FONT></TD>
204</TR>
205</TABLE>
206
207<A NAME="ACTION_DELETE"><!-- --></A><H3>
208ACTION_DELETE</H3>
209<PRE>
210public static final java.lang.String <B>ACTION_DELETE</B></PRE>
211<DL>
212<DD>The delete action String
213<P>
214<DL>
215<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.ACTION_DELETE">Constant Field Values</A></DL>
216</DL>
217<HR>
218
219<A NAME="ACTION_DEPLOY"><!-- --></A><H3>
220ACTION_DEPLOY</H3>
221<PRE>
222public static final java.lang.String <B>ACTION_DEPLOY</B></PRE>
223<DL>
224<DD>The deploy action String
225<P>
226<DL>
227<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.ACTION_DEPLOY">Constant Field Values</A></DL>
228</DL>
229<HR>
230
231<A NAME="ACTION_LIST"><!-- --></A><H3>
232ACTION_LIST</H3>
233<PRE>
234public static final java.lang.String <B>ACTION_LIST</B></PRE>
235<DL>
236<DD>The list action String
237<P>
238<DL>
239<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.ACTION_LIST">Constant Field Values</A></DL>
240</DL>
241<HR>
242
243<A NAME="ACTION_UNDEPLOY"><!-- --></A><H3>
244ACTION_UNDEPLOY</H3>
245<PRE>
246public static final java.lang.String <B>ACTION_UNDEPLOY</B></PRE>
247<DL>
248<DD>The undeploy action String
249<P>
250<DL>
251<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.ACTION_UNDEPLOY">Constant Field Values</A></DL>
252</DL>
253<HR>
254
255<A NAME="ACTION_UPDATE"><!-- --></A><H3>
256ACTION_UPDATE</H3>
257<PRE>
258public static final java.lang.String <B>ACTION_UPDATE</B></PRE>
259<DL>
260<DD>The update action String
261<P>
262<DL>
263<DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.ACTION_UPDATE">Constant Field Values</A></DL>
264</DL>
265
266<!-- ========= CONSTRUCTOR DETAIL ======== -->
267
268
269<!-- ============ METHOD DETAIL ========== -->
270
271<A NAME="method_detail"><!-- --></A>
272<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
273<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
274<TD COLSPAN=1><FONT SIZE="+2">
275<B>Method Detail</B></FONT></TD>
276</TR>
277</TABLE>
278
279<A NAME="validateAttributes()"><!-- --></A><H3>
280validateAttributes</H3>
281<PRE>
282public void <B>validateAttributes</B>()
283 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
284<DL>
285<DD>Validates the passed in attributes.
286<P>
287<DD><DL>
288
289<DT><B>Throws:</B>
290<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the attributes are invalid or incomplete.</DL>
291</DD>
292</DL>
293<HR>
294
295<A NAME="deploy()"><!-- --></A><H3>
296deploy</H3>
297<PRE>
298public void <B>deploy</B>()
299 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
300<DL>
301<DD>Perform the actual deployment.
302<P>
303<DD><DL>
304
305<DT><B>Throws:</B>
306<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the attributes are invalid or incomplete.</DL>
307</DD>
308</DL>
309<HR>
310
311<A NAME="setTask(org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy)"><!-- --></A><H3>
312setTask</H3>
313<PRE>
314public void <B>setTask</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">ServerDeploy</A>&nbsp;task)</PRE>
315<DL>
316<DD>Sets the parent task.
317<P>
318<DD><DL>
319<DT><B>Parameters:</B><DD><CODE>task</CODE> - A ServerDeploy object representing the parent task.</DL>
320</DD>
321</DL>
322<!-- ========= END OF CLASS DATA ========= -->
323<HR>
324
325
326<!-- ======= START OF BOTTOM NAVBAR ====== -->
327<A NAME="navbar_bottom"><!-- --></A>
328<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
329<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
330<TR>
331<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
332<A NAME="navbar_bottom_firstrow"><!-- --></A>
333<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
334 <TR ALIGN="center" VALIGN="top">
335 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
336 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
337 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
338 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
339 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
341 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
342 </TR>
343</TABLE>
344</TD>
345<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
346</EM>
347</TD>
348</TR>
349
350<TR>
351<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
352&nbsp;PREV CLASS&nbsp;
353&nbsp;NEXT CLASS</FONT></TD>
354<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
355 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
356&nbsp;<A HREF="HotDeploymentTool.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
357&nbsp;<SCRIPT type="text/javascript">
358 <!--
359 if(window==top) {
360 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
361 }
362 //-->
363</SCRIPT>
364<NOSCRIPT>
365 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
366</NOSCRIPT>
367
368</FONT></TD>
369</TR>
370<TR>
371<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
372 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
373<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
374DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
375</TR>
376</TABLE>
377<A NAME="skip-navbar_bottom"></A>
378<!-- ======== END OF BOTTOM NAVBAR ======= -->
379
380<HR>
381Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
382</BODY>
383</HTML>
Note: See TracBrowser for help on using the repository browser.