org.apache.tools.ant.taskdefs.optional.ejb

Class WebsphereDeploymentTool

java.lang.Object

org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool

org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool

All Implemented Interfaces:

EJBDeploymentTool

public class WebsphereDeploymentTool
extends GenericDeploymentTool

Websphere deployment tool that augments the ejbjar task. Searches for the websphere specific deployment descriptors and adds them to the final ejb jar file. Websphere has two specific descriptors for session beans:

• ibm-ejb-jar-bnd.xmi
• ibm-ejb-jar-ext.xmi

and another two for container managed entity beans:

• Map.mapxmi
• Schema.dbxmi

In terms of WebSphere, the generation of container code and stubs is called deployment. This step can be performed by the websphere element as part of the jar generation process. If the switch ejbdeploy is on, the ejbdeploy tool from the websphere toolset is called for every ejb-jar. Unfortunately, this step only works, if you use the ibm jdk. Otherwise, the rmic (called by ejbdeploy) throws a ClassFormatError. Be sure to switch ejbdeploy off, if run ant with sun jdk.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PUBLICID_EJB11 ID for ejb 1.1
static java.lang.String	PUBLICID_EJB20 ID for ejb 2.0
protected static java.lang.String	SCHEMA_DIR Schema directory
protected static java.lang.String	WAS_BND
protected static java.lang.String	WAS_CMP_MAP
protected static java.lang.String	WAS_CMP_SCHEMA
protected static java.lang.String	WAS_EXT

Fields inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool

ANALYZER_CLASS_FULL, ANALYZER_CLASS_SUPER, ANALYZER_FULL, ANALYZER_NONE, ANALYZER_SUPER, DEFAULT_ANALYZER, DEFAULT_BUFFER_SIZE, EJB_DD, JAR_COMPRESS_LEVEL, MANIFEST, META_DIR

Constructor Summary

Constructors

Constructor and Description
WebsphereDeploymentTool()

Method Summary

Modifier and Type	Method and Description
protected void	addVendorFiles(java.util.Hashtable ejbFiles, java.lang.String baseName) Add any vendor specific files which should be included in the EJB Jar.
Path	createWASClasspath() Get the classpath to the websphere classpaths.
protected java.lang.ClassLoader	getClassLoaderFromJar(java.io.File classjar) Helper method invoked by isRebuildRequired to get a ClassLoader for a Jar File passed to it.
protected DescriptorHandler	getDescriptorHandler(java.io.File srcDir) Get a descriptionHandler.
protected java.lang.String	getOptions() Gets the options for the EJB Deploy operation
protected DescriptorHandler	getWebsphereDescriptorHandler(java.io.File srcDir) Get a description handler.
protected boolean	isRebuildRequired(java.io.File genericJarFile, java.io.File websphereJarFile) Helper method to check to see if a websphere EBJ1.1 jar needs to be rebuilt using ejbdeploy.
void	setCodegen(boolean codegen) Flag, default false, to only generate the deployment code, do not run RMIC or Javac
void	setDbname(java.lang.String dbName) Sets the name of the Database to create; optional.
void	setDbschema(java.lang.String dbSchema) Sets the name of the schema to create; optional.
void	setDbvendor(java.lang.String dbvendor) Sets the DB Vendor for the Entity Bean mapping; optional.
void	setEjbdeploy(boolean ejbdeploy) Decide, whether ejbdeploy should be called or not; optional, default true.
void	setEJBdtd(java.lang.String inString) Setter used to store the location of the Sun's Generic EJB DTD.
void	setKeepgeneric(boolean inValue) This controls whether the generic file used as input to ejbdeploy is retained; optional, default false.
void	setNewCMP(boolean newCMP) Set the value of the newCMP scheme.
void	setNoinform(boolean noinform) Flag to disable informational messages; optional, default false.
void	setNovalidate(boolean novalidate) Flag to disable the validation steps; optional, default false.
void	setNowarn(boolean nowarn) Flag to disable warning and informational messages; optional, default false.
void	setOldCMP(boolean oldCMP) Set the value of the oldCMP scheme.
void	setQuiet(boolean quiet) Flag, default true, to only output error messages.
void	setRebuild(boolean rebuild) Set the rebuild flag to false to only update changes in the jar rather than rerunning ejbdeploy; optional, default true.
void	setRmicoptions(java.lang.String options) Set the rmic options.
void	setSuffix(java.lang.String inString) String value appended to the basename of the deployment descriptor to create the filename of the WebLogic EJB jar file.
void	setTempdir(java.lang.String tempdir) The directory, where ejbdeploy will write temporary files; optional, defaults to '_ejbdeploy_temp'.
void	setTrace(boolean trace) Flag to enable internal tracing when set, optional, default false.
void	setUse35(boolean attr) Flag to use the WebSphere 3.5 compatible mapping rules; optional, default false.
void	setWASClasspath(Path wasClasspath) Set the websphere classpath.
void	validateConfigured() Called to validate that the tool parameters have been configured.
protected void	writeJar(java.lang.String baseName, java.io.File jarFile, java.util.Hashtable files, java.lang.String publicId) Method used to encapsulate the writing of the JAR file.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool

