com.ibm.websphere.ant.tasks

Class WsEjbDeploy

  1. java.lang.Object
  2. extended byTask
  3. extended bycom.ibm.websphere.ant.tasks.WsEjbDeploy

  1. public class WsEjbDeploy
  2. extends Task
The wsejbdeploy task executes the WebSphere EJB Deploy tool on the specified Jar file with the specified options. The structure of the wsejbdeploy task is shown below: <wsejbdeploy inputjar="ejb jar file or Ear file" washome="websphere installation directory" workingdirectory="temp directory" outputjar="output ejb jar file or ear file" classpath="ear classes" classpathref="ear classes element reference" codegen="true | false" dbname="database name" dbschema="Database Schema Name" dbvendor="database vendor" dynamic="Enable Dynamic Query Support" keepgenerated="true | false" quiet="true | false" novalidate="true | false" nowarnings="true | false" noinform="true | false" rmicoptions="rmic options" compatible35="true | false" sqlj="true | false" failonerror="true | false" trace="true | false" jvmmaxmemory="256m" jdkcompliancelevel="1.4 | 5.0 | 6.0"> <systemproperty value=""/> . . . <systemproperty value=""/> </wsejbdeploy> The wasHome attribute is optional and contains the location of the WebSphere Installation Directory.
The inputJar attribute is required and contains the undeployed EJB Jar file or EAR file you wish to deploy.
The workingDirectory attribute is optional. It normally contains a temporary directory for the deploy tool to use. If not set, the Java System Property user.home is used.
The outputJar attribute is required and specifies the name of the deployed EJB Jar or EAR file to create.
The classpath attribute is optional. It allows the specification of ear classes to be added to the classpath of the deploy tool.
The classpathref attribute is optional. It does the same thing as the classpath attribute, but allows the use of the Ant reference mechanism for the specification of the path.
The codegen attribute is optional and is set to true to keep the generated Java files
The dbname attribute is optional and specifies the name of the database to create
The dbschema attribute is optional and specifies the name of the database schema to create
The dbvendor attribute is optional and specifies the type of database the EJBs will use
The dynamic attribute is optional and specifies to enable dynamic query support
The keepGenerated attribute is optional and is set to true to prevent the workingDirectory from being deleted
The quiet attribute is optional and is set to true to only output error messages, surpressing informational messages
The noValidate attribute is optional and set to true to disable validation messages
The noWarnings attribute is optional and set to true to disable warning and informational messages
The noInform attribute is optional and set to true to disable informational messages
The rmicOptions attribute is optional allows additional arguments to be passed to the rmic command
The compatible35 attribute is optional and set to true to use WebSphere 3.5 compatible mapping rules
The sqlj attribute is optional and set to true to generate SQL/J persistor code
The trace attribute is optional and set to true to enable internal deploy tool tracing
The failonerror attribute is optional and set to true to cause your build to stop on deploy errors
The jvmMaxMemory attribute is optional and sets maximum size of the memory for the underlying VM. Defaults to 256M
The systemProperty attribute is optional and it adds the value as the java system properties when java get called
The jdkComplianceLevel attribute is optional and sets the JDK level for compiler compliance. Valid values are 1.4, 5.0, 6.0.

To use this task, add the following to your Ant build.xml <taskdef name="wsejbdeploy" classname="com.ibm.websphere.ant.tasks.WsEjbDeploy"/>

Field Summary

Modifier and Type Field and Description
  1. protected
  2. com.ibm.ws.ant.utils.WasUtils
wasUtils

Constructor Summary

Constructor and Description
WsEjbDeploy()
Constructor for WsEjbDeploy

Method Summary

Modifier and Type Method and Description
  1. Path
createClasspath()
Maybe creates a nested classpath element.
  1. Commandline.Argument
createSystemProperty()
Creates a nested arg element.
  1. void
execute()
  1. boolean
isDebug()
Is debugging enabled?
  1. void
setClasspath(Path classpath)
Sets the classpath
  1. void
setClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.
  1. void
setCodegen(boolean codegen)
Sets the codegen
  1. void
setCompatible35(boolean compatible35)
Sets the compatible35
  1. void
setDbname(java.lang.String dbname)
Sets the dbname
  1. void
setDbschema(java.lang.String dbschema)
Sets the dbschema
  1. void
setDbvendor(java.lang.String dbvendor)
Sets the dbvendor
  1. void
setDebug(boolean debug)
Setter for enabling debugging
  1. void
setDynamic(boolean dynamic)
Sets the dynamic
  1. void
setFailonerror(boolean failonerror)
Sets the failonerror.
  1. void
setIgnoreErrors(boolean ignoreErrors)
Sets the ignoreErrors
  1. void
setInputJar(java.io.File inputJar)
Sets the inputJar
  1. void
setJdkComplianceLevel(java.lang.String complianceLevel)
Sets the jdk compliance level for ejbdeploy
  1. void
setJvmMaxMemory(java.lang.String jvmMaxMemory)
Sets the jvmMaxMemory.
  1. void
setKeepGenerated(boolean keepGenerated)
Sets the keepGenerated
  1. void
