| java.lang.Object
 org.apache.tools.ant.taskdefs.optional.ejb.IPlanetEjbc
| IPlanetEjbc | | public class IPlanetEjbc (Code) | | Compiles EJB stubs and skeletons for the iPlanet Application
Server (iAS). The class will read a standard EJB descriptor (as well as an
EJB descriptor specific to iPlanet Application Server) to identify one or
more EJBs to process. It will search for EJB "source" classes (the remote
; * interface, home interface, and EJB implementation class) and the EJB stubs
and skeletons in the specified destination directory. Only if the stubs and
skeletons cannot be found or if they're out of date will the iPlanet
Application Server ejbc utility be run.
Because this class (and it's assorted inner classes) may be bundled into the
iPlanet Application Server distribution at some point (and removed from the
Ant distribution), the class has been written to be independent of all
Ant-specific classes. It is also for this reason (and to avoid cluttering
the Apache Ant source files) that this utility has been packaged into a
single source file.
For more information on Ant Tasks for iPlanet Application Server, see the
IPlanetDeploymentTool and IPlanetEjbcTask classes.
See Also: IPlanetDeploymentTool
See Also: IPlanetEjbcTask |
| Inner Class :public class EjbcException extends Exception | |
| Constructor Summary | |
| public | IPlanetEjbc(File stdDescriptor, File iasDescriptor, File destDirectory, String classpath, SAXParser parser)
Constructs an instance which may be used to process EJB descriptors and
generate EJB stubs and skeletons, if needed. |
| Method Summary | |
| protected void | checkConfiguration()
Verifies that the user selections are valid. | | public void | execute()
Compiles the stub and skeletons for the specified EJBs, if they need to
be updated. | | public String[] | getCmpDescriptors()
Returns the list of CMP descriptors referenced in the EJB descriptors. | | public String | getDisplayName()
Returns the display-name element read from the standard EJB descriptor. | | public Hashtable | getEjbFiles()
Returns a Hashtable which contains a list of EJB class files processed by
the ejbc utility (both "source" class files as well as stubs and
skeletons). | | public static void | main(String[] args)
Main application method for the iPlanet Application Server ejbc utility. | | public void | registerDTD(String publicID, String location)
Registers the location of a local DTD file or resource. | | public void | setDebugOutput(boolean debugOutput)
If true, enables debugging output when ejbc is executed. | | public void | setIasHomeDir(File iasHomeDir)
May be used to specify the "home" directory for this iAS installation. | | public void | setRetainSource(boolean retainSource)
If true, the Java source files which are generated by the
ejbc process are retained. |
| IPlanetEjbc | | public IPlanetEjbc(File stdDescriptor, File iasDescriptor, File destDirectory, String classpath, SAXParser parser)(Code) | | Constructs an instance which may be used to process EJB descriptors and
generate EJB stubs and skeletons, if needed.
Parameters:
stdDescriptor - File referencing a standard EJB descriptor.
Parameters:
iasDescriptor - File referencing an iAS-specific EJB descriptor.
Parameters:
destDirectory - File referencing the base directory where bothEJB "source" files are found and where stubs andskeletons will be written.
Parameters:
classpath - String representation of the classpath to be usedby the iAS ejbc utility.
Parameters:
parser - SAXParser to be used to process both of the EJBdescriptors. |
| checkConfiguration | | protected void checkConfiguration() throws EjbcException(Code) | | Verifies that the user selections are valid.
throws:
EjbcException - If the user selections are invalid. |
| execute | | public void execute() throws EjbcException, IOException, SAXException(Code) | | Compiles the stub and skeletons for the specified EJBs, if they need to
be updated.
throws:
EjbcException - If the ejbc utility cannot be correctly configuredor if one or more of the EJB "source" classescannot be found in the destination directory
throws:
IOException - If the parser encounters a problem reading the XMLfile
throws:
SAXException - If the parser encounters a problem processing theXML descriptor (it may wrap another exception) |
| getCmpDescriptors | | public String[] getCmpDescriptors()(Code) | | Returns the list of CMP descriptors referenced in the EJB descriptors.
An array of CMP descriptors. |
| getDisplayName | | public String getDisplayName()(Code) | | Returns the display-name element read from the standard EJB descriptor.
The EJB-JAR display name. |
| getEjbFiles | | public Hashtable getEjbFiles()(Code) | | Returns a Hashtable which contains a list of EJB class files processed by
the ejbc utility (both "source" class files as well as stubs and
skeletons). The key for the Hashtable is a String representing the path
to the class file (relative to the destination directory). The value for
the Hashtable is a File object which reference the actual class file.
The list of EJB files processed by the ejbc utility. |
| main | | public static void main(String[] args)(Code) | | Main application method for the iPlanet Application Server ejbc utility.
If the application is run with no commandline arguments, a usage
statement is printed for the user.
Parameters:
args - The commandline arguments passed to the application. |
| registerDTD | | public void registerDTD(String publicID, String location)(Code) | | Registers the location of a local DTD file or resource. By registering
a local DTD, EJB descriptors can be parsed even when the remote servers
which contain the "public" DTDs cannot be accessed.
Parameters:
publicID - The public DTD identifier found in an XML document.
Parameters:
location - The file or resource name for the appropriate DTD storedon the local machine. |
| setDebugOutput | | public void setDebugOutput(boolean debugOutput)(Code) | | If true, enables debugging output when ejbc is executed.
Parameters:
debugOutput - A boolean indicating if debugging output should begenerated |
| setIasHomeDir | | public void setIasHomeDir(File iasHomeDir)(Code) | | May be used to specify the "home" directory for this iAS installation.
The directory specified should typically be
[install-location]/iplanet/ias6/ias.
Parameters:
iasHomeDir - The home directory for the user's iAS installation. |
| setRetainSource | | public void setRetainSource(boolean retainSource)(Code) | | If true, the Java source files which are generated by the
ejbc process are retained.
Parameters:
retainSource - A boolean indicating if the Java source files forthe stubs and skeletons should be retained. |
|
|