Main Page | Packages | Class Hierarchy | Class List | File List | Class Members | Related Pages | Search for 

org.objectweb.jonas.ant.JonasDeploymentTool Class Reference

Inherits org.objectweb.jonas.ant.GenericDeploymentTool.

Inheritance diagram for org.objectweb.jonas.ant.JonasDeploymentTool:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.jonas.ant.JonasDeploymentTool:

Collaboration graph
[legend]
List of all members.

Public Member Functions

void setKeepgenerated (boolean aBoolean)
void setMappernames (String aString)
void setProtocols (String aString)
void setClasspathref (Reference r)
void setAdditionalargs (String aString)
void setNocompil (boolean aBoolean)
void setInvokecmd (boolean aBoolean)
void setNovalidation (boolean aBoolean)
void setJavac (String aString)
void setJavacopts (String aString)
void setRmicopts (String aString)
void setVerbose (boolean aBoolean)
void setJonasroot (File aFile)
void setJonasbase (File aFile)
void setKeepgeneric (boolean aBoolean)
void setJarsuffix (String aString)
void setNogenic (boolean aBoolean)
void setJvmopts (String aString)

Protected Member Functions

void writeJar (String baseName, File jarfile, Hashtable ejbFiles, String publicId, boolean includeInnerClasses) throws BuildException
void addVendorFiles (Hashtable ejbFiles, String ddPrefix)
File getVendorOutputJarFile (String baseName)
String getJarBaseName (String descriptorFileName)
void registerKnownDTDs (DescriptorHandler handler)
void checkConfiguration (String descriptorFileName, SAXParser saxParser) throws BuildException

Static Protected Attributes

final String EJB_JAR_1_1_PUBLIC_ID = "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN"
final String JONAS_EJB_JAR_2_4_PUBLIC_ID = "-//ObjectWeb//DTD JOnAS 2.4//EN"
final String EJB_JAR_1_1_DTD = "ejb-jar_1_1.dtd"
final String JONAS_EJB_JAR_2_4_DTD = "jonas-ejb-jar_2_4.dtd"
final String JONAS_DD = "jonas-ejb-jar.xml"
final String BOOTSTRAP_CLASS = "org.objectweb.jonas.server.Bootstrap"
final String GENIC_CLASS = "org.objectweb.jonas_ejb.genic.GenIC"

Detailed Description

The deployment tool to add the jonas specific deployment descriptors to the ejb JAR file. JONAS only requires one additional file jonas-ejb-jar.xml.
Author:
Cyrille Morvan , Ingenosya France , Contributor(s): Mathieu Peltier Adriana Danes: change configuration directory name from "config" to "conf"
Version:
1.0
See also:
EjbJar.createJonas

Definition at line 80 of file JonasDeploymentTool.java.

Member Function Documentation

void org.objectweb.jonas.ant.JonasDeploymentTool.addVendorFiles (  Hashtable  ejbFiles,
String  ddPrefix
)  [protected]
 

Add any vendor specific files which should be included in the EJB Jar.

Reimplemented from org.objectweb.jonas.ant.GenericDeploymentTool.

Definition at line 416 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.GenericDeploymentTool.getConfig(), org.objectweb.jonas.ant.JonasDeploymentTool.JONAS_DD, and org.objectweb.jonas.ant.GenericDeploymentTool.log().

Here is the call graph for this function:

void org.objectweb.jonas.ant.JonasDeploymentTool.checkConfiguration (  String  descriptorFileName,
SAXParser  saxParser
)  throws BuildException [protected]
 

This method is called as the first step in the processDescriptor method to allow vendor-specific subclasses to validate the task configuration prior to processing the descriptor. If the configuration is invalid, a BuildException should be thrown.

Parameters:
descriptorFileName String representing the file name of an EJB descriptor to be processed
saxParser SAXParser which may be used to parse the XML descriptor
Exceptions:
BuildException Thrown if the configuration is invalid

Reimplemented from org.objectweb.jonas.ant.GenericDeploymentTool.

Definition at line 753 of file JonasDeploymentTool.java.

