com.ibm.websphere.ant.tasks
Class WsEjbDeploy

java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--com.ibm.websphere.ant.tasks.WsEjbDeploy

public class WsEjbDeploy

extends org.apache.tools.ant.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="jarfile" wasHome="WebSphere Installation Directory" workingDirectory="temp directory" outputJar="out jarfile" 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"/> 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 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 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

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

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

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

WsEjbDeploy()
Constructor for WsEjbDeploy

Method Summary

org.apache.tools.ant.types.Path	createClasspath() Maybe creates a nested classpath element.
void	execute()
void	setClasspath(org.apache.tools.ant.types.Path classpath) Sets the classpath
void	setClasspathRef(org.apache.tools.ant.types.Reference r) Adds a reference to a CLASSPATH defined elsewhere.
void	setCodegen(boolean codegen) Sets the codegen
void	setCompatible35(boolean compatible35) Sets the compatible35
void	setDbname(java.lang.String dbname) Sets the dbname
void	setDbschema(java.lang.String dbschema) Sets the dbschema
void	setDbvendor(java.lang.String dbvendor) Sets the dbvendor
void	setDynamic(boolean dynamic) Sets the dynamic
void	setFailonerror(boolean failonerror) Sets the failonerror.
void	setIgnoreErrors(boolean ignoreErrors) Sets the ignoreErrors
void	setInputJar(java.io.File inputJar) Sets the inputJar
void	setKeepGenerated(boolean keepGenerated) Sets the keepGenerated
void	setLog(boolean log)
void	setNoInform(boolean noInform) Sets the noInform
void	setNoValidate(boolean noValidate) Sets the noValidate
void	setNoWarnings(boolean noWarnings) Sets the noWarnings
void	setOutputJar(java.io.File outputJar) Sets the outputJar
void	setQuiet(boolean quiet) Sets the quiet
void	setRmicOptions(java.lang.String rmicOptions) Sets the rmicOptions
void	setSqlj(boolean sqlj) Sets the sqlj
void	setTrace(boolean trace) Sets the trace
void	setWasHome(java.lang.String wasHome) Sets the wasHome.
void	setWorkingDirectory(java.io.File workingDirectory) Sets the workingDirectory

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

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorFlush, handleErrorOutput, handleFlush, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName

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

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

WsEjbDeploy

public WsEjbDeploy()

Constructor for WsEjbDeploy

Method Detail

createClasspath

public org.apache.tools.ant.types.Path createClasspath()

Maybe creates a nested classpath element.

setClasspathRef

public void setClasspathRef(org.apache.tools.ant.types.Reference r)

Adds a reference to a CLASSPATH defined elsewhere.

setClasspath

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

Sets the classpath

Parameters:

classpath - The classpath to set

setCodegen

public void setCodegen(boolean codegen)

Sets the codegen

Parameters:

codegen - The codegen to set

setCompatible35

public void setCompatible35(boolean compatible35)

Sets the compatible35

Parameters:

compatible35 - The compatible35 to set

setSqlj

public void setSqlj(boolean sqlj)

Sets the sqlj

Parameters:

sqlj - The sqlj to set

setDbname

public void setDbname(java.lang.String dbname)

Sets the dbname

Parameters:

dbname - The dbname to set

setDbschema

public void setDbschema(java.lang.String dbschema)

Sets the dbschema

Parameters:

dbschema - The dbschema to set

setDbvendor

public void setDbvendor(java.lang.String dbvendor)

Sets the dbvendor

Parameters:

dbvendor - The dbvendor to set

setIgnoreErrors

public void setIgnoreErrors(boolean ignoreErrors)

Sets the ignoreErrors

Parameters:

ignoreErrors - The ignoreErrors to set

setInputJar

public void setInputJar(java.io.File inputJar)

Sets the inputJar

Parameters:

inputJar - The inputJar to set

setKeepGenerated

public void setKeepGenerated(boolean keepGenerated)

Sets the keepGenerated

Parameters:

keepGenerated - The keepGenerated to set

setDynamic

public void setDynamic(boolean dynamic)

Sets the dynamic

Parameters:

dynamic - The dynamic to set

setNoInform

public void setNoInform(boolean noInform)

Sets the noInform

Parameters:

noInform - The noInform to set

setNoValidate

public void setNoValidate(boolean noValidate)

Sets the noValidate

Parameters:

noValidate - The noValidate to set

setNoWarnings

public void setNoWarnings(boolean noWarnings)

Sets the noWarnings

Parameters:

noWarnings - The noWarnings to set

setOutputJar

public void setOutputJar(java.io.File outputJar)

Sets the outputJar

Parameters:

outputJar - The outputJar to set

setQuiet

public void setQuiet(boolean quiet)

Sets the quiet

Parameters:

quiet - The quiet to set

setRmicOptions

public void setRmicOptions(java.lang.String rmicOptions)

Sets the rmicOptions

Parameters:

rmicOptions - The rmicOptions to set

setTrace

public void setTrace(boolean trace)

Sets the trace

Parameters:

trace - The trace to set

setLog

public void setLog(boolean log)

setWorkingDirectory

public void setWorkingDirectory(java.io.File workingDirectory)

Sets the workingDirectory

Parameters:

workingDirectory - The workingDirectory to set

setWasHome

public void setWasHome(java.lang.String wasHome)

Sets the wasHome.

Parameters:

wasHome - The wasHome to set

setFailonerror

public void setFailonerror(boolean failonerror)

Sets the failonerror.

Parameters:

failonerror - The failonerror to set

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

See Also:

Task.execute()