addFileToJar, addSupportClasses, checkAndAddDependants, checkConfiguration, configure, createClasspath, getClassLoaderForBuild, getCombinedClasspath, getConfig, getDestDir, getJarBaseName, getLocation, getManifestFile, getPublicId, getTask, getVendorDDPrefix, log, needToRebuild, parseEjbFiles, processDescriptor, registerKnownDTDs, setClasspath, setDestdir, setGenericJarSuffix, setTask, usingBaseJarName

Methods inherited from class java.lang.Object

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

Field Detail

PUBLICID_EJB11

public static final java.lang.String PUBLICID_EJB11

ID for ejb 1.1

See Also:

Constant Field Values

PUBLICID_EJB20

public static final java.lang.String PUBLICID_EJB20

ID for ejb 2.0

See Also:

Constant Field Values

SCHEMA_DIR

protected static final java.lang.String SCHEMA_DIR

Schema directory

See Also:

Constant Field Values

WAS_EXT

protected static final java.lang.String WAS_EXT

See Also:

Constant Field Values

WAS_BND

protected static final java.lang.String WAS_BND

See Also:

Constant Field Values

WAS_CMP_MAP

protected static final java.lang.String WAS_CMP_MAP

See Also:

Constant Field Values

WAS_CMP_SCHEMA

protected static final java.lang.String WAS_CMP_SCHEMA

See Also:

Constant Field Values

Constructor Detail

WebsphereDeploymentTool

public WebsphereDeploymentTool()

Method Detail

createWASClasspath

public Path createWASClasspath()

Get the classpath to the websphere classpaths.

Returns:

the websphere classpath.

setWASClasspath

public void setWASClasspath(Path wasClasspath)

Set the websphere classpath.

Parameters:

wasClasspath - the websphere classpath.

setDbvendor

public void setDbvendor(java.lang.String dbvendor)

Sets the DB Vendor for the Entity Bean mapping; optional.

Valid options can be obtained by running the following command: <WAS_HOME>/bin/EJBDeploy.[sh/bat] -help

This is also used to determine the name of the Map.mapxmi and Schema.dbxmi files, for example Account-DB2UDB_V81-Map.mapxmi and Account-DB2UDB_V81-Schema.dbxmi.

Parameters:

dbvendor - database vendor type

setDbname

public void setDbname(java.lang.String dbName)

Sets the name of the Database to create; optional.

Parameters:

dbName - name of the database

setDbschema

public void setDbschema(java.lang.String dbSchema)

Sets the name of the schema to create; optional.

Parameters:

dbSchema - name of the schema

setCodegen

public void setCodegen(boolean codegen)

Flag, default false, to only generate the deployment code, do not run RMIC or Javac

Parameters:

codegen - option

setQuiet

public void setQuiet(boolean quiet)

Flag, default true, to only output error messages.

Parameters:

quiet - option

setNovalidate

public void setNovalidate(boolean novalidate)

Flag to disable the validation steps; optional, default false.

Parameters:

novalidate - option

setNowarn

public void setNowarn(boolean nowarn)

Flag to disable warning and informational messages; optional, default false.

Parameters:

nowarn - option

setNoinform

public void setNoinform(boolean noinform)

Flag to disable informational messages; optional, default false.

Parameters:

noinform - if true disables informational messages

setTrace

public void setTrace(boolean trace)

Flag to enable internal tracing when set, optional, default false.

Parameters:

trace - a boolean value.

setRmicoptions

public void setRmicoptions(java.lang.String options)

Set the rmic options.

Parameters:

options - the options to use.

setUse35

public void setUse35(boolean attr)

Flag to use the WebSphere 3.5 compatible mapping rules; optional, default false.

Parameters:

attr - a boolean value.

setRebuild

public void setRebuild(boolean rebuild)

Set the rebuild flag to false to only update changes in the jar rather than rerunning ejbdeploy; optional, default true.

Parameters:

rebuild - a boolean value.

setSuffix

public void setSuffix(java.lang.String inString)

String value appended to the basename of the deployment descriptor to create the filename of the WebLogic EJB jar file. Optional, default '.jar'.

