org.ow2.jonas.ant
Class EjbJarDeprecated

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.ow2.jonas.ant.AbstractAntDeprecated
              org.ow2.jonas.ant.EjbJarDeprecated

All Implemented Interfaces:

Cloneable

public class EjbJarDeprecated
extends AbstractAntDeprecated

Class only used for compatibility with previous version of JOnAS

Author:

Jeremy Cazaux

Field Summary

Fields inherited from class org.ow2.jonas.ant.AbstractAntDeprecated

logger

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

EjbJarDeprecated()

Method Summary

Object	createClasspath() Adds to the classpath used to locate the super classes and interfaces of the classes that will make up the EJB JAR.
protected Object	createDeploymentTool(org.apache.tools.ant.taskdefs.optional.ejb.EJBDeploymentTool deploymentTool) Add a deployment tool to the list of deployment tools that will be processed
Object	createDTD() Create a DTD location record.
Object	createJonas() Adds a deployment tool for JOnAS server.
Object	createSupport() Adds a fileset for support elements.
void	setBasejarname(String inValue) Set the base name of the EJB JAR that is to be created if it is not to be determined from the name of the deployment descriptor files.
void	setBasenameterminator(String inValue) The string which terminates the bean name.
void	setClasspath(org.apache.tools.ant.types.Path classpath) Set the classpath to use when resolving classes for inclusion in the jar.
void	setCmpversion(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion version) Sets the CMP version.
void	setDependency(String analyzer) Set the analyzer to use when adding in dependencies to the JAR.
void	setDescriptordir(File inDir) Set the descriptor directory.
void	setDestdir(File inDir) Set the destination directory.
void	setFlatdestdir(boolean inValue) Controls whether the destination JARs are written out in the destination directory with the same hierarchical structure from which the deployment descriptors have been read.
void	setGenericjarsuffix(String inString) Set the suffix for the generated jar file.
void	setManifest(File manifest) Set the Manifest file to use when jarring.
void	setNaming(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme namingScheme) Set the naming scheme used to determine the name of the generated jars from the deployment descriptor
void	setSrcdir(File inDir) Sets the source directory, which is the directory that contains the classes that will be added to the EJB jar.

Methods inherited from class org.ow2.jonas.ant.AbstractAntDeprecated

deprecated

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

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

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

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EjbJarDeprecated

public EjbJarDeprecated()

Method Detail

setManifest

public void setManifest(File manifest)
                 throws Exception

Set the Manifest file to use when jarring. As of EJB 1.1, manifest files are no longer used to configure the EJB. However, they still have a vital importance if the EJB is intended to be packaged in an EAR file. By adding "Class-Path" settings to a Manifest file, the EJB can look for classes inside the EAR file itself, allowing for easier deployment. This is outlined in the J2EE specification, and all J2EE components are meant to support it.

Parameters:

manifest - the manifest to be used in the EJB jar

Throws:

Exception

setSrcdir

public void setSrcdir(File inDir)
               throws Exception

Sets the source directory, which is the directory that contains the classes that will be added to the EJB jar. Typically this will include the home and remote interfaces and the bean class.

Parameters:

inDir - the source directory.

Throws:

Exception

setDescriptordir

public void setDescriptordir(File inDir)
                      throws Exception

Set the descriptor directory. The descriptor directory contains the EJB deployment descriptors. These are XML files that declare the properties of a bean in a particular deployment scenario. Such properties include, for example, the transactional nature of the bean and the security access control to the bean's methods.

Parameters:

inDir - the directory containing the deployment descriptors.

Throws:

Exception

setDependency

public void setDependency(String analyzer)
                   throws Exception

Set the analyzer to use when adding in dependencies to the JAR.

Parameters:

analyzer - the name of the dependency analyzer or a class.

Throws:

Exception

setBasejarname

public void setBasejarname(String inValue)
                    throws Exception

Set the base name of the EJB JAR that is to be created if it is not to be determined from the name of the deployment descriptor files.

Parameters:

inValue - the basename that will be used when writing the jar file containing the EJB

Throws:

Exception

setNaming

public void setNaming(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.NamingScheme namingScheme)
               throws Exception

Set the naming scheme used to determine the name of the generated jars from the deployment descriptor

Parameters:

namingScheme - the naming scheme to be used

Throws:

Exception

setDestdir

public void setDestdir(File inDir)
                throws Exception

Set the destination directory. The EJB jar files will be written into this directory. The jar files that exist in this directory are also used when determining if the contents of the jar file have changed. Note that this parameter is only used if no deployment tools are specified. Typically each deployment tool will specify its own destination directory.

Parameters:

inDir - the destination directory in which to generate jars

Throws:

Exception

setCmpversion

public void setCmpversion(org.apache.tools.ant.taskdefs.optional.ejb.EjbJar.CMPVersion version)
                   throws Exception

Sets the CMP version.

Parameters:

version - CMP version. Must be either 1.0 or 2.0.
Default is 1.0.
Initially, only the JBoss implementation does something specific for CMP 2.0.

Throws:

Exception

Since:

ant 1.6

setClasspath

public void setClasspath(org.apache.tools.ant.types.Path classpath)
                  throws Exception

Set the classpath to use when resolving classes for inclusion in the jar.

Parameters:

classpath - the classpath to use.

Throws:

Exception

setFlatdestdir

public void setFlatdestdir(boolean inValue)
                    throws Exception

Controls whether the destination JARs are written out in the destination directory with the same hierarchical structure from which the deployment descriptors have been read. If this is set to true the generated EJB jars are written into the root of the destination directory, otherwise they are written out in the same relative position as the deployment descriptors in the descriptor directory.

Parameters:

inValue - the new value of the flatdestdir flag.

Throws:

Exception

setGenericjarsuffix

public void setGenericjarsuffix(String inString)
                         throws Exception

Set the suffix for the generated jar file. When generic jars are generated, they have a suffix which is appended to the the bean name to create the name of the jar file. Note that this suffix includes the extension fo te jar file and should therefore end with an appropriate extension such as .jar or .ear

Parameters:

inString - the string to use as the suffix.

Throws:

Exception

setBasenameterminator

public void setBasenameterminator(String inValue)
                           throws Exception

The string which terminates the bean name. The convention used by this task is that bean descriptors are named as the BeanName with some suffix. The baseNameTerminator string separates the bean name and the suffix and is used to determine the bean name.

Parameters:

inValue - a string which marks the end of the basename.

Throws:

Exception

createJonas

public Object createJonas()
                   throws Exception

Adds a deployment tool for JOnAS server.

Returns:

the deployment tool instance to be configured.

Throws:

Exception

createClasspath

public Object createClasspath()
                       throws Exception

Adds to the classpath used to locate the super classes and interfaces of the classes that will make up the EJB JAR.

Returns:

the path to be configured.

Throws:

Exception

createDTD

public Object createDTD()
                 throws Exception

Create a DTD location record. This stores the location of a DTD. The DTD is identified by its public Id. The location may either be a file location or a resource location.

Returns:

the DTD location object to be configured by Ant

Throws:

Exception

createSupport

public Object createSupport()
                     throws Exception

Adds a fileset for support elements.

Returns:

a fileset which can be populated with support files.

Throws:

Exception

createDeploymentTool

protected Object createDeploymentTool(org.apache.tools.ant.taskdefs.optional.ejb.EJBDeploymentTool deploymentTool)
                               throws Exception

Add a deployment tool to the list of deployment tools that will be processed

Parameters:

deploymentTool - a deployment tool instance to which descriptors will be passed for processing.

Throws:

Exception