WebsphereDeploymentTool (Apache Ant API)
Description: declaration: package: org.apache.tools.ant.taskdefs.optional.ejb, class: WebsphereDeploymentTool

Package 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
  Description
  `static final String`
  `PUBLICID_EJB11`
  ID for ejb 1.1
  `static final String`
  `PUBLICID_EJB20`
  ID for ejb 2.0
  `protected static final String`
  `SCHEMA_DIR`
  Schema directory
  `protected static final String`
  `WAS_BND`
  `protected static final String`
  `WAS_CMP_MAP`
  `protected static final String`
  `WAS_CMP_SCHEMA`
  `protected static final 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
  Description
  `WebsphereDeploymentTool()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `protected void`
  `addVendorFiles(Hashtable<String,File> ejbFiles, 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 ClassLoader`
  `getClassLoaderFromJar(File classjar)`
  Helper method invoked by isRebuildRequired to get a ClassLoader for a Jar File passed to it.
  `protected DescriptorHandler`
  `getDescriptorHandler(File srcDir)`
  Get a descriptionHandler.
  `protected String`
  `getOptions()`
  Gets the options for the EJB Deploy operation
  `protected DescriptorHandler`
  `getWebsphereDescriptorHandler(File srcDir)`
  Get a description handler.
  `protected boolean`
  `isRebuildRequired(File genericJarFile, File websphereJarFile)`
  Helper method to check to see if a WebSphere EJB 1.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(String dbName)`
  Sets the name of the Database to create; optional.
  `void`
  `setDbschema(String dbSchema)`
  Sets the name of the schema to create; optional.
  `void`
  `setDbvendor(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(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(String options)`
  Set the rmic options.
  `void`
  `setSuffix(String inString)`
  String value appended to the basename of the deployment descriptor to create the filename of the WebLogic EJB jar file.
  `void`
  `setTempdir(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(String baseName, File jarFile, Hashtable<String,File> files, 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 Details

  - ### PUBLICID_EJB11

    public static final String PUBLICID_EJB11
    ID for ejb 1.1
    See Also:
      - Constant Field Values

  - ### PUBLICID_EJB20

    public static final String PUBLICID_EJB20
    ID for ejb 2.0
    See Also:
      - Constant Field Values

  - ### SCHEMA_DIR

    protected static final String SCHEMA_DIR
    Schema directory
    See Also:
      - Constant Field Values

  - ### WAS_EXT

    protected static final String WAS_EXT
    See Also:
      - Constant Field Values

  - ### WAS_BND

    protected static final String WAS_BND
    See Also:
      - Constant Field Values

  - ### WAS_CMP_MAP

    protected static final String WAS_CMP_MAP
    See Also:
      - Constant Field Values

  - ### WAS_CMP_SCHEMA

    protected static final String WAS_CMP_SCHEMA
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### WebsphereDeploymentTool

    public WebsphereDeploymentTool()

- ## Method Details

  - ### 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(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(String dbName)
    Sets the name of the Database to create; optional.
    Parameters:
      `dbName` - name of the database

  - ### setDbschema

    public void setDbschema(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(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(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(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(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(File srcDir)
    Get a descriptionHandler..
    Overrides:
      `getDescriptorHandler` in class `GenericDeploymentTool`
    Parameters:
      `srcDir` - the source directory.
    Returns:
      a handler.

  - ### getWebsphereDescriptorHandler

    protected DescriptorHandler getWebsphereDescriptorHandler(File srcDir)
    Get a description handler.
    Parameters:
      `srcDir` - the source directory.
    Returns:
      the handler.

  - ### addVendorFiles

    protected void addVendorFiles(Hashtable<String,File> ejbFiles, 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 String getOptions()
    Gets the options for the EJB Deploy operation
    Returns:
      String

  - ### writeJar

    protected void writeJar(String baseName, File jarFile, Hashtable<String,File> files, 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(File genericJarFile, File websphereJarFile)
    Helper method to check to see if a WebSphere EJB 1.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 regenerated 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 ClassLoader getClassLoaderFromJar(File classjar) throws 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:
      `IOException` - if there is an error.