Parameters:

inString - the string to use as the suffix.

setKeepgeneric

public void setKeepgeneric(boolean inValue)

This controls whether the generic file used as input to ejbdeploy is retained; optional, default false.

Parameters:

inValue - either 'true' or 'false'.

setEjbdeploy

public void setEjbdeploy(boolean ejbdeploy)

Decide, whether ejbdeploy should be called or not; optional, default true.

Parameters:

ejbdeploy - a boolean value.

setEJBdtd

public void setEJBdtd(java.lang.String inString)

Setter used to store the location of the Sun's Generic EJB DTD. This can be a file on the system or a resource on the classpath.

Parameters:

inString - the string to use as the DTD location.

setOldCMP

public void setOldCMP(boolean oldCMP)

Set the value of the oldCMP scheme. This is an antonym for newCMP

Parameters:

oldCMP - a boolean value.

setNewCMP

public void setNewCMP(boolean newCMP)

Set the value of the newCMP scheme. The old CMP scheme locates the websphere CMP descriptor based on the naming convention where the websphere CMP file is expected to be named with the bean name as the prefix. Under this scheme the name of the CMP descriptor does not match the name actually used in the main websphere EJB descriptor. Also, descriptors which contain multiple CMP references could not be used.

Parameters:

newCMP - a boolean value.

setTempdir

public void setTempdir(java.lang.String tempdir)

The directory, where ejbdeploy will write temporary files; optional, defaults to '_ejbdeploy_temp'.

Parameters:

tempdir - the directory name to use.

getDescriptorHandler

protected DescriptorHandler getDescriptorHandler(java.io.File srcDir)

Get a descriptionHandler..

Overrides:

getDescriptorHandler in class GenericDeploymentTool

Parameters:

srcDir - the source directory.

Returns:

a handler.

getWebsphereDescriptorHandler

protected DescriptorHandler getWebsphereDescriptorHandler(java.io.File srcDir)

Get a description handler.

Parameters:

srcDir - the source directory.

Returns:

the handler.

addVendorFiles

protected void addVendorFiles(java.util.Hashtable ejbFiles,
                              java.lang.String baseName)

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

Overrides:

addVendorFiles in class GenericDeploymentTool

Parameters:

ejbFiles - a hashtable entryname -> file.

baseName - a prefix to use.

getOptions

protected java.lang.String getOptions()

Gets the options for the EJB Deploy operation

Returns:

String

writeJar

protected void writeJar(java.lang.String baseName,
                        java.io.File jarFile,
                        java.util.Hashtable files,
                        java.lang.String publicId)
                 throws BuildException

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

Overrides:

writeJar in class GenericDeploymentTool

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.

validateConfigured

public void validateConfigured()
                        throws BuildException

Called to validate that the tool parameters have been configured.

Specified by:

validateConfigured in interface EJBDeploymentTool

Overrides:

validateConfigured in class GenericDeploymentTool

Throws:

BuildException - if there is an error.

isRebuildRequired

protected boolean isRebuildRequired(java.io.File genericJarFile,
                                    java.io.File websphereJarFile)

Helper method to check to see if a websphere EBJ1.1 jar needs to be rebuilt using ejbdeploy. Called from writeJar it sees if the "Bean" classes are the only thing that needs to be updated and either updates the Jar with the Bean classfile or returns true, saying that the whole websphere jar needs to be regened with ejbdeploy. This allows faster build times for working developers.

The way websphere ejbdeploy works is it creates wrappers for the publicly defined methods as they are exposed in the remote interface. If the actual bean changes without changing the the method signatures then only the bean classfile needs to be updated and the rest of the websphere jar file can remain the same. If the Interfaces, ie. the method signatures change or if the xml deployment descriptors changed, the whole jar needs to be rebuilt with ejbdeploy. This is not strictly true for the xml files. If the JNDI name changes then the jar doesn't have to be rebuild, but if the resources references change then it does. At this point the websphere jar gets rebuilt if the xml files change at all.

Parameters:

genericJarFile - java.io.File The generic jar file.

websphereJarFile - java.io.File The websphere jar file to check to see if it needs to be rebuilt.

Returns:

true if a rebuild is required.

getClassLoaderFromJar

protected java.lang.ClassLoader getClassLoaderFromJar(java.io.File classjar)
                                               throws java.io.IOException

Helper method invoked by isRebuildRequired to get a ClassLoader for a Jar File passed to it.

Parameters:

classjar - java.io.File representing jar file to get classes from.

Returns:

a classloader for the jar file.

Throws:

java.io.IOException - if there is an error.