String org.objectweb.jonas.ant.JonasDeploymentTool.getJarBaseName (  String  descriptorFileName  )  [protected]
 

Using the EJB descriptor file name passed from the ejbjar task, this method returns the "basename" which will be used to name the completed JAR file.

Parameters:
descriptorFileName String representing the file name of an EJB descriptor to be processed
Returns:
The "basename" which will be used to name the completed JAR file

Reimplemented from org.objectweb.jonas.ant.GenericDeploymentTool.

Definition at line 506 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.GenericDeploymentTool.getConfig(), and org.objectweb.jonas.ant.GenericDeploymentTool.log().

Here is the call graph for this function:

File org.objectweb.jonas.ant.JonasDeploymentTool.getVendorOutputJarFile (  String  baseName  )  [protected]
 

Get the vendor specific name of the Jar that will be output. The modification date of this jar will be checked against the dependent bean classes.

Reimplemented from org.objectweb.jonas.ant.GenericDeploymentTool.

Definition at line 430 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.GenericDeploymentTool.getDestDir().

Referenced by org.objectweb.jonas.ant.JonasDeploymentTool.writeJar().

Here is the call graph for this function:

void org.objectweb.jonas.ant.JonasDeploymentTool.registerKnownDTDs (  DescriptorHandler  handler  )  [protected]
 

Register the locations of all known DTDs.

vendor-specific subclasses should override this method to define the vendor-specific locations of the EJB DTDs

Reimplemented from org.objectweb.jonas.ant.GenericDeploymentTool.

Definition at line 546 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.JonasDeploymentTool.EJB_JAR_1_1_DTD, org.objectweb.jonas.ant.JonasDeploymentTool.EJB_JAR_1_1_PUBLIC_ID, org.objectweb.jonas.ant.JonasDeploymentTool.JONAS_EJB_JAR_2_4_DTD, org.objectweb.jonas.ant.JonasDeploymentTool.JONAS_EJB_JAR_2_4_PUBLIC_ID, and org.objectweb.jonas.ant.DescriptorHandler.registerDTD().

Here is the call graph for this function:

void org.objectweb.jonas.ant.JonasDeploymentTool.setAdditionalargs (  String  aString  ) 
 

Set the additionalargs.

Parameters:
aString additional args.

Definition at line 259 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setClasspathref (  Reference  r  ) 
 

Set the classpath as a Reference on another path

Parameters:
r Referenced Classpath

Definition at line 252 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.GenericDeploymentTool.createClasspath().

Here is the call graph for this function:

void org.objectweb.jonas.ant.JonasDeploymentTool.setInvokecmd (  boolean  aBoolean  ) 
 

Set the invokecmdflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 275 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setJarsuffix (  String  aString  ) 
 

Set the jarsuffix.

Parameters:
aString the string to use as the suffix.

Definition at line 351 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setJavac (  String  aString  ) 
 

Set the java compiler javacto use.

Parameters:
aString the java compiler.

Definition at line 291 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setJavacopts (  String  aString  ) 
 

Set the options to pass to the java compiler.

Parameters:
aString the options.

Definition at line 299 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setJonasbase (  File  aFile  ) 
 

Set the JOnAS base directory.

Parameters:
aFile the JOnAS base directory.

Definition at line 335 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setJonasroot (  File  aFile  ) 
 

Set the JOnAS root directory.

Parameters:
aFile the JOnAS root directory.

Definition at line 327 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setJvmopts (  String  aString  ) 
 

Set the additional args to pass to the GenIC JVM.

Parameters:
aString the options.

Definition at line 367 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setKeepgenerated (  boolean  aBoolean  ) 
 

Set the keepgeneratedflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 228 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setKeepgeneric (  boolean  aBoolean  ) 
 

Set the keepgenericflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 343 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setMappernames (  String  aString  ) 
 

Do nothing because the mappernames attribute is deprecated

Parameters:
aString list of mapper names separed by ,

Definition at line 236 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.GenericDeploymentTool.log().

Here is the call graph for this function:

void org.objectweb.jonas.ant.JonasDeploymentTool.setNocompil (  boolean  aBoolean  ) 
 

