Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool
org.apache.tools.ant.taskdefs.optional.ejb.WebsphereDeploymentTool
public class WebsphereDeploymentTool
extends GenericDeploymentTool
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 | |
static String |
|
static String |
|
protected static String |
|
protected static String | |
protected static String | |
protected static String | |
protected static String |
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 |
Method Summary | |
protected void |
|
Path |
|
protected ClassLoader |
|
protected DescriptorHandler |
|
protected String |
|
protected DescriptorHandler |
|
protected boolean |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
Methods inherited from class org.apache.tools.ant.taskdefs.optional.ejb.GenericDeploymentTool | |
addFileToJar , addSupportClasses , addVendorFiles , checkAndAddDependants , checkConfiguration , configure , createClasspath , getClassLoaderForBuild , getCombinedClasspath , getConfig , getDescriptorHandler , getDestDir , getJarBaseName , getLocation , getManifestFile , getPublicId , getTask , getVendorDDPrefix , log , needToRebuild , parseEjbFiles , processDescriptor , registerKnownDTDs , setClasspath , setDestdir , setGenericJarSuffix , setTask , usingBaseJarName , validateConfigured , writeJar |
public static final String PUBLICID_EJB11
ID for ejb 1.1
public 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
protected void addVendorFiles(Hashtable ejbFiles, String baseName)
Add any vendor specific files which should be included in the EJB Jar.
- Overrides:
- addVendorFiles in interface GenericDeploymentTool
- Parameters:
ejbFiles
- a hashtable entryname -> file.baseName
- a prefix to use.
public Path createWASClasspath()
Get the classpath to the websphere classpaths.
- Returns:
- the websphere classpath.
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.
protected DescriptorHandler getDescriptorHandler(File srcDir)
.
- Overrides:
- getDescriptorHandler in interface GenericDeploymentTool
protected String getOptions()
Gets the options for the EJB Deploy operation
- Returns:
- String
protected DescriptorHandler getWebsphereDescriptorHandler(File srcDir)
Get a description handler.
- Parameters:
srcDir
- the source directory.
- Returns:
- the handler.
protected boolean isRebuildRequired(File genericJarFile, 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 doesnt 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.
public void setCodegen(boolean codegen)
Flag, default false, to only generate the deployment code, do not run RMIC or Javac
- Parameters:
codegen
- option
public void setDbname(String dbName)
Sets the name of the Database to create; optional.
- Parameters:
dbName
- name of the database
public void setDbschema(String dbSchema)
Sets the name of the schema to create; optional.
- Parameters:
dbSchema
- name of the schema
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
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.
public void setEjbdeploy(boolean ejbdeploy)
Decide, wether ejbdeploy should be called or not; optional, default true.
- Parameters:
ejbdeploy
- aboolean
value.
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'.
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
- aboolean
value.
public void setNoinform(boolean noinform)
Flag to disable informational messages; optional, default false.
- Parameters:
noinform
- if true disables informational messages
public void setNovalidate(boolean novalidate)
Flag to disable the validation steps; optional, default false.
- Parameters:
novalidate
- option
public void setNowarn(boolean nowarn)
Flag to disable warning and informational messages; optional, default false.
- Parameters:
nowarn
- option
public void setOldCMP(boolean oldCMP)
Set the value of the oldCMP scheme. This is an antonym for newCMP
- Parameters:
oldCMP
- aboolean
value.
public void setQuiet(boolean quiet)
Flag, default true, to only output error messages.
- Parameters:
quiet
- option
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
- aboolean
value.
public void setRmicoptions(String options)
Set the rmic options.
- Parameters:
options
- the options to use.
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.
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.
public void setTrace(boolean trace)
Flag to enable internal tracing when set, optional, default false.
- Parameters:
trace
- aboolean
vaule.
public void setUse35(boolean attr)
Flag to use the WebSphere 3.5 compatible mapping rules ; optional, default false.
- Parameters:
attr
- aboolean
value.
public void setWASClasspath(Path wasClasspath)
Set the websphere classpath.
- Parameters:
wasClasspath
- the websphere classpath.
public void validateConfigured() throws BuildException
Called to validate that the tool parameters have been configured.
- Specified by:
- validateConfigured in interface EJBDeploymentTool
- Overrides:
- validateConfigured in interface GenericDeploymentTool
- Throws:
BuildException
- if there is an error.
protected void writeJar(String baseName, File jarFile, Hashtable files, String publicId) throws BuildException
.
- Overrides:
- writeJar in interface GenericDeploymentTool