|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectTask
com.ibm.websphere.ant.tasks.ServiceDeployTask
public final class ServiceDeployTask
The serviceDeploy task enables you to generate J2EE application ear files from Service Component Architecture (SCA) compliant modules so that they may be installed on a WebSphere Process Server. The SCA modules may be project interchange zip files exported from a WebSphere Integration Developer workspace or may be simple jar files that contain an sca module file and other supporting artifacts. Additionally the libraryMode option can be used to enable serviceDeploy to build libraries without an associated SCA module The structure of the serviceDeploy task is shown below:
Field Summary | |
---|---|
static java.lang.String[] |
excluded_props
The jvm launched by the serviceDeploy task is initialized with the ANT process's system properties except for those properties listed in the excluded_props field:java.assistive, java.runtime.name, sun.boot.library.path, java.vm.version, java.vm.vendor, java.vendor.url, path.separator, java.vm.name, user.country, sun.os.patch.level, java.vm.specification.name, user.dir, java.runtime.version, java.fullversion, java.awt.graphicsenv, java.endorsed.dirs, os.arch, com.ibm.vm.bitmode, java.io.tmpdir, line.separator, java.vm.specification.vendor, user.variant, java.awt.fonts, os.name, sun.java2d.fontpath, java.library.path, java.specification.name, java.class.version, invokedviajava, java.util.prefs.PreferencesFactory, os.version, user.home, user.timezone, java.awt.printerjob, java.specification.version, java.class.path, user.name, java.vm.specification.version, java.home, sun.arch.data.model, user.language, java.specification.vendor, awt.toolkit, java.vm.info, java.version, sun.boot.class.path, java.vendor, file.separator, java.vendor.url.bug, java.compiler, java.util.logging.configureByServer, java.util.logging.manager Any jvm properties may explicitly be passed by the setVMArgs method. |
Constructor Summary | |
---|---|
ServiceDeployTask()
|
Method Summary | |
---|---|
void |
execute()
This launches the serviceDeploy application in a child jvm, configured according to the user-specified attributes. |
void |
setClassPath(java.lang.String classPath)
The classPath attribute is optional and is used to specify additional archives (jar, rar, or zip) that must be added to the classpath to successfully generate the J2EE application. |
void |
setClean(boolean clean)
The clean attribute is optional and is passed to eclipse so that eclipse will regenerate its plugin configuration. |
void |
setCleanStagingModules(boolean cleanStagingModules)
The cleanStagingModules attribute is optional and controls whether imported staging modules should be deleted before running the deployer. |
void |
setDebug(java.lang.String debug)
The debug attribute is optional and may be used to specify a .options file to enable tracing . |
void |
setFileEncoding(java.lang.String fileEncoding)
Deprecated. set the -Dfile.encoding jvm parameter instead |
void |
setFreeForm(boolean freeForm)
The freeForm attribute is optional and controls whether jsp and html files will be copied from the optional j2ee folder of an sca jar file and copied to the generated war file. |
void |
setIgnoreErrors(boolean ignoreErrors)
The ignoreErrors attribute is optional and indicates whether an ear file should be exported despite compile or validation errors. |
void |
setInternalOptions(java.lang.String internalOptions)
|
void |
setJavaDebug(java.lang.String javaDebug)
Deprecated. no longer applicable |
void |
setKeep(boolean keep)
The keep attribute is optional and controls whether the generated workspace should be preserved when the deployer task is complete. |
void |
setLibraryMode(boolean libraryMode)
The libraryMode attribute is optional and controls whether serviceDeploy allows a stand-alone library as input. |
void |
setNoJ2EEDeploy(boolean noJ2EEDeploy)
Deprecated. no longer applicable |
void |
setNoJavaSource(boolean noJavaSource)
Deprecated. no longer applicable |
void |
setNoValidate(boolean noValidate)
The noValidate attribute is optional and may be used to specify whether validation should be skipped. |
void |
setOutputApplication(java.lang.String outputApplication)
The outputApplication attribute is optional and controls the path and name of the generated ear file. |
void |
setProgressMonitor(java.lang.String progressMonitor)
Deprecated. no longer applicable |
void |
setScaModule(java.lang.String scaModule)
The scaModule attribute is mandatory and is the only required attribute for the serviceDeploy task. |
void |
setSkipXsdValidate(boolean skipXsdValidate)
The skipXsdValidate attribute is optional and may be used to specify whether XSD and WSDL validation should be skipped. |
void |
setUniqueCellID(java.lang.String uniqueCellID)
The uniqueCellID attribute is optional and may be used to create a unique instance of the application. |
void |
setVmArgs(java.lang.String vmArgs)
The vmArgs attribute is optional and may be used to specify jvm arguments for the deploy process. |
void |
setWasHome(java.lang.String home)
The wasHome attribute is optional if WAS_HOME/bin/ws_ant is used to run ANT. |
void |
setWorkingDirectory(java.lang.String workingDirectory)
The workingDirectory attribute is optional and controls where the directory in which serviceDeploy will generate a temporary workspace. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String[] excluded_props
excluded_props
field:java.assistive, java.runtime.name, sun.boot.library.path, java.vm.version, java.vm.vendor, java.vendor.url, path.separator, java.vm.name, user.country, sun.os.patch.level, java.vm.specification.name, user.dir, java.runtime.version, java.fullversion, java.awt.graphicsenv, java.endorsed.dirs, os.arch, com.ibm.vm.bitmode, java.io.tmpdir, line.separator, java.vm.specification.vendor, user.variant, java.awt.fonts, os.name, sun.java2d.fontpath, java.library.path, java.specification.name, java.class.version, invokedviajava, java.util.prefs.PreferencesFactory, os.version, user.home, user.timezone, java.awt.printerjob, java.specification.version, java.class.path, user.name, java.vm.specification.version, java.home, sun.arch.data.model, user.language, java.specification.vendor, awt.toolkit, java.vm.info, java.version, sun.boot.class.path, java.vendor, file.separator, java.vendor.url.bug, java.compiler, java.util.logging.configureByServer, java.util.logging.managerAny jvm properties may explicitly be passed by the setVMArgs method.
setVmArgs(java.lang.String)
Constructor Detail |
---|
public ServiceDeployTask()
Method Detail |
---|
public void execute() throws BuildException
BuildException
org.apache.tools.ant.Task#execute()
public void setScaModule(java.lang.String scaModule)
scaModule
- The scaModule to set.public void setClassPath(java.lang.String classPath)
classPath
- A semi-colon delimited list of jar, rar, and zip files that are required on the deploy classpathpublic void setFreeForm(boolean freeForm)
freeForm
- A boolean indicating whether the temporary workspace should be preserved.public void setIgnoreErrors(boolean ignoreErrors)
ignoreErrors
- A boolean indicating whether an ear file should be generated despite reported compilation or validation errors.public void setCleanStagingModules(boolean cleanStagingModules)
cleanStagingModules
- A boolean indicating whether the staging modules should be deleting and regenerated during deployment.public void setKeep(boolean keep)
keep
- A boolean indicating whether the temporary workspace should be retained following deployment.public void setNoJ2EEDeploy(boolean noJ2EEDeploy)
noJ2EEDeploy
- public void setNoJavaSource(boolean noJavaSource)
noJavaSource
- public void setOutputApplication(java.lang.String outputApplication)
outputApplication
- The fully-qualified path for the generated application.public void setProgressMonitor(java.lang.String progressMonitor)
progressMonitor
- public void setUniqueCellID(java.lang.String uniqueCellID)
uniqueCellID
- Unique ID in the context of the cell that is used to create a unique instance of the application.public void setWorkingDirectory(java.lang.String workingDirectory)
workingDirectory
- The location at which the temporary workspace should be generated.public void setFileEncoding(java.lang.String fileEncoding)
fileEncoding
- public void setDebug(java.lang.String debug)
debug
- The file that contains trace enablement settings.public void setJavaDebug(java.lang.String javaDebug)
debug
- public void setClean(boolean clean)
clean
- A boolean indicating whether the eclipse plugin configuration should be recalculated.public void setSkipXsdValidate(boolean skipXsdValidate)
skipXsdValidate
- public void setNoValidate(boolean noValidate)
noValidate
- A boolean indicating whether validation should be skipped.public void setLibraryMode(boolean libraryMode)
noValidate
- A boolean indicating that the input is a library.public void setVmArgs(java.lang.String vmArgs)
setVmArgs("-Xms128m -Dsome.property=true");
vmArgs
- A space-delimited list of java properties.public void setInternalOptions(java.lang.String internalOptions)
public void setWasHome(java.lang.String home)
home
- The location of the WebSphere Process Server used to run this deploy task.
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |