org.apache.tools.ant.taskdefs.optional.ejb

Class IPlanetEjbcTask


public class IPlanetEjbcTask
extends Task

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:

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.

See Also:
IPlanetEjbc

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

Path
createClasspath()
Adds to the classpath used when compiling the EJB stubs and skeletons.
void
execute()
Does the work.
void
setClasspath(Path classpath)
Sets the classpath to be used when compiling the EJB stubs and skeletons.
void
setDebug(boolean debug)
If true, debugging output will be generated when ejbc is executed.
void
setDest(File dest)
Sets the destination directory where the EJB source classes must exist and where the stubs and skeletons will be written.
void
setEjbdescriptor(File ejbdescriptor)
Sets the location of the standard XML EJB descriptor.
void
setIasdescriptor(File iasdescriptor)
Sets the location of the iAS-specific XML EJB descriptor.
void
setIashome(File iashome)
May be used to specify the "home" directory for this iAS installation.
void
setKeepgenerated(boolean keepgenerated)
If true, the Java source files which are generated by ejbc will be saved .

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Method Details

createClasspath

public Path createClasspath()
Adds to the classpath used when compiling the EJB stubs and skeletons.

execute

public void execute()
            throws BuildException
Does the work.
Overrides:
execute in interface Task

setClasspath

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

setDebug

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

setDest

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 - The directory where the compiled classes will be written.

setEjbdescriptor

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

setIasdescriptor

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 - The name and location of the iAS-specific EJB descriptor.

setIashome

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 - The home directory for the user's iAS installation.

setKeepgenerated

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

Copyright B) 2000-2006 Apache Software Foundation. All Rights Reserved.