Title: BorlandCMPDeploymentTool.java
*Description: Ant task to generate _PM classes for Borland Enterprise Server
* * BorlandCMPDeploymentTool extends the BorlandDeploymentTool task and adds support for * the following additional attribute (required): * *
*
* <ejbjar srcdir="${build.classes}"
* basejarname="vsmp"
* descriptordir="${rsc.dir}/hrmanager">
* <borlandcmp destdir="tstlib" cmpdir="tmpdir">
* <classpath refid="classpath" />
* </borlandcmp>
* <include name="**\ejb-jar.xml"/>
* <support dir="${build.classes}">
* <include name="demo\smp\*.class"/>
* <include name="demo\helper\*.class"/>
* </support>
* </ejbjar>
*
*
* The generated classes will be added to the ejb jar.
*
* @author David LeRoy
*
*/
public class BorlandCMPDeploymentTool extends BorlandDeploymentTool
implements ExecuteStreamHandler
{
/** Vbj executable **/
protected static final String VBJ = "vbj";
// EntityBeanCodeGen class
protected static final String EBCG = "com.borland.ejb.pm.EntityBeanCodeGen";
// _PM classes generated by this tool
private Hashtable cmpClasses = new Hashtable();
// ArrayList of Object[2]: { beanClass, homeInterface }
private static ArrayList cmpTargets = new ArrayList();
/** Instance variable that stores the directory where generated files are placed*/
private File cmpDir = null;
/**
* set the directory where generated _PM CMP files should go: required
* @param cmpDir the destination directory.
*/
public void setCmpdir(File cmpDir)
{
this.cmpDir = cmpDir;
}
/**
* Called to validate that the tool parameters have been configured.
*
* @throws org.apache.tools.ant.BuildException If the Deployment Tool's configuration isn't
* valid
*/
public void validateConfigured() throws BuildException
{
super.validateConfigured();
if ((cmpDir == null) || (!cmpDir.isDirectory())) {
String msg = "A valid directory for generated files must be specified "
+ "using the \"gendir\" attribute.";
throw new BuildException(msg, getLocation());
}
}
public void processDescriptor(String descriptorFileName, SAXParser saxParser)
{
checkConfiguration(descriptorFileName, saxParser);
try {
DescriptorHandler handler = new CMPDescriptorHandler(getTask(), getConfig().srcDir);
for (Iterator i = getConfig().dtdLocations.iterator(); i.hasNext();) {
EjbJar.DTDLocation dtdLocation = (EjbJar.DTDLocation) i.next();
handler.registerDTD(dtdLocation.getPublicId(), dtdLocation.getLocation());
}
FileInputStream descriptorStream = null;
try {
File descriptor = new File(getConfig().descriptorDir, descriptorFileName);
descriptorStream = new FileInputStream(descriptor);
InputSource inputSource = new InputSource(descriptorStream);
cmpTargets.clear(); // will be populated during parsing
saxParser.parse(inputSource, handler);
}
finally {
if (descriptorStream != null) {
try {
descriptorStream.close();
}
catch (IOException closeException) {
// ignore
}
}
}
}
catch (SAXException se) {
String msg = "SAXException while parsing '"
+ descriptorFileName.toString()
+ "'. This probably indicates badly-formed XML."
+ " Details: "
+ se.getMessage();
throw new BuildException(msg, se);
}
catch (IOException ioe) {
String msg = "IOException while parsing'"
+ descriptorFileName.toString()
+ "'. This probably indicates that the descriptor"
+ " doesn't exist. Details: "
+ ioe.getMessage();
throw new BuildException(msg, ioe);
}
super.processDescriptor(descriptorFileName, saxParser);
}
/**
* Method used to encapsulate the writing of the JAR file. Iterates over the
* filenames/java.io.Files in the Hashtable stored on the instance variable
* ejbFiles.
*/
protected void writeJar(String baseName, File jarFile, Hashtable files, String publicId)
throws BuildException
{
// destination directory
String destPath = cmpDir.getAbsolutePath() + File.separator + baseName;
generateCMPClasses(destPath);
//add the generated files to the collection
files.putAll(cmpClasses);
super.writeJar(baseName, jarFile, files, publicId);
}
/**
* convert a file name : A/B/C/toto.java
* into a class name: A/B/C/toto.class
*/
private String toClassFile(String filename)
{
//remove the .class
String classfile = filename.substring(0, filename.lastIndexOf(".java"));
classfile = classfile + ".class";
return classfile;
}
private void generateCMPClasses(String destPath)
{
Iterator iterator = cmpTargets.iterator();
while (iterator.hasNext()) {
Object[] targets = (Object[]) iterator.next();
Execute execTask = new Execute(this);
Project project = getTask().getProject();
execTask.setAntRun(project);
execTask.setWorkingDirectory(project.getBaseDir());
Commandline commandline = new Commandline();
commandline.setExecutable(VBJ);
//set the classpath
commandline.createArgument().setValue("-VBJclasspath");
commandline.createArgument().setPath(getCombinedClasspath());
// com.borland.ejb.pm.EntityBeanCodeGen
commandline.createArgument().setValue(EBCG);
// destination directory
commandline.createArgument().setValue(destPath);
// Bean class
commandline.createArgument().setValue(targets[0].toString());
// Home class
commandline.createArgument().setValue(targets[1].toString());
try {
log("Calling vbj", Project.MSG_VERBOSE);
log(commandline.describeCommand(), Project.MSG_VERBOSE);
execTask.setCommandline(commandline.getCommandline());
int result = execTask.execute();
if (Execute.isFailure(result)) {
String msg = "Failed executing vbj (ret code is "
+ result + ")";
throw new BuildException(msg, getTask().getLocation());
}
}
catch (java.io.IOException e) {
log("vbj exception :" + e.getMessage(), Project.MSG_ERR);
throw new BuildException(e, getTask().getLocation());
}
}
Path path = new Path(getTask().getProject(), destPath);
File dir = new File(destPath);
dir.mkdir();
Javac javac = null;
javac = (Javac) getTask().getProject().createTask("javac");
javac.setClasspath(getCombinedClasspath());
javac.setDestdir(dir);
javac.setSrcdir(path);
javac.execute();
File[] files = javac.getFileList();
cmpClasses.clear();
for (int i = 0; i < files.length; i++) {
String classFile = toClassFile(files[i].getAbsolutePath());
String key = classFile.substring(destPath.length() + 1);
log("compiled " + classFile, Project.MSG_VERBOSE);
log("added class file under key: " + key, Project.MSG_VERBOSE);
cmpClasses.put(key, new File(classFile));
}
}
/**
* Inner class to re-parse ejb-jar.xml, looking for all CMP 2.x entity beans.
* This handler will add an element to the cmpTargets ArrayList consisting
* of the the bean class name and the home interface name for each CMP 2.x
* entity bean that is found in the deployment descriptor.
*/
private class CMPDescriptorHandler extends DescriptorHandler
{
private int parseState = SCANNING; // state of parser
private boolean inEJBRef = false; // inside ejb-ref or ejb-local-ref?
private boolean isCMP = false;
private static final int SCANNING = 0; // outside