Set the nocompilflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 267 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setNogenic (  boolean  aBoolean  ) 
 

Set the nogenicflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 359 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setNovalidation (  boolean  aBoolean  ) 
 

Set the novalidationflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 283 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setProtocols (  String  aString  ) 
 

Set the protocols list

Parameters:
aString list of the protocol names separed by ,

Definition at line 244 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setRmicopts (  String  aString  ) 
 

Set the options to pass to the rmi compiler.

Parameters:
aString the options.

Definition at line 307 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.setVerbose (  boolean  aBoolean  ) 
 

Set the verboseflag.

Parameters:
aBoolean true if the flag must be set.

Definition at line 315 of file JonasDeploymentTool.java.

void org.objectweb.jonas.ant.JonasDeploymentTool.writeJar (  String  baseName,
File  jarfile,
Hashtable  ejbFiles,
String  publicId,
boolean  includeInnerClasses
)  throws BuildException [protected]
 

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.

Parameters:
includeInnerClasses if true, include inner classes

Reimplemented from org.objectweb.jonas.ant.GenericDeploymentTool.

Definition at line 391 of file JonasDeploymentTool.java.

References org.objectweb.jonas.ant.JonasDeploymentTool.getVendorOutputJarFile(), and org.objectweb.jonas.ant.GenericDeploymentTool.log().

Here is the call graph for this function:

Member Data Documentation

final String org.objectweb.jonas.ant.JonasDeploymentTool.BOOTSTRAP_CLASS = "org.objectweb.jonas.server.Bootstrap" [static, protected]
 

Bootstrap class name.

Definition at line 116 of file JonasDeploymentTool.java.

final String org.objectweb.jonas.ant.JonasDeploymentTool.EJB_JAR_1_1_DTD = "ejb-jar_1_1.dtd" [static, protected]
 

Name of the standard deployment descriptor DTD (these files are stored in the ${JONAS_ROOT}/xml directory).

Definition at line 98 of file JonasDeploymentTool.java.

Referenced by org.objectweb.jonas.ant.JonasDeploymentTool.registerKnownDTDs().

final String org.objectweb.jonas.ant.JonasDeploymentTool.EJB_JAR_1_1_PUBLIC_ID = "-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 1.1//EN" [static, protected]
 

Public Id of the standard deployment descriptor DTD.

Definition at line 83 of file JonasDeploymentTool.java.

Referenced by org.objectweb.jonas.ant.JonasDeploymentTool.registerKnownDTDs().

final String org.objectweb.jonas.ant.JonasDeploymentTool.GENIC_CLASS = "org.objectweb.jonas_ejb.genic.GenIC" [static, protected]
 

GenIC class name (JOnAS 2.6).

Definition at line 119 of file JonasDeploymentTool.java.

final String org.objectweb.jonas.ant.JonasDeploymentTool.JONAS_DD = "jonas-ejb-jar.xml" [static, protected]
 

Default JOnAS deployment descriptor name.

Definition at line 113 of file JonasDeploymentTool.java.

Referenced by org.objectweb.jonas.ant.JonasDeploymentTool.addVendorFiles().

final String org.objectweb.jonas.ant.JonasDeploymentTool.JONAS_EJB_JAR_2_4_DTD = "jonas-ejb-jar_2_4.dtd" [static, protected]
 

Name of the JOnAS-specific deployment descriptor DTD (these files are stored in the ${JONAS_ROOT}/xml directory).

Definition at line 105 of file JonasDeploymentTool.java.

Referenced by org.objectweb.jonas.ant.JonasDeploymentTool.registerKnownDTDs().

final String org.objectweb.jonas.ant.JonasDeploymentTool.JONAS_EJB_JAR_2_4_PUBLIC_ID = "-//ObjectWeb//DTD JOnAS 2.4//EN" [static, protected]
 

Public Id of the JOnAS-specific deployment descriptor DTD.

Definition at line 87 of file JonasDeploymentTool.java.

Referenced by org.objectweb.jonas.ant.JonasDeploymentTool.registerKnownDTDs().

The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:06:15 2005 for JOnAS by  doxygen 1.3.9.1