was6:servicedeploy

Full name:

org.codehaus.mojo:was6-maven-plugin:1.2.1:servicedeploy

Description:

Executes the ServiceDeploy command against an archive file (Ear, Zip or Jar) to produce an ear file that can be deployed on Process Server.

Reference Documentation can be found IBM WebSphere Enterprise Service Bus, Version 6.1, IBM WebSphere Process Server, Version 6.1.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
scaModule File - The scaModule attribute is required and specifies the .jar, .zip or .ear file that contains the application to be deployed. If the command is not issued from the path in which the file resides, this must be the full path for the file. The .zip file can be either a nested archive that contains jars of Libraries or Modules or it can be an Eclipse Project Interchange format file.
wasHome File - Root install location of WebSphere 6.1
Default value is: ${env.WAS_HOME}.
workingDirectory File - Working directory for plugin.

Optional Parameters

Name Type Since Description
classPath String - The classPath attribute is optional and controls which external archives (jar, rar, and zip) should be appended to the classpath. By default, no external archives are used during deployment.
clean boolean - The clean attribute attribute is optional and is passed to eclipse so that eclipse will regenerate its stored plugin configuration.
cleanStagingModules boolean - The cleanStagingModules attribute is optional and controls whether imported staging modules should be deleted before running the deployer. By default, imported staging modules are not deleted.
debug File - The file that contains plugin-specific trace enablement settings. The debug attribute is optional and may be used to specify a trace .options file to enable eclipse-based tracing.
failOnError boolean - Fail build on errors.
Default value is: true.
fileEncoding String - The fileEncoding attribute is optional and specifies the default file encoding that should be used by eclipse.
freeForm boolean - 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. By default, jsp and html files are not copied into the war file.
ignoreErrors boolean - The ignoreErrors attribute is optional and controls whether an ear file should be generated despite validation errors. By default, an ear file will not be generated if validation errors were flagged during deployment.
javaDebug File - The file that contains plugin-specific trace enablement settings. The javaDebug attribute is optional and may be used to indicate that all debug information should be included in generated class files.
keep boolean - The keep attribute is optional and controls whether the generated eclipse workspace should be preserved when the deployer task is complete. By default, the generated eclipse workspace is deleted after deployment.
logFile File - Optional log file to log execution of ws_ant to.
noJ2EEDeploy boolean - The noJ2EEDeploy attribute is optional and controls whether the J2EE deployers, including ejbDeploy, should be skipped during deployment. The J2EE deployers will execute by default.
outputApplication File - The outputApplication attribute is optional and controls the name and location of the generated J2EE ear file. If this attribute is not specified, then the ear file will be named according to the sca module name and will be generated in the location from which the ANT process was launched.
Default value is: ${project.artifact.file}.
progressMonitor String - The progressMonitor attribute is optional and controls how progress should be displayed to the console. Legal values include none, meter, or message. The default progressMonitor is none.
Default value is: none.
retryCount int 1.2 Some operations can often fail due to internal errors in the J2EE EJB deployment stage. Aditionally, the WsAdmin mojo can equally fail due to connection issues. These errors are intermittent and suprious. Simply reruning it will often fix the error (assuming there is no real underlying error). Issues arise however, if this occurs in a release - the release will be unnecessarilly aborted. This variable is designed to allow a number of retries to avoid this issue.
Default value is: 0.
skip boolean 1.1.1 Skip execution.
Default value is: false.
skipXsdValidate boolean - The skipXsdValidate attribute is optional and specifies that the XSD schema validation will be skipped. This parameter is not available in the base product, as it was introduced in a later fixpack as a workaround for various issues.
traceFile File - Optional file to log trace to.
verbose boolean - Specifies a verbose execution to help debug.
Default value is: false.
vmArgs String - The vmArgs attribute is optional and may be used to specify jvm arguments for the deploy process. They are space separated.

Parameter Details

classPath:

The classPath attribute is optional and controls which external archives (jar, rar, and zip) should be appended to the classpath. By default, no external archives are used during deployment.
  • Type: java.lang.String
  • Required: No

clean:

The clean attribute attribute is optional and is passed to eclipse so that eclipse will regenerate its stored plugin configuration.
  • Type: boolean
  • Required: No

cleanStagingModules:

