Apache Ant 1.10.14 · org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbcTask

Compiles EJB stubs and skeletons for the iPlanet Application Server. The EJBs to be processed are specified by the EJB 1.1 standard XML descriptor, and additional attributes are obtained from the iPlanet Application Server-specific XML descriptor. Since the XML descriptors can include multiple EJBs, this is a convenient way of specifying many EJBs in a single Ant task. The following attributes are allowed:

ejbdescriptor -- Standard EJB 1.1 XML descriptor (typically titled "ejb-jar.xml"). This attribute is required.
iasdescriptor -- EJB XML descriptor for iPlanet Application Server (typically titled "ias-ejb-jar.xml). This attribute is required.
dest -- The is the base directory where the RMI stubs and skeletons are written. In addition, the class files for each bean (home interface, remote interface, and EJB implementation) must be found in this directory. This attribute is required.
classpath -- The classpath used when generating EJB stubs and skeletons. This is an optional attribute (if omitted, the classpath specified when Ant was started will be used). 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.

For each EJB specified, this task will locate the three classes that comprise the EJB. If these class files cannot be located in the dest 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 to generate new stubs and skeletons.

Field Summary

Modifier and Type	Field and Description
private Path	classpath
private boolean	debug
private File	dest
private File	ejbdescriptor
private File	iasdescriptor
private File	iashome
private boolean	keepgenerated

Inherited from org.apache.tools.ant.Task:: target taskName taskType wrapper

Constructor Summary

Access	Constructor and Description
public	IPlanetEjbcTask()

Method Summary

Modifier and Type	Method and Description
private void	checkConfiguration() Verifies that the user selections are valid.
public Path	Returns: the class path. createClasspath() Adds to the classpath used when compiling the EJB stubs and skeletons.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Does the work.
private void	executeEjbc(SAXParser SAXParser that may be used to process the EJB descriptors saxParser) Executes the EJBc utility using the SAXParser provided.
private Path	Returns: Path The classpath to be used for EJBc. getClasspath() Returns the CLASSPATH to be used when calling EJBc.
private SAXParser	Returns: Parser which may be used to process the EJB descriptors. getParser() Returns a SAXParser that may be used to process the XML descriptors.
public void	setClasspath(Path The classpath to be used. classpath) Sets the classpath to be used when compiling the EJB stubs and skeletons.
public void	setDebug(boolean A boolean indicating if debugging output should be generated debug) If true, debugging output will be generated when ejbc is executed.
public void	setDest(File The directory where the compiled classes will be written. dest) Sets the destination directory where the EJB source classes must exist and where the stubs and skeletons will be written.
public void	setEjbdescriptor(File The name and location of the EJB descriptor. ejbdescriptor) Sets the location of the standard XML EJB descriptor.
public void	setIasdescriptor(File The name and location of the iAS-specific EJB descriptor. iasdescriptor) Sets the location of the iAS-specific XML EJB descriptor.
public void	setIashome(File The home directory for the user's iAS installation. iashome) May be used to specify the "home" directory for this iAS installation.
public void	setKeepgenerated(boolean A boolean indicating if the Java source files for the stubs and skeletons should be retained. keepgenerated) If true, the Java source files which are generated by ejbc will be saved .

Field Detail

classpath	back to summary
private Path classpath

debug	back to summary
private boolean debug

dest	back to summary
private File dest

ejbdescriptor	back to summary
private File ejbdescriptor

iasdescriptor	back to summary
private File iasdescriptor

iashome	back to summary
private File iashome

keepgenerated	back to summary
private boolean keepgenerated

Constructor Detail

IPlanetEjbcTask	back to summary
public IPlanetEjbcTask()

Method Detail

checkConfiguration	back to summary
private void checkConfiguration() throws BuildException Verifies that the user selections are valid. Exceptions BuildException: If the user selections are invalid.

checkConfiguration

back to summary

private void checkConfiguration() throws BuildException

Verifies that the user selections are valid.

Exceptions

BuildException:: If the user selections are invalid.

createClasspath	back to summary
public Path createClasspath() Adds to the classpath used when compiling the EJB stubs and skeletons. Returns:Path the class path.

createClasspath

back to summary

public Path createClasspath()

Adds to the classpath used when compiling the EJB stubs and skeletons.

Returns:Path: the class path.

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Does the work. Annotations @Override Exceptions BuildException: if there is a problem.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Does the work.

Annotations

@Override

Exceptions

BuildException:: if there is a problem.

executeEjbc	back to summary
private void executeEjbc(SAXParser saxParser) throws BuildException Executes the EJBc utility using the SAXParser provided. Parameters saxParser:SAXParser SAXParser that may be used to process the EJB descriptors Exceptions BuildException: If there is an error reading or parsing the XML descriptors

executeEjbc

back to summary

private void executeEjbc(SAXParser saxParser) throws BuildException

Executes the EJBc utility using the SAXParser provided.

Parameters

saxParser:SAXParser: SAXParser that may be used to process the EJB descriptors

Exceptions

BuildException:: If there is an error reading or parsing the XML descriptors

getClasspath	back to summary
private Path getClasspath() Returns the CLASSPATH to be used when calling EJBc. If no user CLASSPATH is specified, the System classpath is returned instead. Returns:Path Path The classpath to be used for EJBc.

getClasspath

back to summary

private Path getClasspath()

Returns the CLASSPATH to be used when calling EJBc. If no user CLASSPATH is specified, the System classpath is returned instead.

Returns:Path: Path The classpath to be used for EJBc.

getParser	back to summary
private SAXParser getParser() throws BuildException Returns a SAXParser that may be used to process the XML descriptors. Returns:SAXParser Parser which may be used to process the EJB descriptors. Exceptions BuildException: If the parser cannot be created or configured.

getParser

back to summary

private SAXParser getParser() throws BuildException

Returns a SAXParser that may be used to process the XML descriptors.

Returns:SAXParser

Parser which may be used to process the EJB descriptors.

Exceptions

BuildException:: If the parser cannot be created or configured.

setClasspath	back to summary
public void setClasspath(Path classpath) Sets the classpath to be used when compiling the EJB stubs and skeletons. Parameters classpath:Path The classpath to be used.

setClasspath

back to summary

public void setClasspath(Path classpath)

Sets the classpath to be used when compiling the EJB stubs and skeletons.

Parameters

classpath:Path: The classpath to be used.

setDebug	back to summary
public void setDebug(boolean debug) If true, debugging output will be generated when ejbc is executed. Parameters debug:boolean A boolean indicating if debugging output should be generated

setDebug

back to summary

public void setDebug(boolean debug)

If true, debugging output will be generated when ejbc is executed.

Parameters

debug:boolean: A boolean indicating if debugging output should be generated

setDest	back to summary
public void setDest(File dest) Sets the destination directory where the EJB source classes must exist and where the stubs and skeletons will be written. The destination directory must exist before this task is executed. Parameters dest:File The directory where the compiled classes will be written.

setDest

back to summary

public void setDest(File dest)

Sets the destination directory where the EJB source classes must exist and where the stubs and skeletons will be written. The destination directory must exist before this task is executed.

Parameters

dest:File: The directory where the compiled classes will be written.

setEjbdescriptor	back to summary
public void setEjbdescriptor(File ejbdescriptor) Sets the location of the standard XML EJB descriptor. Typically, this file is named "ejb-jar.xml". Parameters ejbdescriptor:File The name and location of the EJB descriptor.

setEjbdescriptor

back to summary

public void setEjbdescriptor(File ejbdescriptor)

Sets the location of the standard XML EJB descriptor. Typically, this file is named "ejb-jar.xml".

Parameters

ejbdescriptor:File: The name and location of the EJB descriptor.

setIasdescriptor	back to summary
public void setIasdescriptor(File iasdescriptor) Sets the location of the iAS-specific XML EJB descriptor. Typically, this file is named "ias-ejb-jar.xml". Parameters iasdescriptor:File The name and location of the iAS-specific EJB descriptor.

setIasdescriptor

back to summary

public void setIasdescriptor(File iasdescriptor)

Sets the location of the iAS-specific XML EJB descriptor. Typically, this file is named "ias-ejb-jar.xml".

Parameters

iasdescriptor:File: The name and location of the iAS-specific EJB descriptor.

setIashome back to summary

setIashome	back to summary
public void setIashome(File iashome) May be used to specify the "home" directory for this iAS installation. The directory specified should typically be `[install-location]/iplanet/ias6/ias`. Parameters iashome:File The home directory for the user's iAS installation.

public void setIashome(File iashome)

May be used to specify the "home" directory for this iAS installation. The directory specified should typically be [install-location]/iplanet/ias6/ias.

Parameters

iashome:File: The home directory for the user's iAS installation.

setKeepgenerated	back to summary
public void setKeepgenerated(boolean keepgenerated) If true, the Java source files which are generated by ejbc will be saved . Parameters keepgenerated:boolean A boolean indicating if the Java source files for the stubs and skeletons should be retained.

setKeepgenerated

back to summary

public void setKeepgenerated(boolean keepgenerated)

If true, the Java source files which are generated by ejbc will be saved .

Parameters

keepgenerated:boolean: A boolean indicating if the Java source files for the stubs and skeletons should be retained.

public Class IPlanetEjbcTask

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail