serviceDeploy command

Use the serviceDeploy command to install Service Component Architecture (SCA) compliant modules on a server without using the administrative console. The command is useful when performing batch installs.

Purpose

The serviceDeploy command builds an .ear file from a .jar or .zip file that contains service components.
Note: Parameters are not case-sensitive.

Roles

This command can be issued by users with the following roles:
  • Administrator
  • Deployer

Syntax

Read syntax diagramSkip visual syntax diagram
>>-serviceDeploy----inputarchive-------------------------------->

>--+--------------------------------+--------------------------->
   '- -workingDirectory----temppath-'   

>--+------------------------------------------------+----------->
   '- -outputApplication----+-inputarchiveApp.ear-+-'   
                            '-outputpathname.ear--'     

>--+----------------+--+------------+--------------------------->
   '- -noJ2eeDeploy-'  '- -freeform-'   

>--+-----------------------+--+--------+--+----------------+---->
   '- -cleanStagingModules-'  '- -keep-'  '- -ignoreErrors-'   

>--+----------------------------------------------------+------->
   '- -classpath----jarpathname--;--rarpathname--;--...-'   

>--+---------------------------+--+--------+-------------------><
   '- -fileEncoding----charset-'  '- -help-'   

Parameters

inputarchive
A required, positional parameter that 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 or an Eclipse ProjectInterchange format file.
-classpath
An optional parameter that specifies the locations of required resource files (.jar and .rar) files. The path to each file should be a fully-qualified path separated by semicolons (;) with no spaces.
-fileEncoding
An optional parameter that specifies the character set (charset) required if the application you are deploying uses a charset other than one supported by the Java™ virtual machine's (JVM) default file encoding.
Note: On z/OS®, the serviceDeploy command always uses ASCII as the default file encoding.

For example, if the application contains a business rule table that contains Japanese characters, you must specify a charset (such as UTF-8) that supports double-byte characters to prevent data corruption in the generated Java and class files.

Valid values for -fileEncoding are located at http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/Charset.html.

If not specified, this parameter defaults to the default character set supported by the Java development kit (JDK).

Important: This parameter only affects files generated by serviceDeploy. Existing files retain their current encoding.
Restriction: If you specify a charset not supported by the operating system that is running the serviceDeploy command, the system processes the archive as if you had not specified -fileEncoding and messages are written to the system log.
-freeform
An optional parameter that specifies that the J2EE subdirectory in the service.jar should be treated as a free-form project.
-help
An optional parameter used to display the parameters for this command.
-ignoreErrors
An optional parameter that specifies that the serviceDeploy command builds an .ear file regardless of errors while building or validating the application. By default, the serviceDeploy command does not generate an .ear file if there are errors with an application.
-cleanStagingModules
An optional parameter that specifies whether to delete staging modules within an input .ear file before deployment. By default, the serviceDeploy command imports existing staging modules and their contents.
-keep
An optional parameter that specifies whether to save any temporary files generated after deployment. By default, the serviceDeploy command deletes the temporary workspace.
-noJ2eeDeploy
An optional parameter that specifies whether the application requires EJB deployment after generating the .ear file. By default, the serviceDeploy command runs the J2EE deployers for the application.
-outputApplication
An optional parameter that specifies the name of the .ear file the serviceDeploy command creates. The default is inputarchiveApp.ear, where inputarchive is the filename minus the extension specified for the input .jar file.
-outputApplicationMigratedApp.ear
An optional parameter that specifies that the input archive was a .jar file migrated from a WebSphere® Interchange Server.
-workingDirectory
An optional parameter that specifies a directory the serviceDeploy command uses to write temporary files.

Inputs

The following file types can be used as input to the serviceDeploy command:
jar
The most useful file type for the simplest applications. The resulting ear file contains a single jar and any needed generated staging modules. The jar must contain the service.module file.
zip (Project Interchange)
You can export from WebSphere Integration Developer an archive file in project interchange format. This format is unique to the Eclipse development. The exported zip file must contains exactly one project with the service.module file. The resulting ear file contains any number of modules, depending upon exactly what is in the project interchange.
zip
You can create a zip file containing jar files, war files, and rar files. Exactly one jar file must contain the service.module file. All contained archives become members of the final exported ear file.
ear
You can always run the serviceDeploy command against an ear file as long as exactly one jar file in the ear contains a service.module file.

Output

When serviceDeploy completes processing, it creates an .ear file in the directory from which the command is run unless the -outputApplication parameter is specified.

Exceptions

N/A

Example of serviceDeploy command

The following command example:
servicedeploy MyValueModule.jar 
-classpath "c:\java\myvaluemoduleres.rar;c:\java\commonres.jar"
-noj2eedeploy -freeform true -keep

Last updated: Tue 24 Oct 2006 09:37:07

(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)