source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 23.2 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>
7IPlanetEjbc (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc 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="IPlanetEjbc (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/IPlanetDeploymentTool.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/IPlanetEjbcTask.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="IPlanetEjbc.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;<A HREF="#nested_class_summary">NESTED</A>&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.ejb</FONT>
85<BR>
86Class IPlanetEjbc</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>IPlanetEjbc</B><DT>extends java.lang.Object</DL>
94
95<P>
96Compiles EJB stubs and skeletons for the iPlanet Application
97 Server (iAS). The class will read a standard EJB descriptor (as well as an
98 EJB descriptor specific to iPlanet Application Server) to identify one or
99 more EJBs to process. It will search for EJB "source" classes (the remote
100; * interface, home interface, and EJB implementation class) and the EJB stubs
101 and skeletons in the specified destination directory. Only if the stubs and
102 skeletons cannot be found or if they're out of date will the iPlanet
103 Application Server ejbc utility be run.
104 <p>
105 Because this class (and it's assorted inner classes) may be bundled into the
106 iPlanet Application Server distribution at some point (and removed from the
107 Ant distribution), the class has been written to be independent of all
108 Ant-specific classes. It is also for this reason (and to avoid cluttering
109 the Apache Ant source files) that this utility has been packaged into a
110 single source file.
111 <p>
112 For more information on Ant Tasks for iPlanet Application Server, see the
113 <code>IPlanetDeploymentTool</code> and <code>IPlanetEjbcTask</code> classes.
114<P>
115
116<P>
117<DL>
118<DT><B>See Also:</B><DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><CODE>IPlanetDeploymentTool</CODE></A>,
119<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><CODE>IPlanetEjbcTask</CODE></A></DL>
120<HR>
121
122<P>
123<!-- ======== NESTED CLASS SUMMARY ======== -->
124
125<A NAME="nested_class_summary"><!-- --></A>
126<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
127<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
128<TD COLSPAN=2><FONT SIZE="+2">
129<B>Nested Class Summary</B></FONT></TD>
130</TR>
131<TR BGCOLOR="white" CLASS="TableRowColor">
132<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
133<CODE>&nbsp;class</CODE></FONT></TD>
134<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">IPlanetEjbc.EjbcException</A></B></CODE>
135
136<BR>
137&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This inner class is used to signal any problems during the execution of
138 the ejbc compiler.</TD>
139</TR>
140</TABLE>
141&nbsp;
142<!-- =========== FIELD SUMMARY =========== -->
143
144
145<!-- ======== CONSTRUCTOR SUMMARY ======== -->
146
147<A NAME="constructor_summary"><!-- --></A>
148<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
150<TD COLSPAN=2><FONT SIZE="+2">
151<B>Constructor Summary</B></FONT></TD>
152</TR>
153<TR BGCOLOR="white" CLASS="TableRowColor">
154<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#IPlanetEjbc(java.io.File, java.io.File, java.io.File, java.lang.String, javax.xml.parsers.SAXParser)">IPlanetEjbc</A></B>(java.io.File&nbsp;stdDescriptor,
155 java.io.File&nbsp;iasDescriptor,
156 java.io.File&nbsp;destDirectory,
157 java.lang.String&nbsp;classpath,
158 javax.xml.parsers.SAXParser&nbsp;parser)</CODE>
159
160<BR>
161&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an instance which may be used to process EJB descriptors and
162 generate EJB stubs and skeletons, if needed.</TD>
163</TR>
164</TABLE>
165&nbsp;
166<!-- ========== METHOD SUMMARY =========== -->
167
168<A NAME="method_summary"><!-- --></A>
169<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
170<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
171<TD COLSPAN=2><FONT SIZE="+2">
172<B>Method Summary</B></FONT></TD>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
176<CODE>protected &nbsp;void</CODE></FONT></TD>
177<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#checkConfiguration()">checkConfiguration</A></B>()</CODE>
178
179<BR>
180&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Verifies that the user selections are valid.</TD>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
184<CODE>&nbsp;void</CODE></FONT></TD>
185<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#execute()">execute</A></B>()</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compiles the stub and skeletons for the specified EJBs, if they need to
189 be updated.</TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
193<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
194<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#getCmpDescriptors()">getCmpDescriptors</A></B>()</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the list of CMP descriptors referenced in the EJB descriptors.</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#getDisplayName()">getDisplayName</A></B>()</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the display-name element read from the standard EJB descriptor.</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;java.util.Hashtable</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#getEjbFiles()">getEjbFiles</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a Hashtable which contains a list of EJB class files processed by
214 the ejbc utility (both "source" class files as well as stubs and
215 skeletons).</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219<CODE>static&nbsp;void</CODE></FONT></TD>
220<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Main application method for the iPlanet Application Server ejbc utility.</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;void</CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#registerDTD(java.lang.String, java.lang.String)">registerDTD</A></B>(java.lang.String&nbsp;publicID,
229 java.lang.String&nbsp;location)</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Registers the location of a local DTD file or resource.</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>&nbsp;void</CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#setDebugOutput(boolean)">setDebugOutput</A></B>(boolean&nbsp;debugOutput)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, enables debugging output when ejbc is executed.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;void</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#setIasHomeDir(java.io.File)">setIasHomeDir</A></B>(java.io.File&nbsp;iasHomeDir)</CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;May be used to specify the "home" directory for this iAS installation.</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>&nbsp;void</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.html#setRetainSource(boolean)">setRetainSource</A></B>(boolean&nbsp;retainSource)</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If true, the Java source files which are generated by the
257 ejbc process are retained.</TD>
258</TR>
259</TABLE>
260&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
261<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
262<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
263<TD><B>Methods inherited from class java.lang.Object</B></TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
267</TR>
268</TABLE>
269&nbsp;
270<P>
271
272<!-- ============ FIELD DETAIL =========== -->
273
274
275<!-- ========= CONSTRUCTOR DETAIL ======== -->
276
277<A NAME="constructor_detail"><!-- --></A>
278<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
279<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
280<TD COLSPAN=1><FONT SIZE="+2">
281<B>Constructor Detail</B></FONT></TD>
282</TR>
283</TABLE>
284
285<A NAME="IPlanetEjbc(java.io.File, java.io.File, java.io.File, java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
286IPlanetEjbc</H3>
287<PRE>
288public <B>IPlanetEjbc</B>(java.io.File&nbsp;stdDescriptor,
289 java.io.File&nbsp;iasDescriptor,
290 java.io.File&nbsp;destDirectory,
291 java.lang.String&nbsp;classpath,
292 javax.xml.parsers.SAXParser&nbsp;parser)</PRE>
293<DL>
294<DD>Constructs an instance which may be used to process EJB descriptors and
295 generate EJB stubs and skeletons, if needed.
296<P>
297<DT><B>Parameters:</B><DD><CODE>stdDescriptor</CODE> - File referencing a standard EJB descriptor.<DD><CODE>iasDescriptor</CODE> - File referencing an iAS-specific EJB descriptor.<DD><CODE>destDirectory</CODE> - File referencing the base directory where both
298 EJB "source" files are found and where stubs and
299 skeletons will be written.<DD><CODE>classpath</CODE> - String representation of the classpath to be used
300 by the iAS ejbc utility.<DD><CODE>parser</CODE> - SAXParser to be used to process both of the EJB
301 descriptors.<DT><B>To do:</B></DT>
302 <DD>classpathElements is not needed here, its never used
303 (at least IDEA tells me so! :)</DD>
304</DL>
305
306<!-- ============ METHOD DETAIL ========== -->
307
308<A NAME="method_detail"><!-- --></A>
309<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
310<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
311<TD COLSPAN=1><FONT SIZE="+2">
312<B>Method Detail</B></FONT></TD>
313</TR>
314</TABLE>
315
316<A NAME="setRetainSource(boolean)"><!-- --></A><H3>
317setRetainSource</H3>
318<PRE>
319public void <B>setRetainSource</B>(boolean&nbsp;retainSource)</PRE>
320<DL>
321<DD>If true, the Java source files which are generated by the
322 ejbc process are retained.
323<P>
324<DD><DL>
325<DT><B>Parameters:</B><DD><CODE>retainSource</CODE> - A boolean indicating if the Java source files for
326 the stubs and skeletons should be retained.<DT><B>To do:</B></DT>
327 <DD>This is not documented in the HTML. On purpose?</DD>
328</DL>
329</DD>
330</DL>
331<HR>
332
333<A NAME="setDebugOutput(boolean)"><!-- --></A><H3>
334setDebugOutput</H3>
335<PRE>
336public void <B>setDebugOutput</B>(boolean&nbsp;debugOutput)</PRE>
337<DL>
338<DD>If true, enables debugging output when ejbc is executed.
339<P>
340<DD><DL>
341<DT><B>Parameters:</B><DD><CODE>debugOutput</CODE> - A boolean indicating if debugging output should be
342 generated</DL>
343</DD>
344</DL>
345<HR>
346
347<A NAME="registerDTD(java.lang.String, java.lang.String)"><!-- --></A><H3>
348registerDTD</H3>
349<PRE>
350public void <B>registerDTD</B>(java.lang.String&nbsp;publicID,
351 java.lang.String&nbsp;location)</PRE>
352<DL>
353<DD>Registers the location of a local DTD file or resource. By registering
354 a local DTD, EJB descriptors can be parsed even when the remote servers
355 which contain the "public" DTDs cannot be accessed.
356<P>
357<DD><DL>
358<DT><B>Parameters:</B><DD><CODE>publicID</CODE> - The public DTD identifier found in an XML document.<DD><CODE>location</CODE> - The file or resource name for the appropriate DTD stored
359 on the local machine.</DL>
360</DD>
361</DL>
362<HR>
363
364<A NAME="setIasHomeDir(java.io.File)"><!-- --></A><H3>
365setIasHomeDir</H3>
366<PRE>
367public void <B>setIasHomeDir</B>(java.io.File&nbsp;iasHomeDir)</PRE>
368<DL>
369<DD>May be used to specify the "home" directory for this iAS installation.
370 The directory specified should typically be
371 <code>[install-location]/iplanet/ias6/ias</code>.
372<P>
373<DD><DL>
374<DT><B>Parameters:</B><DD><CODE>iasHomeDir</CODE> - The home directory for the user's iAS installation.</DL>
375</DD>
376</DL>
377<HR>
378
379<A NAME="getEjbFiles()"><!-- --></A><H3>
380getEjbFiles</H3>
381<PRE>
382public java.util.Hashtable <B>getEjbFiles</B>()</PRE>
383<DL>
384<DD>Returns a Hashtable which contains a list of EJB class files processed by
385 the ejbc utility (both "source" class files as well as stubs and
386 skeletons). The key for the Hashtable is a String representing the path
387 to the class file (relative to the destination directory). The value for
388 the Hashtable is a File object which reference the actual class file.
389<P>
390<DD><DL>
391
392<DT><B>Returns:</B><DD>The list of EJB files processed by the ejbc utility.</DL>
393</DD>
394</DL>
395<HR>
396
397<A NAME="getDisplayName()"><!-- --></A><H3>
398getDisplayName</H3>
399<PRE>
400public java.lang.String <B>getDisplayName</B>()</PRE>
401<DL>
402<DD>Returns the display-name element read from the standard EJB descriptor.
403<P>
404<DD><DL>
405
406<DT><B>Returns:</B><DD>The EJB-JAR display name.</DL>
407</DD>
408</DL>
409<HR>
410
411<A NAME="getCmpDescriptors()"><!-- --></A><H3>
412getCmpDescriptors</H3>
413<PRE>
414public java.lang.String[] <B>getCmpDescriptors</B>()</PRE>
415<DL>
416<DD>Returns the list of CMP descriptors referenced in the EJB descriptors.
417<P>
418<DD><DL>
419
420<DT><B>Returns:</B><DD>An array of CMP descriptors.</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="main(java.lang.String[])"><!-- --></A><H3>
426main</H3>
427<PRE>
428public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
429<DL>
430<DD>Main application method for the iPlanet Application Server ejbc utility.
431 If the application is run with no commandline arguments, a usage
432 statement is printed for the user.
433<P>
434<DD><DL>
435<DT><B>Parameters:</B><DD><CODE>args</CODE> - The commandline arguments passed to the application.</DL>
436</DD>
437</DL>
438<HR>
439
440<A NAME="execute()"><!-- --></A><H3>
441execute</H3>
442<PRE>
443public void <B>execute</B>()
444 throws <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">IPlanetEjbc.EjbcException</A>,
445 java.io.IOException,
446 org.xml.sax.SAXException</PRE>
447<DL>
448<DD>Compiles the stub and skeletons for the specified EJBs, if they need to
449 be updated.
450<P>
451<DD><DL>
452
453<DT><B>Throws:</B>
454<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">IPlanetEjbc.EjbcException</A></CODE> - If the ejbc utility cannot be correctly configured
455 or if one or more of the EJB "source" classes
456 cannot be found in the destination directory
457<DD><CODE>java.io.IOException</CODE> - If the parser encounters a problem reading the XML
458 file
459<DD><CODE>org.xml.sax.SAXException</CODE> - If the parser encounters a problem processing the
460 XML descriptor (it may wrap another exception)</DL>
461</DD>
462</DL>
463<HR>
464
465<A NAME="checkConfiguration()"><!-- --></A><H3>
466checkConfiguration</H3>
467<PRE>
468protected void <B>checkConfiguration</B>()
469 throws <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">IPlanetEjbc.EjbcException</A></PRE>
470<DL>
471<DD>Verifies that the user selections are valid.
472<P>
473<DD><DL>
474
475<DT><B>Throws:</B>
476<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbc.EjbcException.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">IPlanetEjbc.EjbcException</A></CODE> - If the user selections are invalid.</DL>
477</DD>
478</DL>
479<!-- ========= END OF CLASS DATA ========= -->
480<HR>
481
482
483<!-- ======= START OF BOTTOM NAVBAR ====== -->
484<A NAME="navbar_bottom"><!-- --></A>
485<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
486<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
487<TR>
488<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
489<A NAME="navbar_bottom_firstrow"><!-- --></A>
490<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
491 <TR ALIGN="center" VALIGN="top">
492 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
493 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
494 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
495 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
496 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
497 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
498 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
499 </TR>
500</TABLE>
501</TD>
502<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
503</EM>
504</TD>
505</TR>
506
507<TR>
508<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
509&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>PREV CLASS</B></A>&nbsp;
510&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetEjbcTask.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>NEXT CLASS</B></A></FONT></TD>
511<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
512 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
513&nbsp;<A HREF="IPlanetEjbc.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
514&nbsp;<SCRIPT type="text/javascript">
515 <!--
516 if(window==top) {
517 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
518 }
519 //-->
520</SCRIPT>
521<NOSCRIPT>
522 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
523</NOSCRIPT>
524
525</FONT></TD>
526</TR>
527<TR>
528<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
529 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
530<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
531DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
532</TR>
533</TABLE>
534<A NAME="skip-navbar_bottom"></A>
535<!-- ======== END OF BOTTOM NAVBAR ======= -->
536
537<HR>
538Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
539</BODY>
540</HTML>
Note: See TracBrowser for help on using the repository browser.