setLog(boolean log)
  1. void
setNoInform(boolean noInform)
Sets the noInform
  1. void
setNoValidate(boolean noValidate)
Sets the noValidate
  1. void
setNoWarnings(boolean noWarnings)
Sets the noWarnings
  1. void
setOutputJar(java.io.File outputJar)
Sets the outputJar
  1. void
setQuiet(boolean quiet)
Sets the quiet
  1. void
setRmicOptions(java.lang.String rmicOptions)
Sets the rmicOptions
  1. void
setSqlj(boolean sqlj)
Sets the sqlj
  1. void
setTrace(boolean trace)
Sets the trace
  1. void
setWasHome(java.lang.String wasHome)
Sets the wasHome.
  1. void
setWorkingDirectory(java.io.File workingDirectory)
Sets the workingDirectory
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

wasUtils

  1. protected final com.ibm.ws.ant.utils.WasUtils wasUtils

Constructor Detail

WsEjbDeploy

  1. public WsEjbDeploy()
Constructor for WsEjbDeploy

Method Detail

createClasspath

  1. public Path createClasspath()
Maybe creates a nested classpath element.

setClasspathRef

  1. public void setClasspathRef(Reference r)
Adds a reference to a CLASSPATH defined elsewhere.

setClasspath

  1. public void setClasspath(Path classpath)
Sets the classpath
Parameters:
classpath - The classpath to set

setCodegen

  1. public void setCodegen(boolean codegen)
Sets the codegen
Parameters:
codegen - The codegen to set

setCompatible35

  1. public void setCompatible35(boolean compatible35)
Sets the compatible35
Parameters:
compatible35 - The compatible35 to set

setSqlj

  1. public void setSqlj(boolean sqlj)
Sets the sqlj
Parameters:
sqlj - The sqlj to set

setDbname

  1. public void setDbname(java.lang.String dbname)
Sets the dbname
Parameters:
dbname - The dbname to set

setDbschema

  1. public void setDbschema(java.lang.String dbschema)
Sets the dbschema
Parameters:
dbschema - The dbschema to set

setDbvendor

  1. public void setDbvendor(java.lang.String dbvendor)
Sets the dbvendor
Parameters:
dbvendor - The dbvendor to set

setIgnoreErrors

  1. public void setIgnoreErrors(boolean ignoreErrors)
Sets the ignoreErrors
Parameters:
ignoreErrors - The ignoreErrors to set

setInputJar

  1. public void setInputJar(java.io.File inputJar)
Sets the inputJar
Parameters:
inputJar - The inputJar to set

setKeepGenerated

  1. public void setKeepGenerated(boolean keepGenerated)
Sets the keepGenerated
Parameters:
keepGenerated - The keepGenerated to set

setDynamic

  1. public void setDynamic(boolean dynamic)
Sets the dynamic
Parameters:
dynamic - The dynamic to set

setNoInform

  1. public void setNoInform(boolean noInform)
Sets the noInform
Parameters:
noInform - The noInform to set

setNoValidate

  1. public void setNoValidate(boolean noValidate)
Sets the noValidate
Parameters:
noValidate - The noValidate to set

setNoWarnings

  1. public void setNoWarnings(boolean noWarnings)
Sets the noWarnings
Parameters:
noWarnings - The noWarnings to set

setOutputJar

  1. public void setOutputJar(java.io.File outputJar)
Sets the outputJar
Parameters:
outputJar - The outputJar to set

setQuiet

  1. public void setQuiet(boolean quiet)
Sets the quiet
Parameters:
quiet - The quiet to set

setRmicOptions

  1. public void setRmicOptions(java.lang.String rmicOptions)
Sets the rmicOptions
Parameters:
rmicOptions - The rmicOptions to set

setTrace

  1. public void setTrace(boolean trace)
Sets the trace
Parameters:
trace - The trace to set

setLog

  1. public void setLog(boolean log)

setJdkComplianceLevel

  1. public void setJdkComplianceLevel( java.lang.String complianceLevel)
Sets the jdk compliance level for ejbdeploy
Parameters:
complianceLevel -

setWorkingDirectory

  1. public void setWorkingDirectory( java.io.File workingDirectory)
Sets the workingDirectory
Parameters:
workingDirectory - The workingDirectory to set

setWasHome

  1. public void setWasHome(java.lang.String wasHome)
Sets the wasHome.
Parameters:
wasHome - The wasHome to set

setFailonerror

  1. public void setFailonerror(boolean failonerror)
Sets the failonerror.
Parameters:
failonerror - The failonerror to set

setJvmMaxMemory

  1. public void setJvmMaxMemory(java.lang.String jvmMaxMemory)
Sets the jvmMaxMemory.
Parameters:
jvmMaxMemory - The JVM MaxMemory to set

isDebug

  1. public boolean isDebug()
Is debugging enabled?
Returns:

setDebug

  1. public void setDebug(boolean debug)
Setter for enabling debugging
Parameters:
debug -

execute

  1. public void execute()
  2. throws BuildException
Throws:
BuildException

createSystemProperty

  1. public Commandline.Argument createSystemProperty( )
Creates a nested arg element.