source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.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: 26.7 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>
7AbstractHotDeploymentTool (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool 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="AbstractHotDeploymentTool (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;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee"><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="AbstractHotDeploymentTool.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;FIELD&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;FIELD&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.j2ee</FONT>
85<BR>
86Class AbstractHotDeploymentTool</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee">HotDeploymentTool</A></DD>
93</DL>
94<DL>
95<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">GenericHotDeploymentTool</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>
96</DL>
97<HR>
98<DL>
99<DT>public abstract class <B>AbstractHotDeploymentTool</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee">HotDeploymentTool</A></DL>
100
101<P>
102Abstract class to support vendor-specific hot deployment tools.
103 This class will validate boilerplate attributes.
104
105 Subclassing this class for a vendor specific tool involves the
106 following.
107 <ol><li>Implement the <code>isActionValid()<code> method to insure the
108 action supplied as the "action" attribute of ServerDeploy is valid.
109 <li>Implement the <code>validateAttributes()</code> method to insure
110 all required attributes are supplied, and are in the correct format.
111 <li>Add a <code>add&lt;TOOL&gt;</code> method to the ServerDeploy
112 class. This method will be called when Ant encounters a
113 <code>add&lt;TOOL&gt;</code> task nested in the
114 <code>serverdeploy</code> task.
115 <li>Define the <code>deploy</code> method. This method should perform
116 whatever task it takes to hot-deploy the component. IE: spawn a JVM and
117 run class, exec a native executable, run Java code...
118<P>
119
120<P>
121<DL>
122<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee"><CODE>HotDeploymentTool</CODE></A>,
123<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>
124<HR>
125
126<P>
127<!-- ======== NESTED CLASS SUMMARY ======== -->
128
129
130<!-- =========== FIELD SUMMARY =========== -->
131
132<A NAME="field_summary"><!-- --></A>
133<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
134<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
135<TD COLSPAN=2><FONT SIZE="+2">
136<B>Field Summary</B></FONT></TD>
137</TR>
138</TABLE>
139&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool"><!-- --></A>
140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
141<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
142<TD><B>Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee">HotDeploymentTool</A></B></TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_DELETE">ACTION_DELETE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_DEPLOY">ACTION_DEPLOY</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_LIST">ACTION_LIST</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_UNDEPLOY">ACTION_UNDEPLOY</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#ACTION_UPDATE">ACTION_UPDATE</A></CODE></TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ======== CONSTRUCTOR SUMMARY ======== -->
150
151<A NAME="constructor_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TD COLSPAN=2><FONT SIZE="+2">
155<B>Constructor Summary</B></FONT></TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#AbstractHotDeploymentTool()">AbstractHotDeploymentTool</A></B>()</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
162</TR>
163</TABLE>
164&nbsp;
165<!-- ========== METHOD SUMMARY =========== -->
166
167<A NAME="method_summary"><!-- --></A>
168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
170<TD COLSPAN=2><FONT SIZE="+2">
171<B>Method Summary</B></FONT></TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#createClasspath()">createClasspath</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a classpath as a nested element.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>abstract &nbsp;void</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#deploy()">deploy</A></B>()</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Perform the actual deployment.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#getClasspath()">getClasspath</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;gets the classpath field.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#getPassword()">getPassword</A></B>()</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the password field.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#getServer()">getServer</A></B>()</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the server field.</TD>
212</TR>
213<TR BGCOLOR="white" CLASS="TableRowColor">
214<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
215<CODE>protected &nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">ServerDeploy</A></CODE></FONT></TD>
216<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#getTask()">getTask</A></B>()</CODE>
217
218<BR>
219&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the task field, a ServerDeploy object.</TD>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#getUserName()">getUserName</A></B>()</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the userName field.</TD>
228</TR>
229<TR BGCOLOR="white" CLASS="TableRowColor">
230<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
231<CODE>protected abstract &nbsp;boolean</CODE></FONT></TD>
232<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#isActionValid()">isActionValid</A></B>()</CODE>
233
234<BR>
235&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the "action" attribute defines a valid action.</TD>
236</TR>
237<TR BGCOLOR="white" CLASS="TableRowColor">
238<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
239<CODE>&nbsp;void</CODE></FONT></TD>
240<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</CODE>
241
242<BR>
243&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The classpath to be passed to the JVM running the tool;
244 optional depending upon the tool.</TD>
245</TR>
246<TR BGCOLOR="white" CLASS="TableRowColor">
247<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248<CODE>&nbsp;void</CODE></FONT></TD>
249<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#setPassword(java.lang.String)">setPassword</A></B>(java.lang.String&nbsp;password)</CODE>
250
251<BR>
252&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The password of the user; optional.</TD>
253</TR>
254<TR BGCOLOR="white" CLASS="TableRowColor">
255<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256<CODE>&nbsp;void</CODE></FONT></TD>
257<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#setServer(java.lang.String)">setServer</A></B>(java.lang.String&nbsp;server)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The address or URL for the server where the component will be deployed.</TD>
261</TR>
262<TR BGCOLOR="white" CLASS="TableRowColor">
263<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264<CODE>&nbsp;void</CODE></FONT></TD>
265<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.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>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the parent task.</TD>
269</TR>
270<TR BGCOLOR="white" CLASS="TableRowColor">
271<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
272<CODE>&nbsp;void</CODE></FONT></TD>
273<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#setUserName(java.lang.String)">setUserName</A></B>(java.lang.String&nbsp;userName)</CODE>
274
275<BR>
276&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The user with privileges to deploy applications to the server; optional.</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/AbstractHotDeploymentTool.html#validateAttributes()">validateAttributes</A></B>()</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validates the passed in attributes.</TD>
285</TR>
286</TABLE>
287&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
288<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
289<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
290<TD><B>Methods inherited from class java.lang.Object</B></TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
294</TR>
295</TABLE>
296&nbsp;
297<P>
298
299<!-- ============ FIELD DETAIL =========== -->
300
301
302<!-- ========= CONSTRUCTOR DETAIL ======== -->
303
304<A NAME="constructor_detail"><!-- --></A>
305<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
306<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
307<TD COLSPAN=1><FONT SIZE="+2">
308<B>Constructor Detail</B></FONT></TD>
309</TR>
310</TABLE>
311
312<A NAME="AbstractHotDeploymentTool()"><!-- --></A><H3>
313AbstractHotDeploymentTool</H3>
314<PRE>
315public <B>AbstractHotDeploymentTool</B>()</PRE>
316<DL>
317</DL>
318
319<!-- ============ METHOD DETAIL ========== -->
320
321<A NAME="method_detail"><!-- --></A>
322<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
323<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
324<TD COLSPAN=1><FONT SIZE="+2">
325<B>Method Detail</B></FONT></TD>
326</TR>
327</TABLE>
328
329<A NAME="createClasspath()"><!-- --></A><H3>
330createClasspath</H3>
331<PRE>
332public <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
333<DL>
334<DD>Add a classpath as a nested element.
335<P>
336<DD><DL>
337</DL>
338</DD>
339<DD><DL>
340
341<DT><B>Returns:</B><DD>A Path object representing the classpath to be used.</DL>
342</DD>
343</DL>
344<HR>
345
346<A NAME="isActionValid()"><!-- --></A><H3>
347isActionValid</H3>
348<PRE>
349protected abstract boolean <B>isActionValid</B>()</PRE>
350<DL>
351<DD>Determines if the "action" attribute defines a valid action.
352 <p>Subclasses should determine if the action passed in is
353 supported by the vendor's deployment tool.
354 <p>Actions may by "deploy", "delete", etc... It all depends
355 on the tool.
356<P>
357<DD><DL>
358</DL>
359</DD>
360<DD><DL>
361
362<DT><B>Returns:</B><DD>true if the "action" attribute is valid, false if not.</DL>
363</DD>
364</DL>
365<HR>
366
367<A NAME="validateAttributes()"><!-- --></A><H3>
368validateAttributes</H3>
369<PRE>
370public void <B>validateAttributes</B>()
371 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
372<DL>
373<DD>Validates the passed in attributes.
374 Subclasses should chain to this super-method to insure
375 validation of boilerplate attributes.
376 <p>Only the "action" attribute is required in the
377 base class. Subclasses should check attributes accordingly.
378<P>
379<DD><DL>
380<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#validateAttributes()">validateAttributes</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee">HotDeploymentTool</A></CODE></DL>
381</DD>
382<DD><DL>
383
384<DT><B>Throws:</B>
385<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>
386</DD>
387</DL>
388<HR>
389
390<A NAME="deploy()"><!-- --></A><H3>
391deploy</H3>
392<PRE>
393public abstract void <B>deploy</B>()
394 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
395<DL>
396<DD>Perform the actual deployment.
397 It's up to the subclasses to implement the actual behavior.
398<P>
399<DD><DL>
400<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#deploy()">deploy</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee">HotDeploymentTool</A></CODE></DL>
401</DD>
402<DD><DL>
403
404<DT><B>Throws:</B>
405<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>
406</DD>
407</DL>
408<HR>
409
410<A NAME="setTask(org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy)"><!-- --></A><H3>
411setTask</H3>
412<PRE>
413public 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>
414<DL>
415<DD>Sets the parent task.
416<P>
417<DD><DL>
418<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html#setTask(org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy)">setTask</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/HotDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.j2ee">HotDeploymentTool</A></CODE></DL>
419</DD>
420<DD><DL>
421<DT><B>Parameters:</B><DD><CODE>task</CODE> - a ServerDeploy object representing the parent task.</DL>
422</DD>
423</DL>
424<HR>
425
426<A NAME="getTask()"><!-- --></A><H3>
427getTask</H3>
428<PRE>
429protected <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/ServerDeploy.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee">ServerDeploy</A> <B>getTask</B>()</PRE>
430<DL>
431<DD>Returns the task field, a ServerDeploy object.
432<P>
433<DD><DL>
434</DL>
435</DD>
436<DD><DL>
437
438<DT><B>Returns:</B><DD>An ServerDeploy representing the parent task.</DL>
439</DD>
440</DL>
441<HR>
442
443<A NAME="getClasspath()"><!-- --></A><H3>
444getClasspath</H3>
445<PRE>
446public <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>getClasspath</B>()</PRE>
447<DL>
448<DD>gets the classpath field.
449<P>
450<DD><DL>
451</DL>
452</DD>
453<DD><DL>
454
455<DT><B>Returns:</B><DD>A Path representing the "classpath" attribute.</DL>
456</DD>
457</DL>
458<HR>
459
460<A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
461setClasspath</H3>
462<PRE>
463public void <B>setClasspath</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</PRE>
464<DL>
465<DD>The classpath to be passed to the JVM running the tool;
466 optional depending upon the tool.
467 The classpath may also be supplied as a nested element.
468<P>
469<DD><DL>
470</DL>
471</DD>
472<DD><DL>
473<DT><B>Parameters:</B><DD><CODE>classpath</CODE> - A Path object representing the "classpath" attribute.</DL>
474</DD>
475</DL>
476<HR>
477
478<A NAME="getUserName()"><!-- --></A><H3>
479getUserName</H3>
480<PRE>
481public java.lang.String <B>getUserName</B>()</PRE>
482<DL>
483<DD>Returns the userName field.
484<P>
485<DD><DL>
486</DL>
487</DD>
488<DD><DL>
489
490<DT><B>Returns:</B><DD>A String representing the "userName" attribute.</DL>
491</DD>
492</DL>
493<HR>
494
495<A NAME="setUserName(java.lang.String)"><!-- --></A><H3>
496setUserName</H3>
497<PRE>
498public void <B>setUserName</B>(java.lang.String&nbsp;userName)</PRE>
499<DL>
500<DD>The user with privileges to deploy applications to the server; optional.
501<P>
502<DD><DL>
503</DL>
504</DD>
505<DD><DL>
506<DT><B>Parameters:</B><DD><CODE>userName</CODE> - A String representing the "userName" attribute.</DL>
507</DD>
508</DL>
509<HR>
510
511<A NAME="getPassword()"><!-- --></A><H3>
512getPassword</H3>
513<PRE>
514public java.lang.String <B>getPassword</B>()</PRE>
515<DL>
516<DD>Returns the password field.
517<P>
518<DD><DL>
519</DL>
520</DD>
521<DD><DL>
522
523<DT><B>Returns:</B><DD>A String representing the "password" attribute.</DL>
524</DD>
525</DL>
526<HR>
527
528<A NAME="setPassword(java.lang.String)"><!-- --></A><H3>
529setPassword</H3>
530<PRE>
531public void <B>setPassword</B>(java.lang.String&nbsp;password)</PRE>
532<DL>
533<DD>The password of the user; optional.
534<P>
535<DD><DL>
536</DL>
537</DD>
538<DD><DL>
539<DT><B>Parameters:</B><DD><CODE>password</CODE> - A String representing the "password" attribute.</DL>
540</DD>
541</DL>
542<HR>
543
544<A NAME="getServer()"><!-- --></A><H3>
545getServer</H3>
546<PRE>
547public java.lang.String <B>getServer</B>()</PRE>
548<DL>
549<DD>Returns the server field.
550<P>
551<DD><DL>
552</DL>
553</DD>
554<DD><DL>
555
556<DT><B>Returns:</B><DD>A String representing the "server" attribute.</DL>
557</DD>
558</DL>
559<HR>
560
561<A NAME="setServer(java.lang.String)"><!-- --></A><H3>
562setServer</H3>
563<PRE>
564public void <B>setServer</B>(java.lang.String&nbsp;server)</PRE>
565<DL>
566<DD>The address or URL for the server where the component will be deployed.
567<P>
568<DD><DL>
569</DL>
570</DD>
571<DD><DL>
572<DT><B>Parameters:</B><DD><CODE>server</CODE> - A String representing the "server" attribute.</DL>
573</DD>
574</DL>
575<!-- ========= END OF CLASS DATA ========= -->
576<HR>
577
578
579<!-- ======= START OF BOTTOM NAVBAR ====== -->
580<A NAME="navbar_bottom"><!-- --></A>
581<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
582<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
583<TR>
584<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
585<A NAME="navbar_bottom_firstrow"><!-- --></A>
586<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
587 <TR ALIGN="center" VALIGN="top">
588 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
589 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
590 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
591 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
592 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
593 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
594 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
595 </TR>
596</TABLE>
597</TD>
598<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
599</EM>
600</TD>
601</TR>
602
603<TR>
604<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
605&nbsp;PREV CLASS&nbsp;
606&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/j2ee/GenericHotDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.j2ee"><B>NEXT CLASS</B></A></FONT></TD>
607<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
608 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
609&nbsp;<A HREF="AbstractHotDeploymentTool.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
610&nbsp;<SCRIPT type="text/javascript">
611 <!--
612 if(window==top) {
613 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
614 }
615 //-->
616</SCRIPT>
617<NOSCRIPT>
618 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
619</NOSCRIPT>
620
621</FONT></TD>
622</TR>
623<TR>
624<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
625 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
626<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
627DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
628</TR>
629</TABLE>
630<A NAME="skip-navbar_bottom"></A>
631<!-- ======== END OF BOTTOM NAVBAR ======= -->
632
633<HR>
634Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
635</BODY>
636</HTML>
Note: See TracBrowser for help on using the repository browser.