Utility method that encapsulates the logic of adding a file entry to a .jar file.

  Utility method that encapsulates the logic of adding a file entry to
a .jar file. Used by execute() to add entries to the jar file as it is
constructed.
Parameters:
- jStream - A JarOutputStream into which to write the jar entry.
- inputFile - A File from which to read the contents the file being added.
- logicalFilename - A String representing the name, including all relevant path information, that should be stored for the entry being added.
Throws:
- BuildException - if there is a problem.

  Adds any classes the user specifies using support nested elements to the ejbFiles Hashtable.

  Adds any classes the user specifies using support nested elements
to the ejbFiles Hashtable.
Parameters:
- ejbFiles - Hashtable of EJB classes (and other) files that will be added to the completed JAR file

  Add all available classes, that depend on Remote, Home, Bean, PK

  Add all available classes, that depend on Remote, Home, Bean, PK
Parameters:
- checkEntries - files, that are extracted from the deployment descriptor
Throws:
- BuildException - if there is a problem.

  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.

  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
Throws:
- BuildException - if there is a problem.

  Configure this tool for use in the ejbjar task.

  Configure this tool for use in the ejbjar task.
Parameters:
- config - the configuration from the surrounding ejbjar task.

  Add the classpath for the user classes

  Add the classpath for the user classes
Returns: a Path instance to be configured by Ant.

  Returns a Classloader object which parses the passed in generic EjbJar classpath.

  Returns a Classloader object which parses the passed in generic EjbJar classpath.
The loader is used to dynamically load classes from javax.ejb.* and the classes
being added to the jar.
Returns: a classloader.

  Get the classpath by combining the one from the surrounding task, if any and the one from this tool.

  Get the classpath by combining the one from the surrounding task, if any
and the one from this tool.
Returns: the combined classpath

  Get the basename terminator.

  Get the basename terminator.
Returns: an ejbjar task configuration

  Get a descriptionHandler.

  Get a descriptionHandler.
Returns: a handler.
Parameters:
- srcDir - the source directory.

  Get the destination directory.

  Get the destination directory.
Returns: the destination directory into which EJB jars are to be written

  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.

  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.
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

  Get the build file location associated with this element's task.

  Get the build file location associated with this element's task.
Returns: the task's location instance.

  Get the manifets file to use for building the generic jar.

  Get the manifets file to use for building the generic jar.

If the file does not exist the global manifest from the config is used
otherwise the default Ant manifest will be used.
Returns: the manifest file or null if the manifest file does not exist
Parameters:
- prefix - the prefix where to llook for the manifest file based on the naming convention.

  Returns the Public ID of the DTD specified in the EJB descriptor.

  Returns the Public ID of the DTD specified in the EJB descriptor. Not
every vendor-specific DeploymentTool will need to reference
this value or may want to determine this value in a vendor-specific way.
Returns: Public ID of the DTD specified in the EJB descriptor.

  Get the task for this tool.

  Get the task for this tool.
Returns: the Task instance this tool is associated with.

  Get the prefix for vendor deployment descriptors.

  Get the prefix for vendor deployment descriptors.

This will contain the path and the start of the descriptor name,
depending on the naming scheme
Returns: the prefix.
Parameters:
- baseName - the base name to use.
- descriptorFileName - the file name to use.

  Log a message to the Ant output.

  Log a message to the Ant output.
Parameters:
- message - the message to be logged.
- level - the severity of this message.

  This method checks the timestamp on each file listed in the ejbFiles and compares them to the timestamp on the jarFile .

  This method checks the timestamp on each file listed in the
ejbFiles and compares them to the timestamp on the jarFile
. If the jarFile's timestamp is more recent than
each EJB file, true is returned. Otherwise, false
is returned.
TODO: find a way to check the manifest-file, that is found by naming convention
Returns: boolean indicating whether or not the jarFile is up to date
Parameters:
- ejbFiles - Hashtable of EJB classes (and other) files that will be added to the completed JAR file
- jarFile - JAR file which will contain all of the EJB classes (and other) files

  This method returns a list of EJB files found when the specified EJB descriptor is parsed and processed.

  This method returns a list of EJB files found when the specified EJB
descriptor is parsed and processed.
Returns: Hashtable of EJB class (and other) files to be added to the completed JAR file
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
Throws:
- org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception
- java.io.IOException - An IOException from the parser, possibly from a the byte stream or character stream

Process a deployment descriptor, generating the necessary vendor specific deployment files..

  Register the locations of all known DTDs.

  Register the locations of all known DTDs.

vendor-specific subclasses should override this method to define
the vendor-specific locations of the EJB DTDs
Parameters:
- handler - no used in this class.

  Set the classpath to be used for this compilation.

  Set the classpath to be used for this compilation.
Parameters:
- classpath - the classpath to be used for this build.

  Set the destination directory; required.

  Set the destination directory; required.
Parameters:
- inDir - the destination directory.

  Set the suffix for the generated jar file.

  Set the suffix for the generated jar file.
Parameters:
- inString - the string to use as the suffix.

  Set the task which owns this tool

  Set the task which owns this tool
Parameters:
- task - the Task to which this deployment tool is associated.

  Indicate if this build is using the base jar name.

  Indicate if this build is using the base jar name.
Returns: true if the name of the generated jar is coming from the basejarname attribute

  Method used to encapsulate the writing of the JAR file.

  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:
- baseName - the base name to use.
- jarfile - the jar file to write to.
- files - the files to write to the jar.
- publicId - the id to use.
Throws:
- BuildException - if there is a problem.