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>
|
---|
7 | GenericDeploymentTool (Apache Ant API)
|
---|
8 | </TITLE>
|
---|
9 |
|
---|
10 | <META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool class">
|
---|
11 |
|
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
|
---|
13 |
|
---|
14 | <SCRIPT type="text/javascript">
|
---|
15 | function windowTitle()
|
---|
16 | {
|
---|
17 | parent.document.title="GenericDeploymentTool (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> </TD>
|
---|
36 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
37 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
38 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
39 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.NamingScheme.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>PREV CLASS</B></A>
|
---|
53 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/InnerClassFilenameFilter.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>
|
---|
56 | <A HREF="GenericDeploymentTool.html" target="_top"><B>NO FRAMES</B></A>
|
---|
57 | <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: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
73 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
74 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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">
|
---|
84 | org.apache.tools.ant.taskdefs.optional.ejb</FONT>
|
---|
85 | <BR>
|
---|
86 | Class GenericDeploymentTool</H2>
|
---|
87 | <PRE>
|
---|
88 | java.lang.Object
|
---|
89 | <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool</B>
|
---|
90 | </PRE>
|
---|
91 | <DL>
|
---|
92 | <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>
|
---|
93 | </DL>
|
---|
94 | <DL>
|
---|
95 | <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/BorlandDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">BorlandDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/IPlanetDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">IPlanetDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/JbossDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">JbossDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/JonasDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">JonasDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/WeblogicDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">WeblogicDeploymentTool</A>, <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/WebsphereDeploymentTool.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">WebsphereDeploymentTool</A></DD>
|
---|
96 | </DL>
|
---|
97 | <HR>
|
---|
98 | <DL>
|
---|
99 | <DT>public class <B>GenericDeploymentTool</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html" title="interface in org.apache.tools.ant.taskdefs.optional.ejb">EJBDeploymentTool</A></DL>
|
---|
100 |
|
---|
101 | <P>
|
---|
102 | A deployment tool which creates generic EJB jars. Generic jars contains
|
---|
103 | only those classes and META-INF entries specified in the EJB 1.1 standard
|
---|
104 |
|
---|
105 | This class is also used as a framework for the creation of vendor specific
|
---|
106 | deployment tools. A number of template methods are provided through which the
|
---|
107 | vendor specific tool can hook into the EJB creation process.
|
---|
108 | <P>
|
---|
109 |
|
---|
110 | <P>
|
---|
111 | <HR>
|
---|
112 |
|
---|
113 | <P>
|
---|
114 | <!-- ======== NESTED CLASS SUMMARY ======== -->
|
---|
115 |
|
---|
116 |
|
---|
117 | <!-- =========== FIELD SUMMARY =========== -->
|
---|
118 |
|
---|
119 | <A NAME="field_summary"><!-- --></A>
|
---|
120 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
121 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
122 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
123 | <B>Field Summary</B></FONT></TD>
|
---|
124 | </TR>
|
---|
125 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
126 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
127 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
128 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_CLASS_FULL">ANALYZER_CLASS_FULL</A></B></CODE>
|
---|
129 |
|
---|
130 | <BR>
|
---|
131 | The analyzer class for the super analyzer</TD>
|
---|
132 | </TR>
|
---|
133 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
134 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
135 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
136 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_CLASS_SUPER">ANALYZER_CLASS_SUPER</A></B></CODE>
|
---|
137 |
|
---|
138 | <BR>
|
---|
139 | The analyzer class for the super analyzer</TD>
|
---|
140 | </TR>
|
---|
141 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
142 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
143 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
144 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_FULL">ANALYZER_FULL</A></B></CODE>
|
---|
145 |
|
---|
146 | <BR>
|
---|
147 | A dependency analyzer name to find all related classes</TD>
|
---|
148 | </TR>
|
---|
149 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
150 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
151 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
152 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_NONE">ANALYZER_NONE</A></B></CODE>
|
---|
153 |
|
---|
154 | <BR>
|
---|
155 | A dependency analyzer name for no analyzer</TD>
|
---|
156 | </TR>
|
---|
157 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
158 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
159 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
160 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#ANALYZER_SUPER">ANALYZER_SUPER</A></B></CODE>
|
---|
161 |
|
---|
162 | <BR>
|
---|
163 | A dependency analyzer name to find ancestor classes</TD>
|
---|
164 | </TR>
|
---|
165 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
166 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
167 | <CODE>static java.lang.String</CODE></FONT></TD>
|
---|
168 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#DEFAULT_ANALYZER">DEFAULT_ANALYZER</A></B></CODE>
|
---|
169 |
|
---|
170 | <BR>
|
---|
171 | The default analyzer</TD>
|
---|
172 | </TR>
|
---|
173 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
174 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
175 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
176 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#EJB_DD">EJB_DD</A></B></CODE>
|
---|
177 |
|
---|
178 | <BR>
|
---|
179 | Name for EJB Deployment descriptor within EJB jars</TD>
|
---|
180 | </TR>
|
---|
181 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
182 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
183 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
184 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#MANIFEST">MANIFEST</A></B></CODE>
|
---|
185 |
|
---|
186 | <BR>
|
---|
187 | The standard MANIFEST file</TD>
|
---|
188 | </TR>
|
---|
189 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
190 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
191 | <CODE>protected static java.lang.String</CODE></FONT></TD>
|
---|
192 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#META_DIR">META_DIR</A></B></CODE>
|
---|
193 |
|
---|
194 | <BR>
|
---|
195 | The standard META-INF directory in jar files</TD>
|
---|
196 | </TR>
|
---|
197 | </TABLE>
|
---|
198 |
|
---|
199 | <!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
---|
200 |
|
---|
201 | <A NAME="constructor_summary"><!-- --></A>
|
---|
202 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
203 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
204 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
205 | <B>Constructor Summary</B></FONT></TD>
|
---|
206 | </TR>
|
---|
207 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
208 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#GenericDeploymentTool()">GenericDeploymentTool</A></B>()</CODE>
|
---|
209 |
|
---|
210 | <BR>
|
---|
211 | </TD>
|
---|
212 | </TR>
|
---|
213 | </TABLE>
|
---|
214 |
|
---|
215 | <!-- ========== METHOD SUMMARY =========== -->
|
---|
216 |
|
---|
217 | <A NAME="method_summary"><!-- --></A>
|
---|
218 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
219 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
220 | <TD COLSPAN=2><FONT SIZE="+2">
|
---|
221 | <B>Method Summary</B></FONT></TD>
|
---|
222 | </TR>
|
---|
223 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
224 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
225 | <CODE>protected void</CODE></FONT></TD>
|
---|
226 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#addFileToJar(java.util.jar.JarOutputStream, java.io.File, java.lang.String)">addFileToJar</A></B>(java.util.jar.JarOutputStream jStream,
|
---|
227 | java.io.File inputFile,
|
---|
228 | java.lang.String logicalFilename)</CODE>
|
---|
229 |
|
---|
230 | <BR>
|
---|
231 | Utility method that encapsulates the logic of adding a file entry to
|
---|
232 | a .jar file.</TD>
|
---|
233 | </TR>
|
---|
234 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
235 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
236 | <CODE>protected void</CODE></FONT></TD>
|
---|
237 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#addSupportClasses(java.util.Hashtable)">addSupportClasses</A></B>(java.util.Hashtable ejbFiles)</CODE>
|
---|
238 |
|
---|
239 | <BR>
|
---|
240 | Adds any classes the user specifies using <i>support</i> nested elements
|
---|
241 | to the <code>ejbFiles</code> Hashtable.</TD>
|
---|
242 | </TR>
|
---|
243 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
244 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
245 | <CODE>protected void</CODE></FONT></TD>
|
---|
246 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#addVendorFiles(java.util.Hashtable, java.lang.String)">addVendorFiles</A></B>(java.util.Hashtable ejbFiles,
|
---|
247 | java.lang.String ddPrefix)</CODE>
|
---|
248 |
|
---|
249 | <BR>
|
---|
250 | Add any vendor specific files which should be included in the
|
---|
251 | EJB Jar.</TD>
|
---|
252 | </TR>
|
---|
253 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
254 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
255 | <CODE>protected void</CODE></FONT></TD>
|
---|
256 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#checkAndAddDependants(java.util.Hashtable)">checkAndAddDependants</A></B>(java.util.Hashtable checkEntries)</CODE>
|
---|
257 |
|
---|
258 | <BR>
|
---|
259 | Add all available classes, that depend on Remote, Home, Bean, PK</TD>
|
---|
260 | </TR>
|
---|
261 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
262 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
263 | <CODE>protected void</CODE></FONT></TD>
|
---|
264 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#checkConfiguration(java.lang.String, javax.xml.parsers.SAXParser)">checkConfiguration</A></B>(java.lang.String descriptorFileName,
|
---|
265 | javax.xml.parsers.SAXParser saxParser)</CODE>
|
---|
266 |
|
---|
267 | <BR>
|
---|
268 | This method is called as the first step in the processDescriptor method
|
---|
269 | to allow vendor-specific subclasses to validate the task configuration
|
---|
270 | prior to processing the descriptor.</TD>
|
---|
271 | </TR>
|
---|
272 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
273 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
274 | <CODE> void</CODE></FONT></TD>
|
---|
275 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#configure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config)">configure</A></B>(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config config)</CODE>
|
---|
276 |
|
---|
277 | <BR>
|
---|
278 | Configure this tool for use in the ejbjar task.</TD>
|
---|
279 | </TR>
|
---|
280 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
281 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
282 | <CODE> <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
|
---|
283 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#createClasspath()">createClasspath</A></B>()</CODE>
|
---|
284 |
|
---|
285 | <BR>
|
---|
286 | Add the classpath for the user classes</TD>
|
---|
287 | </TR>
|
---|
288 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
289 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
290 | <CODE>protected java.lang.ClassLoader</CODE></FONT></TD>
|
---|
291 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getClassLoaderForBuild()">getClassLoaderForBuild</A></B>()</CODE>
|
---|
292 |
|
---|
293 | <BR>
|
---|
294 | Returns a Classloader object which parses the passed in generic EjbJar classpath.</TD>
|
---|
295 | </TR>
|
---|
296 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
297 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
298 | <CODE>protected <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
|
---|
299 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getCombinedClasspath()">getCombinedClasspath</A></B>()</CODE>
|
---|
300 |
|
---|
301 | <BR>
|
---|
302 | Get the classpath by combining the one from the surrounding task, if any
|
---|
303 | and the one from this tool.</TD>
|
---|
304 | </TR>
|
---|
305 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
306 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
307 | <CODE>protected org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config</CODE></FONT></TD>
|
---|
308 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getConfig()">getConfig</A></B>()</CODE>
|
---|
309 |
|
---|
310 | <BR>
|
---|
311 | Get the basename terminator.</TD>
|
---|
312 | </TR>
|
---|
313 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
314 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
315 | <CODE>protected <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">DescriptorHandler</A></CODE></FONT></TD>
|
---|
316 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getDescriptorHandler(java.io.File)">getDescriptorHandler</A></B>(java.io.File srcDir)</CODE>
|
---|
317 |
|
---|
318 | <BR>
|
---|
319 | </TD>
|
---|
320 | </TR>
|
---|
321 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
322 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
323 | <CODE>protected java.io.File</CODE></FONT></TD>
|
---|
324 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getDestDir()">getDestDir</A></B>()</CODE>
|
---|
325 |
|
---|
326 | <BR>
|
---|
327 | Get the destination directory.</TD>
|
---|
328 | </TR>
|
---|
329 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
330 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
331 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
332 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getJarBaseName(java.lang.String)">getJarBaseName</A></B>(java.lang.String descriptorFileName)</CODE>
|
---|
333 |
|
---|
334 | <BR>
|
---|
335 | Using the EJB descriptor file name passed from the <code>ejbjar</code>
|
---|
336 | task, this method returns the "basename" which will be used to name the
|
---|
337 | completed JAR file.</TD>
|
---|
338 | </TR>
|
---|
339 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
340 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
341 | <CODE>protected <A HREF="../../../../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A></CODE></FONT></TD>
|
---|
342 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getLocation()">getLocation</A></B>()</CODE>
|
---|
343 |
|
---|
344 | <BR>
|
---|
345 | Get the build file location associated with this element's task.</TD>
|
---|
346 | </TR>
|
---|
347 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
348 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
349 | <CODE>protected java.io.File</CODE></FONT></TD>
|
---|
350 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getManifestFile(java.lang.String)">getManifestFile</A></B>(java.lang.String prefix)</CODE>
|
---|
351 |
|
---|
352 | <BR>
|
---|
353 | Get the manifets file to use for building the generic jar.</TD>
|
---|
354 | </TR>
|
---|
355 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
356 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
357 | <CODE>protected java.lang.String</CODE></FONT></TD>
|
---|
358 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getPublicId()">getPublicId</A></B>()</CODE>
|
---|
359 |
|
---|
360 | <BR>
|
---|
361 | Returns the Public ID of the DTD specified in the EJB descriptor.</TD>
|
---|
362 | </TR>
|
---|
363 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
364 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
365 | <CODE>protected <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></FONT></TD>
|
---|
366 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getTask()">getTask</A></B>()</CODE>
|
---|
367 |
|
---|
368 | <BR>
|
---|
369 | Get the task for this tool.</TD>
|
---|
370 | </TR>
|
---|
371 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
372 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
373 | <CODE> java.lang.String</CODE></FONT></TD>
|
---|
374 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#getVendorDDPrefix(java.lang.String, java.lang.String)">getVendorDDPrefix</A></B>(java.lang.String baseName,
|
---|
375 | java.lang.String descriptorFileName)</CODE>
|
---|
376 |
|
---|
377 | <BR>
|
---|
378 | Get the prefix for vendor deployment descriptors.</TD>
|
---|
379 | </TR>
|
---|
380 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
381 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
382 | <CODE>protected void</CODE></FONT></TD>
|
---|
383 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#log(java.lang.String, int)">log</A></B>(java.lang.String message,
|
---|
384 | int level)</CODE>
|
---|
385 |
|
---|
386 | <BR>
|
---|
387 | Log a message to the Ant output.</TD>
|
---|
388 | </TR>
|
---|
389 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
390 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
391 | <CODE>protected boolean</CODE></FONT></TD>
|
---|
392 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#needToRebuild(java.util.Hashtable, java.io.File)">needToRebuild</A></B>(java.util.Hashtable ejbFiles,
|
---|
393 | java.io.File jarFile)</CODE>
|
---|
394 |
|
---|
395 | <BR>
|
---|
396 | This method checks the timestamp on each file listed in the <code>
|
---|
397 | ejbFiles</code> and compares them to the timestamp on the <code>jarFile
|
---|
398 | </code>.</TD>
|
---|
399 | </TR>
|
---|
400 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
401 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
402 | <CODE>protected java.util.Hashtable</CODE></FONT></TD>
|
---|
403 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#parseEjbFiles(java.lang.String, javax.xml.parsers.SAXParser)">parseEjbFiles</A></B>(java.lang.String descriptorFileName,
|
---|
404 | javax.xml.parsers.SAXParser saxParser)</CODE>
|
---|
405 |
|
---|
406 | <BR>
|
---|
407 | This method returns a list of EJB files found when the specified EJB
|
---|
408 | descriptor is parsed and processed.</TD>
|
---|
409 | </TR>
|
---|
410 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
411 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
412 | <CODE> void</CODE></FONT></TD>
|
---|
413 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#processDescriptor(java.lang.String, javax.xml.parsers.SAXParser)">processDescriptor</A></B>(java.lang.String descriptorFileName,
|
---|
414 | javax.xml.parsers.SAXParser saxParser)</CODE>
|
---|
415 |
|
---|
416 | <BR>
|
---|
417 | Process a deployment descriptor, generating the necessary vendor specific
|
---|
418 | deployment files.</TD>
|
---|
419 | </TR>
|
---|
420 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
421 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
422 | <CODE>protected void</CODE></FONT></TD>
|
---|
423 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#registerKnownDTDs(org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler)">registerKnownDTDs</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">DescriptorHandler</A> handler)</CODE>
|
---|
424 |
|
---|
425 | <BR>
|
---|
426 | Register the locations of all known DTDs.</TD>
|
---|
427 | </TR>
|
---|
428 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
429 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
430 | <CODE> void</CODE></FONT></TD>
|
---|
431 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.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> classpath)</CODE>
|
---|
432 |
|
---|
433 | <BR>
|
---|
434 | Set the classpath to be used for this compilation.</TD>
|
---|
435 | </TR>
|
---|
436 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
437 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
438 | <CODE> void</CODE></FONT></TD>
|
---|
439 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setDestdir(java.io.File)">setDestdir</A></B>(java.io.File inDir)</CODE>
|
---|
440 |
|
---|
441 | <BR>
|
---|
442 | Set the destination directory; required.</TD>
|
---|
443 | </TR>
|
---|
444 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
445 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
446 | <CODE> void</CODE></FONT></TD>
|
---|
447 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setGenericJarSuffix(java.lang.String)">setGenericJarSuffix</A></B>(java.lang.String inString)</CODE>
|
---|
448 |
|
---|
449 | <BR>
|
---|
450 | Set the suffix for the generated jar file.</TD>
|
---|
451 | </TR>
|
---|
452 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
453 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
454 | <CODE> void</CODE></FONT></TD>
|
---|
455 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#setTask(org.apache.tools.ant.Task)">setTask</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</CODE>
|
---|
456 |
|
---|
457 | <BR>
|
---|
458 | Set the task which owns this tool</TD>
|
---|
459 | </TR>
|
---|
460 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
461 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
462 | <CODE>protected boolean</CODE></FONT></TD>
|
---|
463 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#usingBaseJarName()">usingBaseJarName</A></B>()</CODE>
|
---|
464 |
|
---|
465 | <BR>
|
---|
466 | Indicate if this build is using the base jar name.</TD>
|
---|
467 | </TR>
|
---|
468 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
469 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
470 | <CODE> void</CODE></FONT></TD>
|
---|
471 | <TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/GenericDeploymentTool.html#validateConfigured()">validateConfigured</A></B>()</CODE>
|
---|
472 |
|
---|
473 | <BR>
|
---|
474 | Called to validate that the tool parameters have been configured.</TD>
|
---|
475 | </TR>
|
---|
476 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
477 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
---|
478 | <CODE>protected void</CODE></FONT></TD>
|
---|
479 | <TD><CODE><B><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></B>(java.lang.String baseName,
|
---|
480 | java.io.File jarfile,
|
---|
481 | java.util.Hashtable files,
|
---|
482 | java.lang.String publicId)</CODE>
|
---|
483 |
|
---|
484 | <BR>
|
---|
485 | Method used to encapsulate the writing of the JAR file.</TD>
|
---|
486 | </TR>
|
---|
487 | </TABLE>
|
---|
488 | <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
---|
489 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
490 | <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
---|
491 | <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
---|
492 | </TR>
|
---|
493 | <TR BGCOLOR="white" CLASS="TableRowColor">
|
---|
494 | <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
---|
495 | </TR>
|
---|
496 | </TABLE>
|
---|
497 |
|
---|
498 | <P>
|
---|
499 |
|
---|
500 | <!-- ============ FIELD DETAIL =========== -->
|
---|
501 |
|
---|
502 | <A NAME="field_detail"><!-- --></A>
|
---|
503 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
504 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
505 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
506 | <B>Field Detail</B></FONT></TD>
|
---|
507 | </TR>
|
---|
508 | </TABLE>
|
---|
509 |
|
---|
510 | <A NAME="META_DIR"><!-- --></A><H3>
|
---|
511 | META_DIR</H3>
|
---|
512 | <PRE>
|
---|
513 | protected static final java.lang.String <B>META_DIR</B></PRE>
|
---|
514 | <DL>
|
---|
515 | <DD>The standard META-INF directory in jar files
|
---|
516 | <P>
|
---|
517 | <DL>
|
---|
518 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.META_DIR">Constant Field Values</A></DL>
|
---|
519 | </DL>
|
---|
520 | <HR>
|
---|
521 |
|
---|
522 | <A NAME="MANIFEST"><!-- --></A><H3>
|
---|
523 | MANIFEST</H3>
|
---|
524 | <PRE>
|
---|
525 | protected static final java.lang.String <B>MANIFEST</B></PRE>
|
---|
526 | <DL>
|
---|
527 | <DD>The standard MANIFEST file
|
---|
528 | <P>
|
---|
529 | <DL>
|
---|
530 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.MANIFEST">Constant Field Values</A></DL>
|
---|
531 | </DL>
|
---|
532 | <HR>
|
---|
533 |
|
---|
534 | <A NAME="EJB_DD"><!-- --></A><H3>
|
---|
535 | EJB_DD</H3>
|
---|
536 | <PRE>
|
---|
537 | protected static final java.lang.String <B>EJB_DD</B></PRE>
|
---|
538 | <DL>
|
---|
539 | <DD>Name for EJB Deployment descriptor within EJB jars
|
---|
540 | <P>
|
---|
541 | <DL>
|
---|
542 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.EJB_DD">Constant Field Values</A></DL>
|
---|
543 | </DL>
|
---|
544 | <HR>
|
---|
545 |
|
---|
546 | <A NAME="ANALYZER_SUPER"><!-- --></A><H3>
|
---|
547 | ANALYZER_SUPER</H3>
|
---|
548 | <PRE>
|
---|
549 | public static final java.lang.String <B>ANALYZER_SUPER</B></PRE>
|
---|
550 | <DL>
|
---|
551 | <DD>A dependency analyzer name to find ancestor classes
|
---|
552 | <P>
|
---|
553 | <DL>
|
---|
554 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.ANALYZER_SUPER">Constant Field Values</A></DL>
|
---|
555 | </DL>
|
---|
556 | <HR>
|
---|
557 |
|
---|
558 | <A NAME="ANALYZER_FULL"><!-- --></A><H3>
|
---|
559 | ANALYZER_FULL</H3>
|
---|
560 | <PRE>
|
---|
561 | public static final java.lang.String <B>ANALYZER_FULL</B></PRE>
|
---|
562 | <DL>
|
---|
563 | <DD>A dependency analyzer name to find all related classes
|
---|
564 | <P>
|
---|
565 | <DL>
|
---|
566 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.ANALYZER_FULL">Constant Field Values</A></DL>
|
---|
567 | </DL>
|
---|
568 | <HR>
|
---|
569 |
|
---|
570 | <A NAME="ANALYZER_NONE"><!-- --></A><H3>
|
---|
571 | ANALYZER_NONE</H3>
|
---|
572 | <PRE>
|
---|
573 | public static final java.lang.String <B>ANALYZER_NONE</B></PRE>
|
---|
574 | <DL>
|
---|
575 | <DD>A dependency analyzer name for no analyzer
|
---|
576 | <P>
|
---|
577 | <DL>
|
---|
578 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.ANALYZER_NONE">Constant Field Values</A></DL>
|
---|
579 | </DL>
|
---|
580 | <HR>
|
---|
581 |
|
---|
582 | <A NAME="DEFAULT_ANALYZER"><!-- --></A><H3>
|
---|
583 | DEFAULT_ANALYZER</H3>
|
---|
584 | <PRE>
|
---|
585 | public static final java.lang.String <B>DEFAULT_ANALYZER</B></PRE>
|
---|
586 | <DL>
|
---|
587 | <DD>The default analyzer
|
---|
588 | <P>
|
---|
589 | <DL>
|
---|
590 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.DEFAULT_ANALYZER">Constant Field Values</A></DL>
|
---|
591 | </DL>
|
---|
592 | <HR>
|
---|
593 |
|
---|
594 | <A NAME="ANALYZER_CLASS_SUPER"><!-- --></A><H3>
|
---|
595 | ANALYZER_CLASS_SUPER</H3>
|
---|
596 | <PRE>
|
---|
597 | public static final java.lang.String <B>ANALYZER_CLASS_SUPER</B></PRE>
|
---|
598 | <DL>
|
---|
599 | <DD>The analyzer class for the super analyzer
|
---|
600 | <P>
|
---|
601 | <DL>
|
---|
602 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.ANALYZER_CLASS_SUPER">Constant Field Values</A></DL>
|
---|
603 | </DL>
|
---|
604 | <HR>
|
---|
605 |
|
---|
606 | <A NAME="ANALYZER_CLASS_FULL"><!-- --></A><H3>
|
---|
607 | ANALYZER_CLASS_FULL</H3>
|
---|
608 | <PRE>
|
---|
609 | public static final java.lang.String <B>ANALYZER_CLASS_FULL</B></PRE>
|
---|
610 | <DL>
|
---|
611 | <DD>The analyzer class for the super analyzer
|
---|
612 | <P>
|
---|
613 | <DL>
|
---|
614 | <DT><B>See Also:</B><DD><A HREF="../../../../../../../constant-values.html#org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool.ANALYZER_CLASS_FULL">Constant Field Values</A></DL>
|
---|
615 | </DL>
|
---|
616 |
|
---|
617 | <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
---|
618 |
|
---|
619 | <A NAME="constructor_detail"><!-- --></A>
|
---|
620 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
621 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
622 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
623 | <B>Constructor Detail</B></FONT></TD>
|
---|
624 | </TR>
|
---|
625 | </TABLE>
|
---|
626 |
|
---|
627 | <A NAME="GenericDeploymentTool()"><!-- --></A><H3>
|
---|
628 | GenericDeploymentTool</H3>
|
---|
629 | <PRE>
|
---|
630 | public <B>GenericDeploymentTool</B>()</PRE>
|
---|
631 | <DL>
|
---|
632 | </DL>
|
---|
633 |
|
---|
634 | <!-- ============ METHOD DETAIL ========== -->
|
---|
635 |
|
---|
636 | <A NAME="method_detail"><!-- --></A>
|
---|
637 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
---|
638 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
---|
639 | <TD COLSPAN=1><FONT SIZE="+2">
|
---|
640 | <B>Method Detail</B></FONT></TD>
|
---|
641 | </TR>
|
---|
642 | </TABLE>
|
---|
643 |
|
---|
644 | <A NAME="setDestdir(java.io.File)"><!-- --></A><H3>
|
---|
645 | setDestdir</H3>
|
---|
646 | <PRE>
|
---|
647 | public void <B>setDestdir</B>(java.io.File inDir)</PRE>
|
---|
648 | <DL>
|
---|
649 | <DD>Set the destination directory; required.
|
---|
650 | <P>
|
---|
651 | <DD><DL>
|
---|
652 | </DL>
|
---|
653 | </DD>
|
---|
654 | <DD><DL>
|
---|
655 | <DT><B>Parameters:</B><DD><CODE>inDir</CODE> - the destination directory.</DL>
|
---|
656 | </DD>
|
---|
657 | </DL>
|
---|
658 | <HR>
|
---|
659 |
|
---|
660 | <A NAME="getDestDir()"><!-- --></A><H3>
|
---|
661 | getDestDir</H3>
|
---|
662 | <PRE>
|
---|
663 | protected java.io.File <B>getDestDir</B>()</PRE>
|
---|
664 | <DL>
|
---|
665 | <DD>Get the destination directory.
|
---|
666 | <P>
|
---|
667 | <DD><DL>
|
---|
668 | </DL>
|
---|
669 | </DD>
|
---|
670 | <DD><DL>
|
---|
671 |
|
---|
672 | <DT><B>Returns:</B><DD>the destination directory into which EJB jars are to be written</DL>
|
---|
673 | </DD>
|
---|
674 | </DL>
|
---|
675 | <HR>
|
---|
676 |
|
---|
677 | <A NAME="setTask(org.apache.tools.ant.Task)"><!-- --></A><H3>
|
---|
678 | setTask</H3>
|
---|
679 | <PRE>
|
---|
680 | public void <B>setTask</B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> task)</PRE>
|
---|
681 | <DL>
|
---|
682 | <DD>Set the task which owns this tool
|
---|
683 | <P>
|
---|
684 | <DD><DL>
|
---|
685 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html#setTask(org.apache.tools.ant.Task)">setTask</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></DL>
|
---|
686 | </DD>
|
---|
687 | <DD><DL>
|
---|
688 | <DT><B>Parameters:</B><DD><CODE>task</CODE> - the Task to which this deployment tool is associated.</DL>
|
---|
689 | </DD>
|
---|
690 | </DL>
|
---|
691 | <HR>
|
---|
692 |
|
---|
693 | <A NAME="getTask()"><!-- --></A><H3>
|
---|
694 | getTask</H3>
|
---|
695 | <PRE>
|
---|
696 | protected <A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A> <B>getTask</B>()</PRE>
|
---|
697 | <DL>
|
---|
698 | <DD>Get the task for this tool.
|
---|
699 | <P>
|
---|
700 | <DD><DL>
|
---|
701 | </DL>
|
---|
702 | </DD>
|
---|
703 | <DD><DL>
|
---|
704 |
|
---|
705 | <DT><B>Returns:</B><DD>the Task instance this tool is associated with.</DL>
|
---|
706 | </DD>
|
---|
707 | </DL>
|
---|
708 | <HR>
|
---|
709 |
|
---|
710 | <A NAME="getConfig()"><!-- --></A><H3>
|
---|
711 | getConfig</H3>
|
---|
712 | <PRE>
|
---|
713 | protected org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config <B>getConfig</B>()</PRE>
|
---|
714 | <DL>
|
---|
715 | <DD>Get the basename terminator.
|
---|
716 | <P>
|
---|
717 | <DD><DL>
|
---|
718 | </DL>
|
---|
719 | </DD>
|
---|
720 | <DD><DL>
|
---|
721 |
|
---|
722 | <DT><B>Returns:</B><DD>an ejbjar task configuration</DL>
|
---|
723 | </DD>
|
---|
724 | </DL>
|
---|
725 | <HR>
|
---|
726 |
|
---|
727 | <A NAME="usingBaseJarName()"><!-- --></A><H3>
|
---|
728 | usingBaseJarName</H3>
|
---|
729 | <PRE>
|
---|
730 | protected boolean <B>usingBaseJarName</B>()</PRE>
|
---|
731 | <DL>
|
---|
732 | <DD>Indicate if this build is using the base jar name.
|
---|
733 | <P>
|
---|
734 | <DD><DL>
|
---|
735 | </DL>
|
---|
736 | </DD>
|
---|
737 | <DD><DL>
|
---|
738 |
|
---|
739 | <DT><B>Returns:</B><DD>true if the name of the generated jar is coming from the
|
---|
740 | basejarname attribute</DL>
|
---|
741 | </DD>
|
---|
742 | </DL>
|
---|
743 | <HR>
|
---|
744 |
|
---|
745 | <A NAME="setGenericJarSuffix(java.lang.String)"><!-- --></A><H3>
|
---|
746 | setGenericJarSuffix</H3>
|
---|
747 | <PRE>
|
---|
748 | public void <B>setGenericJarSuffix</B>(java.lang.String inString)</PRE>
|
---|
749 | <DL>
|
---|
750 | <DD>Set the suffix for the generated jar file.
|
---|
751 | <P>
|
---|
752 | <DD><DL>
|
---|
753 | </DL>
|
---|
754 | </DD>
|
---|
755 | <DD><DL>
|
---|
756 | <DT><B>Parameters:</B><DD><CODE>inString</CODE> - the string to use as the suffix.</DL>
|
---|
757 | </DD>
|
---|
758 | </DL>
|
---|
759 | <HR>
|
---|
760 |
|
---|
761 | <A NAME="createClasspath()"><!-- --></A><H3>
|
---|
762 | createClasspath</H3>
|
---|
763 | <PRE>
|
---|
764 | public <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
|
---|
765 | <DL>
|
---|
766 | <DD>Add the classpath for the user classes
|
---|
767 | <P>
|
---|
768 | <DD><DL>
|
---|
769 | </DL>
|
---|
770 | </DD>
|
---|
771 | <DD><DL>
|
---|
772 |
|
---|
773 | <DT><B>Returns:</B><DD>a Path instance to be configured by Ant.</DL>
|
---|
774 | </DD>
|
---|
775 | </DL>
|
---|
776 | <HR>
|
---|
777 |
|
---|
778 | <A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
|
---|
779 | setClasspath</H3>
|
---|
780 | <PRE>
|
---|
781 | public void <B>setClasspath</B>(<A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> classpath)</PRE>
|
---|
782 | <DL>
|
---|
783 | <DD>Set the classpath to be used for this compilation.
|
---|
784 | <P>
|
---|
785 | <DD><DL>
|
---|
786 | </DL>
|
---|
787 | </DD>
|
---|
788 | <DD><DL>
|
---|
789 | <DT><B>Parameters:</B><DD><CODE>classpath</CODE> - the classpath to be used for this build.</DL>
|
---|
790 | </DD>
|
---|
791 | </DL>
|
---|
792 | <HR>
|
---|
793 |
|
---|
794 | <A NAME="getCombinedClasspath()"><!-- --></A><H3>
|
---|
795 | getCombinedClasspath</H3>
|
---|
796 | <PRE>
|
---|
797 | protected <A HREF="../../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>getCombinedClasspath</B>()</PRE>
|
---|
798 | <DL>
|
---|
799 | <DD>Get the classpath by combining the one from the surrounding task, if any
|
---|
800 | and the one from this tool.
|
---|
801 | <P>
|
---|
802 | <DD><DL>
|
---|
803 | </DL>
|
---|
804 | </DD>
|
---|
805 | <DD><DL>
|
---|
806 |
|
---|
807 | <DT><B>Returns:</B><DD>the combined classpath</DL>
|
---|
808 | </DD>
|
---|
809 | </DL>
|
---|
810 | <HR>
|
---|
811 |
|
---|
812 | <A NAME="log(java.lang.String, int)"><!-- --></A><H3>
|
---|
813 | log</H3>
|
---|
814 | <PRE>
|
---|
815 | protected void <B>log</B>(java.lang.String message,
|
---|
816 | int level)</PRE>
|
---|
817 | <DL>
|
---|
818 | <DD>Log a message to the Ant output.
|
---|
819 | <P>
|
---|
820 | <DD><DL>
|
---|
821 | </DL>
|
---|
822 | </DD>
|
---|
823 | <DD><DL>
|
---|
824 | <DT><B>Parameters:</B><DD><CODE>message</CODE> - the message to be logged.<DD><CODE>level</CODE> - the severity of this message.</DL>
|
---|
825 | </DD>
|
---|
826 | </DL>
|
---|
827 | <HR>
|
---|
828 |
|
---|
829 | <A NAME="getLocation()"><!-- --></A><H3>
|
---|
830 | getLocation</H3>
|
---|
831 | <PRE>
|
---|
832 | protected <A HREF="../../../../../../../org/apache/tools/ant/Location.html" title="class in org.apache.tools.ant">Location</A> <B>getLocation</B>()</PRE>
|
---|
833 | <DL>
|
---|
834 | <DD>Get the build file location associated with this element's task.
|
---|
835 | <P>
|
---|
836 | <DD><DL>
|
---|
837 | </DL>
|
---|
838 | </DD>
|
---|
839 | <DD><DL>
|
---|
840 |
|
---|
841 | <DT><B>Returns:</B><DD>the task's location instance.</DL>
|
---|
842 | </DD>
|
---|
843 | </DL>
|
---|
844 | <HR>
|
---|
845 |
|
---|
846 | <A NAME="configure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config)"><!-- --></A><H3>
|
---|
847 | configure</H3>
|
---|
848 | <PRE>
|
---|
849 | public void <B>configure</B>(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config config)</PRE>
|
---|
850 | <DL>
|
---|
851 | <DD>Configure this tool for use in the ejbjar task.
|
---|
852 | <P>
|
---|
853 | <DD><DL>
|
---|
854 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html#configure(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.Config)">configure</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></DL>
|
---|
855 | </DD>
|
---|
856 | <DD><DL>
|
---|
857 | <DT><B>Parameters:</B><DD><CODE>config</CODE> - the configuration from the surrounding ejbjar task.</DL>
|
---|
858 | </DD>
|
---|
859 | </DL>
|
---|
860 | <HR>
|
---|
861 |
|
---|
862 | <A NAME="addFileToJar(java.util.jar.JarOutputStream, java.io.File, java.lang.String)"><!-- --></A><H3>
|
---|
863 | addFileToJar</H3>
|
---|
864 | <PRE>
|
---|
865 | protected void <B>addFileToJar</B>(java.util.jar.JarOutputStream jStream,
|
---|
866 | java.io.File inputFile,
|
---|
867 | java.lang.String logicalFilename)
|
---|
868 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
869 | <DL>
|
---|
870 | <DD>Utility method that encapsulates the logic of adding a file entry to
|
---|
871 | a .jar file. Used by execute() to add entries to the jar file as it is
|
---|
872 | constructed.
|
---|
873 | <P>
|
---|
874 | <DD><DL>
|
---|
875 | </DL>
|
---|
876 | </DD>
|
---|
877 | <DD><DL>
|
---|
878 | <DT><B>Parameters:</B><DD><CODE>jStream</CODE> - A JarOutputStream into which to write the
|
---|
879 | jar entry.<DD><CODE>inputFile</CODE> - A File from which to read the
|
---|
880 | contents the file being added.<DD><CODE>logicalFilename</CODE> - A String representing the name, including
|
---|
881 | all relevant path information, that should be stored for the entry
|
---|
882 | being added.
|
---|
883 | <DT><B>Throws:</B>
|
---|
884 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
|
---|
885 | </DD>
|
---|
886 | </DL>
|
---|
887 | <HR>
|
---|
888 |
|
---|
889 | <A NAME="getDescriptorHandler(java.io.File)"><!-- --></A><H3>
|
---|
890 | getDescriptorHandler</H3>
|
---|
891 | <PRE>
|
---|
892 | protected <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">DescriptorHandler</A> <B>getDescriptorHandler</B>(java.io.File srcDir)</PRE>
|
---|
893 | <DL>
|
---|
894 | <DD><DL>
|
---|
895 | </DL>
|
---|
896 | </DD>
|
---|
897 | <DD><DL>
|
---|
898 | </DL>
|
---|
899 | </DD>
|
---|
900 | </DL>
|
---|
901 | <HR>
|
---|
902 |
|
---|
903 | <A NAME="registerKnownDTDs(org.apache.tools.ant.taskdefs.optional.ejb.DescriptorHandler)"><!-- --></A><H3>
|
---|
904 | registerKnownDTDs</H3>
|
---|
905 | <PRE>
|
---|
906 | protected void <B>registerKnownDTDs</B>(<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/DescriptorHandler.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb">DescriptorHandler</A> handler)</PRE>
|
---|
907 | <DL>
|
---|
908 | <DD>Register the locations of all known DTDs.
|
---|
909 |
|
---|
910 | vendor-specific subclasses should override this method to define
|
---|
911 | the vendor-specific locations of the EJB DTDs
|
---|
912 | <P>
|
---|
913 | <DD><DL>
|
---|
914 | </DL>
|
---|
915 | </DD>
|
---|
916 | <DD><DL>
|
---|
917 | </DL>
|
---|
918 | </DD>
|
---|
919 | </DL>
|
---|
920 | <HR>
|
---|
921 |
|
---|
922 | <A NAME="processDescriptor(java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
|
---|
923 | processDescriptor</H3>
|
---|
924 | <PRE>
|
---|
925 | public void <B>processDescriptor</B>(java.lang.String descriptorFileName,
|
---|
926 | javax.xml.parsers.SAXParser saxParser)</PRE>
|
---|
927 | <DL>
|
---|
928 | <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>
|
---|
929 | <DD>Process a deployment descriptor, generating the necessary vendor specific
|
---|
930 | deployment files.
|
---|
931 | <P>
|
---|
932 | <DD><DL>
|
---|
933 | <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></DL>
|
---|
934 | </DD>
|
---|
935 | <DD><DL>
|
---|
936 | <DT><B>Parameters:</B><DD><CODE>descriptorFileName</CODE> - the name of the deployment descriptor<DD><CODE>saxParser</CODE> - a SAX parser which can be used to parse the deployment descriptor.</DL>
|
---|
937 | </DD>
|
---|
938 | </DL>
|
---|
939 | <HR>
|
---|
940 |
|
---|
941 | <A NAME="checkConfiguration(java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
|
---|
942 | checkConfiguration</H3>
|
---|
943 | <PRE>
|
---|
944 | protected void <B>checkConfiguration</B>(java.lang.String descriptorFileName,
|
---|
945 | javax.xml.parsers.SAXParser saxParser)
|
---|
946 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
947 | <DL>
|
---|
948 | <DD>This method is called as the first step in the processDescriptor method
|
---|
949 | to allow vendor-specific subclasses to validate the task configuration
|
---|
950 | prior to processing the descriptor. If the configuration is invalid,
|
---|
951 | a BuildException should be thrown.
|
---|
952 | <P>
|
---|
953 | <DD><DL>
|
---|
954 | </DL>
|
---|
955 | </DD>
|
---|
956 | <DD><DL>
|
---|
957 | <DT><B>Parameters:</B><DD><CODE>descriptorFileName</CODE> - String representing the file name of an EJB
|
---|
958 | descriptor to be processed<DD><CODE>saxParser</CODE> - SAXParser which may be used to parse the XML
|
---|
959 | descriptor
|
---|
960 | <DT><B>Throws:</B>
|
---|
961 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - Thrown if the configuration is invalid</DL>
|
---|
962 | </DD>
|
---|
963 | </DL>
|
---|
964 | <HR>
|
---|
965 |
|
---|
966 | <A NAME="parseEjbFiles(java.lang.String, javax.xml.parsers.SAXParser)"><!-- --></A><H3>
|
---|
967 | parseEjbFiles</H3>
|
---|
968 | <PRE>
|
---|
969 | protected java.util.Hashtable <B>parseEjbFiles</B>(java.lang.String descriptorFileName,
|
---|
970 | javax.xml.parsers.SAXParser saxParser)
|
---|
971 | throws java.io.IOException,
|
---|
972 | org.xml.sax.SAXException</PRE>
|
---|
973 | <DL>
|
---|
974 | <DD>This method returns a list of EJB files found when the specified EJB
|
---|
975 | descriptor is parsed and processed.
|
---|
976 | <P>
|
---|
977 | <DD><DL>
|
---|
978 | </DL>
|
---|
979 | </DD>
|
---|
980 | <DD><DL>
|
---|
981 | <DT><B>Parameters:</B><DD><CODE>descriptorFileName</CODE> - String representing the file name of an EJB
|
---|
982 | descriptor to be processed<DD><CODE>saxParser</CODE> - SAXParser which may be used to parse the XML
|
---|
983 | descriptor
|
---|
984 | <DT><B>Returns:</B><DD>Hashtable of EJB class (and other) files to be
|
---|
985 | added to the completed JAR file
|
---|
986 | <DT><B>Throws:</B>
|
---|
987 | <DD><CODE>org.xml.sax.SAXException</CODE> - Any SAX exception, possibly wrapping another
|
---|
988 | exception
|
---|
989 | <DD><CODE>java.io.IOException</CODE> - An IOException from the parser, possibly from a
|
---|
990 | the byte stream or character stream</DL>
|
---|
991 | </DD>
|
---|
992 | </DL>
|
---|
993 | <HR>
|
---|
994 |
|
---|
995 | <A NAME="addSupportClasses(java.util.Hashtable)"><!-- --></A><H3>
|
---|
996 | addSupportClasses</H3>
|
---|
997 | <PRE>
|
---|
998 | protected void <B>addSupportClasses</B>(java.util.Hashtable ejbFiles)</PRE>
|
---|
999 | <DL>
|
---|
1000 | <DD>Adds any classes the user specifies using <i>support</i> nested elements
|
---|
1001 | to the <code>ejbFiles</code> Hashtable.
|
---|
1002 | <P>
|
---|
1003 | <DD><DL>
|
---|
1004 | </DL>
|
---|
1005 | </DD>
|
---|
1006 | <DD><DL>
|
---|
1007 | <DT><B>Parameters:</B><DD><CODE>ejbFiles</CODE> - Hashtable of EJB classes (and other) files that will be
|
---|
1008 | added to the completed JAR file</DL>
|
---|
1009 | </DD>
|
---|
1010 | </DL>
|
---|
1011 | <HR>
|
---|
1012 |
|
---|
1013 | <A NAME="getJarBaseName(java.lang.String)"><!-- --></A><H3>
|
---|
1014 | getJarBaseName</H3>
|
---|
1015 | <PRE>
|
---|
1016 | protected java.lang.String <B>getJarBaseName</B>(java.lang.String descriptorFileName)</PRE>
|
---|
1017 | <DL>
|
---|
1018 | <DD>Using the EJB descriptor file name passed from the <code>ejbjar</code>
|
---|
1019 | task, this method returns the "basename" which will be used to name the
|
---|
1020 | completed JAR file.
|
---|
1021 | <P>
|
---|
1022 | <DD><DL>
|
---|
1023 | </DL>
|
---|
1024 | </DD>
|
---|
1025 | <DD><DL>
|
---|
1026 | <DT><B>Parameters:</B><DD><CODE>descriptorFileName</CODE> - String representing the file name of an EJB
|
---|
1027 | descriptor to be processed
|
---|
1028 | <DT><B>Returns:</B><DD>The "basename" which will be used to name the
|
---|
1029 | completed JAR file</DL>
|
---|
1030 | </DD>
|
---|
1031 | </DL>
|
---|
1032 | <HR>
|
---|
1033 |
|
---|
1034 | <A NAME="getVendorDDPrefix(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
---|
1035 | getVendorDDPrefix</H3>
|
---|
1036 | <PRE>
|
---|
1037 | public java.lang.String <B>getVendorDDPrefix</B>(java.lang.String baseName,
|
---|
1038 | java.lang.String descriptorFileName)</PRE>
|
---|
1039 | <DL>
|
---|
1040 | <DD>Get the prefix for vendor deployment descriptors.
|
---|
1041 |
|
---|
1042 | This will contain the path and the start of the descriptor name,
|
---|
1043 | depending on the naming scheme
|
---|
1044 | <P>
|
---|
1045 | <DD><DL>
|
---|
1046 | </DL>
|
---|
1047 | </DD>
|
---|
1048 | <DD><DL>
|
---|
1049 | </DL>
|
---|
1050 | </DD>
|
---|
1051 | </DL>
|
---|
1052 | <HR>
|
---|
1053 |
|
---|
1054 | <A NAME="addVendorFiles(java.util.Hashtable, java.lang.String)"><!-- --></A><H3>
|
---|
1055 | addVendorFiles</H3>
|
---|
1056 | <PRE>
|
---|
1057 | protected void <B>addVendorFiles</B>(java.util.Hashtable ejbFiles,
|
---|
1058 | java.lang.String ddPrefix)</PRE>
|
---|
1059 | <DL>
|
---|
1060 | <DD>Add any vendor specific files which should be included in the
|
---|
1061 | EJB Jar.
|
---|
1062 | <P>
|
---|
1063 | <DD><DL>
|
---|
1064 | </DL>
|
---|
1065 | </DD>
|
---|
1066 | <DD><DL>
|
---|
1067 | </DL>
|
---|
1068 | </DD>
|
---|
1069 | </DL>
|
---|
1070 | <HR>
|
---|
1071 |
|
---|
1072 | <A NAME="needToRebuild(java.util.Hashtable, java.io.File)"><!-- --></A><H3>
|
---|
1073 | needToRebuild</H3>
|
---|
1074 | <PRE>
|
---|
1075 | protected boolean <B>needToRebuild</B>(java.util.Hashtable ejbFiles,
|
---|
1076 | java.io.File jarFile)</PRE>
|
---|
1077 | <DL>
|
---|
1078 | <DD>This method checks the timestamp on each file listed in the <code>
|
---|
1079 | ejbFiles</code> and compares them to the timestamp on the <code>jarFile
|
---|
1080 | </code>. If the <code>jarFile</code>'s timestamp is more recent than
|
---|
1081 | each EJB file, <code>true</code> is returned. Otherwise, <code>false
|
---|
1082 | </code> is returned.
|
---|
1083 | TODO: find a way to check the manifest-file, that is found by naming convention
|
---|
1084 | <P>
|
---|
1085 | <DD><DL>
|
---|
1086 | </DL>
|
---|
1087 | </DD>
|
---|
1088 | <DD><DL>
|
---|
1089 | <DT><B>Parameters:</B><DD><CODE>ejbFiles</CODE> - Hashtable of EJB classes (and other) files that will be
|
---|
1090 | added to the completed JAR file<DD><CODE>jarFile</CODE> - JAR file which will contain all of the EJB classes (and
|
---|
1091 | other) files
|
---|
1092 | <DT><B>Returns:</B><DD>boolean indicating whether or not the <code>jarFile</code>
|
---|
1093 | is up to date</DL>
|
---|
1094 | </DD>
|
---|
1095 | </DL>
|
---|
1096 | <HR>
|
---|
1097 |
|
---|
1098 | <A NAME="getPublicId()"><!-- --></A><H3>
|
---|
1099 | getPublicId</H3>
|
---|
1100 | <PRE>
|
---|
1101 | protected java.lang.String <B>getPublicId</B>()</PRE>
|
---|
1102 | <DL>
|
---|
1103 | <DD>Returns the Public ID of the DTD specified in the EJB descriptor. Not
|
---|
1104 | every vendor-specific <code>DeploymentTool</code> will need to reference
|
---|
1105 | this value or may want to determine this value in a vendor-specific way.
|
---|
1106 | <P>
|
---|
1107 | <DD><DL>
|
---|
1108 | </DL>
|
---|
1109 | </DD>
|
---|
1110 | <DD><DL>
|
---|
1111 |
|
---|
1112 | <DT><B>Returns:</B><DD>Public ID of the DTD specified in the EJB descriptor.</DL>
|
---|
1113 | </DD>
|
---|
1114 | </DL>
|
---|
1115 | <HR>
|
---|
1116 |
|
---|
1117 | <A NAME="getManifestFile(java.lang.String)"><!-- --></A><H3>
|
---|
1118 | getManifestFile</H3>
|
---|
1119 | <PRE>
|
---|
1120 | protected java.io.File <B>getManifestFile</B>(java.lang.String prefix)</PRE>
|
---|
1121 | <DL>
|
---|
1122 | <DD>Get the manifets file to use for building the generic jar.
|
---|
1123 |
|
---|
1124 | If the file does not exist the global manifest from the config is used
|
---|
1125 | otherwise the default Ant manifest will be used.
|
---|
1126 | <P>
|
---|
1127 | <DD><DL>
|
---|
1128 | </DL>
|
---|
1129 | </DD>
|
---|
1130 | <DD><DL>
|
---|
1131 | <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix where to llook for the manifest file based on
|
---|
1132 | the naming convention.
|
---|
1133 | <DT><B>Returns:</B><DD>the manifest file or null if the manifest file does not exist</DL>
|
---|
1134 | </DD>
|
---|
1135 | </DL>
|
---|
1136 | <HR>
|
---|
1137 |
|
---|
1138 | <A NAME="writeJar(java.lang.String, java.io.File, java.util.Hashtable, java.lang.String)"><!-- --></A><H3>
|
---|
1139 | writeJar</H3>
|
---|
1140 | <PRE>
|
---|
1141 | protected void <B>writeJar</B>(java.lang.String baseName,
|
---|
1142 | java.io.File jarfile,
|
---|
1143 | java.util.Hashtable files,
|
---|
1144 | java.lang.String publicId)
|
---|
1145 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1146 | <DL>
|
---|
1147 | <DD>Method used to encapsulate the writing of the JAR file. Iterates over the
|
---|
1148 | filenames/java.io.Files in the Hashtable stored on the instance variable
|
---|
1149 | ejbFiles.
|
---|
1150 | <P>
|
---|
1151 | <DD><DL>
|
---|
1152 | </DL>
|
---|
1153 | </DD>
|
---|
1154 | <DD><DL>
|
---|
1155 |
|
---|
1156 | <DT><B>Throws:</B>
|
---|
1157 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
|
---|
1158 | </DD>
|
---|
1159 | </DL>
|
---|
1160 | <HR>
|
---|
1161 |
|
---|
1162 | <A NAME="checkAndAddDependants(java.util.Hashtable)"><!-- --></A><H3>
|
---|
1163 | checkAndAddDependants</H3>
|
---|
1164 | <PRE>
|
---|
1165 | protected void <B>checkAndAddDependants</B>(java.util.Hashtable checkEntries)
|
---|
1166 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1167 | <DL>
|
---|
1168 | <DD>Add all available classes, that depend on Remote, Home, Bean, PK
|
---|
1169 | <P>
|
---|
1170 | <DD><DL>
|
---|
1171 | </DL>
|
---|
1172 | </DD>
|
---|
1173 | <DD><DL>
|
---|
1174 | <DT><B>Parameters:</B><DD><CODE>checkEntries</CODE> - files, that are extracted from the deployment descriptor
|
---|
1175 | <DT><B>Throws:</B>
|
---|
1176 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
|
---|
1177 | </DD>
|
---|
1178 | </DL>
|
---|
1179 | <HR>
|
---|
1180 |
|
---|
1181 | <A NAME="getClassLoaderForBuild()"><!-- --></A><H3>
|
---|
1182 | getClassLoaderForBuild</H3>
|
---|
1183 | <PRE>
|
---|
1184 | protected java.lang.ClassLoader <B>getClassLoaderForBuild</B>()</PRE>
|
---|
1185 | <DL>
|
---|
1186 | <DD>Returns a Classloader object which parses the passed in generic EjbJar classpath.
|
---|
1187 | The loader is used to dynamically load classes from javax.ejb.* and the classes
|
---|
1188 | being added to the jar.
|
---|
1189 | <P>
|
---|
1190 | <DD><DL>
|
---|
1191 | </DL>
|
---|
1192 | </DD>
|
---|
1193 | <DD><DL>
|
---|
1194 | </DL>
|
---|
1195 | </DD>
|
---|
1196 | </DL>
|
---|
1197 | <HR>
|
---|
1198 |
|
---|
1199 | <A NAME="validateConfigured()"><!-- --></A><H3>
|
---|
1200 | validateConfigured</H3>
|
---|
1201 | <PRE>
|
---|
1202 | public void <B>validateConfigured</B>()
|
---|
1203 | throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
|
---|
1204 | <DL>
|
---|
1205 | <DD>Called to validate that the tool parameters have been configured.
|
---|
1206 | <P>
|
---|
1207 | <DD><DL>
|
---|
1208 | <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EJBDeploymentTool.html#validateConfigured()">validateConfigured</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></DL>
|
---|
1209 | </DD>
|
---|
1210 | <DD><DL>
|
---|
1211 |
|
---|
1212 | <DT><B>Throws:</B>
|
---|
1213 | <DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - If the Deployment Tool's configuration isn't
|
---|
1214 | valid</DL>
|
---|
1215 | </DD>
|
---|
1216 | </DL>
|
---|
1217 | <!-- ========= END OF CLASS DATA ========= -->
|
---|
1218 | <HR>
|
---|
1219 |
|
---|
1220 |
|
---|
1221 | <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
---|
1222 | <A NAME="navbar_bottom"><!-- --></A>
|
---|
1223 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
---|
1224 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
---|
1225 | <TR>
|
---|
1226 | <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
---|
1227 | <A NAME="navbar_bottom_firstrow"><!-- --></A>
|
---|
1228 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
---|
1229 | <TR ALIGN="center" VALIGN="top">
|
---|
1230 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
---|
1231 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
---|
1232 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
---|
1233 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
---|
1234 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
---|
1235 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
---|
1236 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
---|
1237 | </TR>
|
---|
1238 | </TABLE>
|
---|
1239 | </TD>
|
---|
1240 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
---|
1241 | </EM>
|
---|
1242 | </TD>
|
---|
1243 | </TR>
|
---|
1244 |
|
---|
1245 | <TR>
|
---|
1246 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1247 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/EjbJar.NamingScheme.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>PREV CLASS</B></A>
|
---|
1248 | <A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/ejb/InnerClassFilenameFilter.html" title="class in org.apache.tools.ant.taskdefs.optional.ejb"><B>NEXT CLASS</B></A></FONT></TD>
|
---|
1249 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
---|
1250 | <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
---|
1251 | <A HREF="GenericDeploymentTool.html" target="_top"><B>NO FRAMES</B></A>
|
---|
1252 | <SCRIPT type="text/javascript">
|
---|
1253 | <!--
|
---|
1254 | if(window==top) {
|
---|
1255 | document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
---|
1256 | }
|
---|
1257 | //-->
|
---|
1258 | </SCRIPT>
|
---|
1259 | <NOSCRIPT>
|
---|
1260 | <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
---|
1261 | </NOSCRIPT>
|
---|
1262 |
|
---|
1263 | </FONT></TD>
|
---|
1264 | </TR>
|
---|
1265 | <TR>
|
---|
1266 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1267 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
---|
1268 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
---|
1269 | DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
---|
1270 | </TR>
|
---|
1271 | </TABLE>
|
---|
1272 | <A NAME="skip-navbar_bottom"></A>
|
---|
1273 | <!-- ======== END OF BOTTOM NAVBAR ======= -->
|
---|
1274 |
|
---|
1275 | <HR>
|
---|
1276 | Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
|
---|
1277 | </BODY>
|
---|
1278 | </HTML>
|
---|