source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.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: 34.6 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:26 NZST 2007 -->
6<TITLE>
7IPlanetDeploymentTool (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool 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="IPlanetDeploymentTool (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/ejb/InnerClassFilenameFilter.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><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="IPlanetDeploymentTool.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="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool">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;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.ejb</FONT>
85<BR>
86Class IPlanetDeploymentTool</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool</A>
90 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool</B>
91</PRE>
92<DL>
93<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.ejb">EJBDeploymentTool</A></DD>
94</DL>
95<HR>
96<DL>
97<DT>public class <B>IPlanetDeploymentTool</B><DT>extends <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></DL>
98
99<P>
100This class is used to generate iPlanet Application Server (iAS) 6.0 stubs and
101 skeletons and build an EJB Jar file. It is designed to be used with the Ant
102 <code>ejbjar</code> task. If only stubs and skeletons need to be generated
103 (in other words, if no JAR file needs to be created), refer to the
104 <code>iplanet-ejbc</code> task and the <code>IPlanetEjbcTask</code> class.
105 <p>
106 The following attributes may be specified by the user:
107 <ul>
108 <li><i>destdir</i> -- The base directory into which the generated JAR
109 files will be written. Each JAR file is written
110 in directories which correspond to their location
111 within the "descriptordir" namespace. This is a
112 required attribute.
113 <li><i>classpath</i> -- The classpath used when generating EJB stubs and
114 skeletons. This is an optional attribute (if
115 omitted, the classpath specified in the "ejbjar"
116 parent task will be used). If specified, the
117 classpath elements will be prepended to the
118 classpath specified in the parent "ejbjar" task.
119 Note that nested "classpath" elements may also be
120 used.
121 <li><i>keepgenerated</i> -- Indicates whether or not the Java source
122 files which are generated by ejbc will be
123 saved or automatically deleted. If "yes",
124 the source files will be retained. This is
125 an optional attribute (if omitted, it
126 defaults to "no").
127 <li><i>debug</i> -- Indicates whether or not the ejbc utility should
128 log additional debugging statements to the standard
129 output. If "yes", the additional debugging statements
130 will be generated (if omitted, it defaults to "no").
131 <li><i>iashome</i> -- May be used to specify the "home" directory for
132 this iPlanet Application server installation. This
133 is used to find the ejbc utility if it isn't
134 included in the user's system path. This is an
135 optional attribute (if specified, it should refer
136 to the <code>[install-location]/iplanet/ias6/ias
137 </code> directory). If omitted, the ejbc utility
138 must be on the user's system path.
139 <li><i>suffix</i> -- String value appended to the JAR filename when
140 creating each JAR. This attribute is not required
141 (if omitted, it defaults to ".jar").
142 </ul>
143 <p>
144 For each EJB descriptor found in the "ejbjar" parent task, this deployment
145 tool will locate the three classes that comprise the EJB. If these class
146 files cannot be located in the specified <code>srcdir</code> directory, the
147 task will fail. The task will also attempt to locate the EJB stubs and
148 skeletons in this directory. If found, the timestamps on the stubs and
149 skeletons will be checked to ensure they are up to date. Only if these files
150 cannot be found or if they are out of date will ejbc be called.
151<P>
152
153<P>
154<DL>
155<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><CODE>IPlanetEjbc</CODE></A></DL>
156<HR>
157
158<P>
159<!-- ======== NESTED CLASS SUMMARY ======== -->
160
161
162<!-- =========== FIELD SUMMARY =========== -->
163
164<A NAME="field_summary"><!-- --></A>
165<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
166<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167<TD COLSPAN=2><FONT SIZE="+2">
168<B>Field Summary</B></FONT></TD>
169</TR>
170</TABLE>
171&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool"><!-- --></A>
172<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
173<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
174<TD><B>Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></B></TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_CLASS_FULL">ANALYZER_CLASS_FULL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_CLASS_SUPER">ANALYZER_CLASS_SUPER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_FULL">ANALYZER_FULL</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_NONE">ANALYZER_NONE</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_SUPER">ANALYZER_SUPER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#DEFAULT_ANALYZER">DEFAULT_ANALYZER</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#EJB_DD">EJB_DD</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#MANIFEST">MANIFEST</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#META_DIR">META_DIR</A></CODE></TD>
178</TR>
179</TABLE>
180&nbsp;
181<!-- ======== CONSTRUCTOR SUMMARY ======== -->
182
183<A NAME="constructor_summary"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TD COLSPAN=2><FONT SIZE="+2">
187<B>Constructor Summary</B></FONT></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#IPlanetDeploymentTool()">IPlanetDeploymentTool</A></B>()</CODE>
191
192<BR>
193&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
194</TR>
195</TABLE>
196&nbsp;
197<!-- ========== METHOD SUMMARY =========== -->
198
199<A NAME="method_summary"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TD COLSPAN=2><FONT SIZE="+2">
203<B>Method Summary</B></FONT></TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>protected &nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#addVendorFiles(java.util.Hashtable, java.lang.String)">addVendorFiles</A></B>(java.util.Hashtable&nbsp;ejbFiles,
209 java.lang.String&nbsp;ddPrefix)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add the iAS-specific EJB descriptor to the list of files which will be
213 written to the JAR file.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>protected &nbsp;void</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#checkConfiguration(java.lang.String, javax.xml.parsers.SAXParser)">checkConfiguration</A></B>(java.lang.String&nbsp;descriptorFileName,
219 javax.xml.parsers.SAXParser&nbsp;saxParser)</CODE>
220
221<BR>
222&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies that the user selections are valid.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#getPublicId()">getPublicId</A></B>()</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The iAS ejbc utility doesn't require the Public ID of the descriptor's
231 DTD for it to process correctly--this method always returns <code>null
232 </code>.</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>protected &nbsp;java.util.Hashtable</CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#parseEjbFiles(java.lang.String, javax.xml.parsers.SAXParser)">parseEjbFiles</A></B>(java.lang.String&nbsp;descriptorFileName,
238 javax.xml.parsers.SAXParser&nbsp;saxParser)</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a list of EJB files found when the specified EJB
242 descriptor is parsed and processed.</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;void</CODE></FONT></TD>
247<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#processDescriptor(java.lang.String, javax.xml.parsers.SAXParser)">processDescriptor</A></B>(java.lang.String&nbsp;descriptorName,
248 javax.xml.parsers.SAXParser&nbsp;saxParser)</CODE>
249
250<BR>
251&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Process a deployment descriptor, generating the necessary vendor specific
252 deployment files.</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/ejb/IPlanetDeploymentTool.html#setDebug(boolean)">setDebug</A></B>(boolean&nbsp;debug)</CODE>
258
259<BR>
260&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets whether or not debugging output will be generated when ejbc is
261 executed.</TD>
262</TR>
263<TR BGCOLOR="white" CLASS="TableRowColor">
264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
265<CODE>&nbsp;void</CODE></FONT></TD>
266<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#setGenericJarSuffix(java.lang.String)">setGenericJarSuffix</A></B>(java.lang.String&nbsp;inString)</CODE>
267
268<BR>
269&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Since iAS doesn't generate a "generic" JAR as part of its processing,
270 this attribute is ignored and a warning message is displayed to the user.</TD>
271</TR>
272<TR BGCOLOR="white" CLASS="TableRowColor">
273<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
274<CODE>&nbsp;void</CODE></FONT></TD>
275<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#setIashome(java.io.File)">setIashome</A></B>(java.io.File&nbsp;iashome)</CODE>
276
277<BR>
278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Setter method used to store the "home" directory of the user's iAS
279 installation.</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/ejb/IPlanetDeploymentTool.html#setKeepgenerated(boolean)">setKeepgenerated</A></B>(boolean&nbsp;keepgenerated)</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Setter method used to specify whether the Java source files generated by
288 the ejbc utility should be saved or automatically deleted.</TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292<CODE>&nbsp;void</CODE></FONT></TD>
293<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html#setSuffix(java.lang.String)">setSuffix</A></B>(java.lang.String&nbsp;jarSuffix)</CODE>
294
295<BR>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Setter method used to specify the filename suffix (for example, ".jar")
297 for the JAR files to be created.</TD>
298</TR>
299</TABLE>
300&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool"><!-- --></A>
301<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
302<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
303<TD><B>Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></B></TD>
304</TR>
305<TR BGCOLOR="white" CLASS="TableRowColor">
306<TD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#addFileToJar(java.util.jar.JarOutputStream, java.io.File, java.lang.String)">addFileToJar</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#addSupportClasses(java.util.Hashtable)">addSupportClasses</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#checkAndAddDependants(java.util.Hashtable)">checkAndAddDependants</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#configure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config)">configure</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#createClasspath()">createClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getClassLoaderForBuild()">getClassLoaderForBuild</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getCombinedClasspath()">getCombinedClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getConfig()">getConfig</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getDescriptorHandler(java.io.File)">getDescriptorHandler</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getDestDir()">getDestDir</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getJarBaseName(java.lang.String)">getJarBaseName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getLocation()">getLocation</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getManifestFile(java.lang.String)">getManifestFile</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getTask()">getTask</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getVendorDDPrefix(java.lang.String, java.lang.String)">getVendorDDPrefix</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#needToRebuild(java.util.Hashtable, java.io.File)">needToRebuild</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#registerKnownDTDs(org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler)">registerKnownDTDs</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setDestdir(java.io.File)">setDestdir</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setTask(org.apache.tools.ant.Task)">setTask</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#usingBaseJarName()">usingBaseJarName</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#validateConfigured()">validateConfigured</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#writeJar(java.lang.String, java.io.File, java.util.Hashtable, java.lang.String)">writeJar</A></CODE></TD>
307</TR>
308</TABLE>
309&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
310<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
311<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
312<TD><B>Methods inherited from class java.lang.Object</B></TD>
313</TR>
314<TR BGCOLOR="white" CLASS="TableRowColor">
315<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
316</TR>
317</TABLE>
318&nbsp;
319<P>
320
321<!-- ============ FIELD DETAIL =========== -->
322
323
324<!-- ========= CONSTRUCTOR DETAIL ======== -->
325
326<A NAME="constructor_detail"><!-- --></A>
327<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
328<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
329<TD COLSPAN=1><FONT SIZE="+2">
330<B>Constructor Detail</B></FONT></TD>
331</TR>
332</TABLE>
333
334<A NAME="IPlanetDeploymentTool()"><!-- --></A><H3>
335IPlanetDeploymentTool</H3>
336<PRE>
337public <B>IPlanetDeploymentTool</B>()</PRE>
338<DL>
339</DL>
340
341<!-- ============ METHOD DETAIL ========== -->
342
343<A NAME="method_detail"><!-- --></A>
344<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
345<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
346<TD COLSPAN=1><FONT SIZE="+2">
347<B>Method Detail</B></FONT></TD>
348</TR>
349</TABLE>
350
351<A NAME="setIashome(java.io.File)"><!-- --></A><H3>
352setIashome</H3>
353<PRE>
354public void <B>setIashome</B>(java.io.File&nbsp;iashome)</PRE>
355<DL>
356<DD>Setter method used to store the "home" directory of the user's iAS
357 installation. The directory specified should typically be
358 <code>[install-location]/iplanet/ias6/ias</code>.
359<P>
360<DD><DL>
361<DT><B>Parameters:</B><DD><CODE>iashome</CODE> - The home directory for the user's iAS installation.</DL>
362</DD>
363</DL>
364<HR>
365
366<A NAME="setKeepgenerated(boolean)"><!-- --></A><H3>
367setKeepgenerated</H3>
368<PRE>
369public void <B>setKeepgenerated</B>(boolean&nbsp;keepgenerated)</PRE>
370<DL>
371<DD>Setter method used to specify whether the Java source files generated by
372 the ejbc utility should be saved or automatically deleted.
373<P>
374<DD><DL>
375<DT><B>Parameters:</B><DD><CODE>keepgenerated</CODE> - boolean which, if <code>true</code>, indicates that
376 Java source files generated by ejbc for the stubs
377 and skeletons should be kept.</DL>
378</DD>
379</DL>
380<HR>
381
382<A NAME="setDebug(boolean)"><!-- --></A><H3>
383setDebug</H3>
384<PRE>
385public void <B>setDebug</B>(boolean&nbsp;debug)</PRE>
386<DL>
387<DD>Sets whether or not debugging output will be generated when ejbc is
388 executed.
389<P>
390<DD><DL>
391<DT><B>Parameters:</B><DD><CODE>debug</CODE> - A boolean indicating if debugging output should be generated</DL>
392</DD>
393</DL>
394<HR>
395
396<A NAME="setSuffix(java.lang.String)"><!-- --></A><H3>
397setSuffix</H3>
398<PRE>
399public void <B>setSuffix</B>(java.lang.String&nbsp;jarSuffix)</PRE>
400<DL>
401<DD>Setter method used to specify the filename suffix (for example, ".jar")
402 for the JAR files to be created.
403<P>
404<DD><DL>
405<DT><B>Parameters:</B><DD><CODE>jarSuffix</CODE> - The string to use as the JAR filename suffix.</DL>
406</DD>
407</DL>
408<HR>
409
410<A NAME="setGenericJarSuffix(java.lang.String)"><!-- --></A><H3>
411setGenericJarSuffix</H3>
412<PRE>
413public void <B>setGenericJarSuffix</B>(java.lang.String&nbsp;inString)</PRE>
414<DL>
415<DD>Since iAS doesn't generate a "generic" JAR as part of its processing,
416 this attribute is ignored and a warning message is displayed to the user.
417<P>
418<DD><DL>
419<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setGenericJarSuffix(java.lang.String)">setGenericJarSuffix</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></CODE></DL>
420</DD>
421<DD><DL>
422<DT><B>Parameters:</B><DD><CODE>inString</CODE> - the string to use as the suffix. This parameter is
423 ignored.</DL>
424</DD>
425</DL>
426<HR>
427
428<A NAME="processDescriptor(java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
429processDescriptor</H3>
430<PRE>
431public void <B>processDescriptor</B>(java.lang.String&nbsp;descriptorName,
432 javax.xml.parsers.SAXParser&nbsp;saxParser)</PRE>
433<DL>
434<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.ejb">EJBDeploymentTool</A></CODE></B></DD>
435<DD>Process a deployment descriptor, generating the necessary vendor specific
436 deployment files.
437<P>
438<DD><DL>
439<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html#processDescriptor(java.lang.String, javax.xml.parsers.SAXParser)">processDescriptor</A></CODE> in interface <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.ejb">EJBDeploymentTool</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#processDescriptor(java.lang.String, javax.xml.parsers.SAXParser)">processDescriptor</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></CODE></DL>
440</DD>
441<DD><DL>
442</DL>
443</DD>
444</DL>
445<HR>
446
447<A NAME="checkConfiguration(java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
448checkConfiguration</H3>
449<PRE>
450protected void <B>checkConfiguration</B>(java.lang.String&nbsp;descriptorFileName,
451 javax.xml.parsers.SAXParser&nbsp;saxParser)
452 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
453<DL>
454<DD>Verifies that the user selections are valid.
455<P>
456<DD><DL>
457<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#checkConfiguration(java.lang.String, javax.xml.parsers.SAXParser)">checkConfiguration</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></CODE></DL>
458</DD>
459<DD><DL>
460<DT><B>Parameters:</B><DD><CODE>descriptorFileName</CODE> - String representing the file name of an EJB
461 descriptor to be processed<DD><CODE>saxParser</CODE> - SAXParser which may be used to parse the XML
462 descriptor
463<DT><B>Throws:</B>
464<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - If the user selections are invalid.</DL>
465</DD>
466</DL>
467<HR>
468
469<A NAME="parseEjbFiles(java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
470parseEjbFiles</H3>
471<PRE>
472protected java.util.Hashtable <B>parseEjbFiles</B>(java.lang.String&nbsp;descriptorFileName,
473 javax.xml.parsers.SAXParser&nbsp;saxParser)
474 throws java.io.IOException,
475 org.xml.sax.SAXException</PRE>
476<DL>
477<DD>This method returns a list of EJB files found when the specified EJB
478 descriptor is parsed and processed.
479<P>
480<DD><DL>
481<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#parseEjbFiles(java.lang.String, javax.xml.parsers.SAXParser)">parseEjbFiles</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></CODE></DL>
482</DD>
483<DD><DL>
484<DT><B>Parameters:</B><DD><CODE>descriptorFileName</CODE> - String representing the file name of an EJB
485 descriptor to be processed<DD><CODE>saxParser</CODE> - SAXParser which may be used to parse the XML
486 descriptor
487<DT><B>Returns:</B><DD>Hashtable of EJB class (and other) files to be
488 added to the completed JAR file
489<DT><B>Throws:</B>
490<DD><CODE>java.io.IOException</CODE> - An IOException from the parser, possibly from
491 the byte stream or character stream
492<DD><CODE>org.xml.sax.SAXException</CODE> - Any SAX exception, possibly wrapping another
493 exception</DL>
494</DD>
495</DL>
496<HR>
497
498<A NAME="addVendorFiles(java.util.Hashtable, java.lang.String)"><!-- --></A><H3>
499addVendorFiles</H3>
500<PRE>
501protected void <B>addVendorFiles</B>(java.util.Hashtable&nbsp;ejbFiles,
502 java.lang.String&nbsp;ddPrefix)</PRE>
503<DL>
504<DD>Add the iAS-specific EJB descriptor to the list of files which will be
505 written to the JAR file.
506<P>
507<DD><DL>
508<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#addVendorFiles(java.util.Hashtable, java.lang.String)">addVendorFiles</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></CODE></DL>
509</DD>
510<DD><DL>
511<DT><B>Parameters:</B><DD><CODE>ejbFiles</CODE> - Hashtable of EJB class (and other) files to be added to
512 the completed JAR file.<DD><CODE>ddPrefix</CODE> - not used</DL>
513</DD>
514</DL>
515<HR>
516
517<A NAME="getPublicId()"><!-- --></A><H3>
518getPublicId</H3>
519<PRE>
520protected java.lang.String <B>getPublicId</B>()</PRE>
521<DL>
522<DD>The iAS ejbc utility doesn't require the Public ID of the descriptor's
523 DTD for it to process correctly--this method always returns <code>null
524 </code>.
525<P>
526<DD><DL>
527<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getPublicId()">getPublicId</A></CODE> in class <CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">GenericDeploymentTool</A></CODE></DL>
528</DD>
529<DD><DL>
530
531<DT><B>Returns:</B><DD><code>null</code>.</DL>
532</DD>
533</DL>
534<!-- ========= END OF CLASS DATA ========= -->
535<HR>
536
537
538<!-- ======= START OF BOTTOM NAVBAR ====== -->
539<A NAME="navbar_bottom"><!-- --></A>
540<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
541<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
542<TR>
543<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
544<A NAME="navbar_bottom_firstrow"><!-- --></A>
545<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
546 <TR ALIGN="center" VALIGN="top">
547 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
548 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
549 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
550 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
551 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
552 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
553 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
554 </TR>
555</TABLE>
556</TD>
557<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
558</EM>
559</TD>
560</TR>
561
562<TR>
563<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
564&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/InnerClassFilenameFilter.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>PREV CLASS</B></A>&nbsp;
565&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>NEXT CLASS</B></A></FONT></TD>
566<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
567 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
568&nbsp;<A HREF="IPlanetDeploymentTool.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
569&nbsp;<SCRIPT type="text/javascript">
570 <!--
571 if(window==top) {
572 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
573 }
574 //-->
575</SCRIPT>
576<NOSCRIPT>
577 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
578</NOSCRIPT>
579
580</FONT></TD>
581</TR>
582<TR>
583<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
584 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
585<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
586DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
587</TR>
588</TABLE>
589<A NAME="skip-navbar_bottom"></A>
590<!-- ======== END OF BOTTOM NAVBAR ======= -->
591
592<HR>
593Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
594</BODY>
595</HTML>
Note: See TracBrowser for help on using the repository browser.