| java.lang.Object
 org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
org.apache.tools.ant.taskdefs.optional.ejb.IPlanetDeploymentTool
| IPlanetDeploymentTool | | public class IPlanetDeploymentTool extends GenericDeploymentTool (Code) | | This class is used to generate iPlanet Application Server (iAS) 6.0 stubs and
skeletons and build an EJB Jar file. It is designed to be used with the Ant
ejbjar task. If only stubs and skeletons need to be generated
(in other words, if no JAR file needs to be created), refer to the
iplanet-ejbc task and the IPlanetEjbcTask class.
The following attributes may be specified by the user:
- destdir -- The base directory into which the generated JAR
files will be written. Each JAR file is written
in directories which correspond to their location
within the "descriptordir" namespace. This is a
required attribute.
- classpath -- The classpath used when generating EJB stubs and
skeletons. This is an optional attribute (if
omitted, the classpath specified in the "ejbjar"
parent task will be used). If specified, the
classpath elements will be prepended to the
classpath specified in the parent "ejbjar" task.
Note that nested "classpath" elements may also be
used.
- keepgenerated -- Indicates whether or not the Java source
files which are generated by ejbc will be
saved or automatically deleted. If "yes",
the source files will be retained. This is
an optional attribute (if omitted, it
defaults to "no").
- debug -- Indicates whether or not the ejbc utility should
log additional debugging statements to the standard
output. If "yes", the additional debugging statements
will be generated (if omitted, it defaults to "no").
- iashome -- May be used to specify the "home" directory for
this iPlanet Application server installation. This
is used to find the ejbc utility if it isn't
included in the user's system path. This is an
optional attribute (if specified, it should refer
to the
[install-location]/iplanet/ias6/ias
directory). If omitted, the ejbc utility
must be on the user's system path.
- suffix -- String value appended to the JAR filename when
creating each JAR. This attribute is not required
(if omitted, it defaults to ".jar").
For each EJB descriptor found in the "ejbjar" parent task, this deployment
tool will locate the three classes that comprise the EJB. If these class
files cannot be located in the specified srcdir directory, the
task will fail. The task will also attempt to locate the EJB stubs and
skeletons in this directory. If found, the timestamps on the stubs and
skeletons will be checked to ensure they are up to date. Only if these files
cannot be found or if they are out of date will ejbc be called.
See Also: IPlanetEjbc |
| Method Summary | |
| protected void | addVendorFiles(Hashtable ejbFiles, String ddPrefix)
Add the iAS-specific EJB descriptor to the list of files which will be
written to the JAR file. | | protected void | checkConfiguration(String descriptorFileName, SAXParser saxParser)
Verifies that the user selections are valid. | | protected String | getPublicId()
The iAS ejbc utility doesn't require the Public ID of the descriptor's
DTD for it to process correctly--this method always returns null
. | | File | getVendorOutputJarFile(String baseName)
Get the name of the Jar that will be written. | | protected Hashtable | parseEjbFiles(String descriptorFileName, SAXParser saxParser)
This method returns a list of EJB files found when the specified EJB
descriptor is parsed and processed. | | public void | processDescriptor(String descriptorName, SAXParser saxParser)
. | | public void | setDebug(boolean debug)
Sets whether or not debugging output will be generated when ejbc is
executed. | | public void | setGenericJarSuffix(String inString)
Since iAS doesn't generate a "generic" JAR as part of its processing,
this attribute is ignored and a warning message is displayed to the user.
Parameters:
inString - the string to use as the suffix. | | public void | setIashome(File iashome)
Setter method used to store the "home" directory of the user's iAS
installation. | | public void | setKeepgenerated(boolean keepgenerated)
Setter method used to specify whether the Java source files generated by
the ejbc utility should be saved or automatically deleted. | | public void | setSuffix(String jarSuffix)
Setter method used to specify the filename suffix (for example, ".jar")
for the JAR files to be created. |
| addVendorFiles | | protected void addVendorFiles(Hashtable ejbFiles, String ddPrefix)(Code) | | Add the iAS-specific EJB descriptor to the list of files which will be
written to the JAR file.
Parameters:
ejbFiles - Hashtable of EJB class (and other) files to be added tothe completed JAR file.
Parameters:
ddPrefix - not used |
| checkConfiguration | | protected void checkConfiguration(String descriptorFileName, SAXParser saxParser) throws BuildException(Code) | | Verifies that the user selections are valid.
Parameters:
descriptorFileName - String representing the file name of an EJBdescriptor to be processed
Parameters:
saxParser - SAXParser which may be used to parse the XMLdescriptor
throws:
BuildException - If the user selections are invalid. |
| getPublicId | | protected String getPublicId()(Code) | | The iAS ejbc utility doesn't require the Public ID of the descriptor's
DTD for it to process correctly--this method always returns null
.
null. |
| getVendorOutputJarFile | | File getVendorOutputJarFile(String baseName)(Code) | | Get the name of the Jar that will be written. The modification date
of this jar will be checked against the dependent bean classes.
Parameters:
baseName - String name of the EJB JAR file to be written (withouta filename extension). File representing the JAR file which will be written. |
| parseEjbFiles | | protected Hashtable parseEjbFiles(String descriptorFileName, SAXParser saxParser) throws IOException, SAXException(Code) | | This method returns a list of EJB files found when the specified EJB
descriptor is parsed and processed.
Parameters:
descriptorFileName - String representing the file name of an EJBdescriptor to be processed
Parameters:
saxParser - SAXParser which may be used to parse the XMLdescriptor Hashtable of EJB class (and other) files to beadded to the completed JAR file
throws:
IOException - An IOException from the parser, possibly fromthe byte stream or character stream
throws:
SAXException - Any SAX exception, possibly wrapping anotherexception |
| setDebug | | public void setDebug(boolean debug)(Code) | | Sets whether or not debugging output will be generated when ejbc is
executed.
Parameters:
debug - A boolean indicating if debugging output should be generated |
| setGenericJarSuffix | | public void setGenericJarSuffix(String inString)(Code) | | Since iAS doesn't generate a "generic" JAR as part of its processing,
this attribute is ignored and a warning message is displayed to the user.
Parameters:
inString - the string to use as the suffix. This parameter isignored. |
| setIashome | | public void setIashome(File iashome)(Code) | | Setter method used to store the "home" directory of the user's iAS
installation. The directory specified should typically be
[install-location]/iplanet/ias6/ias.
Parameters:
iashome - The home directory for the user's iAS installation. |
| setKeepgenerated | | public void setKeepgenerated(boolean keepgenerated)(Code) | | Setter method used to specify whether the Java source files generated by
the ejbc utility should be saved or automatically deleted.
Parameters:
keepgenerated - boolean which, if true, indicates thatJava source files generated by ejbc for the stubsand skeletons should be kept. |
| setSuffix | | public void setSuffix(String jarSuffix)(Code) | | Setter method used to specify the filename suffix (for example, ".jar")
for the JAR files to be created.
Parameters:
jarSuffix - The string to use as the JAR filename suffix. |
| Methods inherited from org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool | protected void addFileToJar(JarOutputStream jStream, File inputFile, String logicalFilename) throws BuildException(Code)(Java Doc)
protected void addSupportClasses(Hashtable ejbFiles)(Code)(Java Doc)
protected void addVendorFiles(Hashtable ejbFiles, String ddPrefix)(Code)(Java Doc)
protected void checkAndAddDependants(Hashtable checkEntries) throws BuildException(Code)(Java Doc)
protected void checkConfiguration(String descriptorFileName, SAXParser saxParser) throws BuildException(Code)(Java Doc)
public void configure(EjbJar.Config config)(Code)(Java Doc)
public Path createClasspath()(Code)(Java Doc)
protected ClassLoader getClassLoaderForBuild()(Code)(Java Doc)
protected Path getCombinedClasspath()(Code)(Java Doc)
protected EjbJar.Config getConfig()(Code)(Java Doc)
protected DescriptorHandler getDescriptorHandler(File srcDir)(Code)(Java Doc)
protected File getDestDir()(Code)(Java Doc)
protected String getJarBaseName(String descriptorFileName)(Code)(Java Doc)
protected Location getLocation()(Code)(Java Doc)
protected File getManifestFile(String prefix)(Code)(Java Doc)
protected String getPublicId()(Code)(Java Doc)
protected Task getTask()(Code)(Java Doc)
public String getVendorDDPrefix(String baseName, String descriptorFileName)(Code)(Java Doc)
File getVendorOutputJarFile(String baseName)(Code)(Java Doc)
protected void log(String message, int level)(Code)(Java Doc)
protected boolean needToRebuild(Hashtable ejbFiles, File jarFile)(Code)(Java Doc)
protected Hashtable parseEjbFiles(String descriptorFileName, SAXParser saxParser) throws IOException, SAXException(Code)(Java Doc)
public void processDescriptor(String descriptorFileName, SAXParser saxParser)(Code)(Java Doc)
protected void registerKnownDTDs(DescriptorHandler handler)(Code)(Java Doc)
public void setClasspath(Path classpath)(Code)(Java Doc)
public void setDestdir(File inDir)(Code)(Java Doc)
public void setGenericJarSuffix(String inString)(Code)(Java Doc)
public void setTask(Task task)(Code)(Java Doc)
protected boolean usingBaseJarName()(Code)(Java Doc)
public void validateConfigured() throws BuildException(Code)(Java Doc)
protected void writeJar(String baseName, File jarfile, Hashtable files, String publicId) throws BuildException(Code)(Java Doc)
|
|
|