The cleanStagingModules attribute is optional and controls whether imported staging modules should be deleted before running the deployer. By default, imported staging modules are not deleted.
  • Type: boolean
  • Required: No

debug:

The file that contains plugin-specific trace enablement settings. The debug attribute is optional and may be used to specify a trace .options file to enable eclipse-based tracing.
  • Type: java.io.File
  • Required: No

failOnError:

Fail build on errors.
  • Type: boolean
  • Required: No
  • Expression: ${was6.failOnError}
  • Default: true

fileEncoding:

The fileEncoding attribute is optional and specifies the default file encoding that should be used by eclipse.
  • Type: java.lang.String
  • Required: No
  • Expression: ${project.build.sourceEncoding}

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. By default, jsp and html files are not copied into the war file.
  • Type: boolean
  • Required: No

ignoreErrors:

The ignoreErrors attribute is optional and controls whether an ear file should be generated despite validation errors. By default, an ear file will not be generated if validation errors were flagged during deployment.
  • Type: boolean
  • Required: No

javaDebug:

The file that contains plugin-specific trace enablement settings. The javaDebug attribute is optional and may be used to indicate that all debug information should be included in generated class files.
  • Type: java.io.File
  • Required: No

keep:

The keep attribute is optional and controls whether the generated eclipse workspace should be preserved when the deployer task is complete. By default, the generated eclipse workspace is deleted after deployment.
  • Type: boolean
  • Required: No

logFile:

Optional log file to log execution of ws_ant to.
  • Type: java.io.File
  • Required: No
  • Expression: ${was6.logFile}

noJ2EEDeploy:

The noJ2EEDeploy attribute is optional and controls whether the J2EE deployers, including ejbDeploy, should be skipped during deployment. The J2EE deployers will execute by default.
  • Type: boolean
  • Required: No

outputApplication:

The outputApplication attribute is optional and controls the name and location of the generated J2EE ear file. If this attribute is not specified, then the ear file will be named according to the sca module name and will be generated in the location from which the ANT process was launched.
  • Type: java.io.File
  • Required: No
  • Expression: ${was6.outputApplication}
  • Default: ${project.artifact.file}

progressMonitor:

The progressMonitor attribute is optional and controls how progress should be displayed to the console. Legal values include none, meter, or message. The default progressMonitor is none.
  • Type: java.lang.String
  • Required: No
  • Default: none

retryCount:

Some operations can often fail due to internal errors in the J2EE EJB deployment stage. Aditionally, the WsAdmin mojo can equally fail due to connection issues. These errors are intermittent and suprious. Simply reruning it will often fix the error (assuming there is no real underlying error). Issues arise however, if this occurs in a release - the release will be unnecessarilly aborted. This variable is designed to allow a number of retries to avoid this issue.
  • Type: int
  • Since: 1.2
  • Required: No
  • Expression: ${was6.retryCount}
  • Default: 0

scaModule:

The scaModule attribute is required and specifies the .jar, .zip or .ear file that contains the application to be deployed. If the command is not issued from the path in which the file resides, this must be the full path for the file. The .zip file can be either a nested archive that contains jars of Libraries or Modules or it can be an Eclipse Project Interchange format file.
  • Type: java.io.File
  • Required: Yes

skip:

Skip execution.
  • Type: boolean
  • Since: 1.1.1
  • Required: No
  • Expression: ${was6.skip}
  • Default: false

skipXsdValidate:

The skipXsdValidate attribute is optional and specifies that the XSD schema validation will be skipped. This parameter is not available in the base product, as it was introduced in a later fixpack as a workaround for various issues.
  • Type: boolean
  • Required: No

traceFile:

Optional file to log trace to.
  • Type: java.io.File
  • Required: No
  • Expression: ${was6.traceFile}

verbose:

Specifies a verbose execution to help debug.
  • Type: boolean
  • Required: No
  • Expression: ${was6.verbose}
  • Default: false

vmArgs:

The vmArgs attribute is optional and may be used to specify jvm arguments for the deploy process. They are space separated.
  • Type: java.lang.String
  • Required: No

wasHome:

Root install location of WebSphere 6.1
  • Type: java.io.File
  • Required: Yes
  • Expression: ${was6.wasHome}
  • Default: ${env.WAS_HOME}

workingDirectory:

Working directory for plugin.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/was6-maven-plugin