wsdeploy command

This page explains how to use the wsdeploy command-line tool with Web services. The wsdeploy command adds WebSphere product-specific deployment classes to a Web services-compatible enterprise application enterprise archive (EAR) file or an application client JAR file.

The wsdeploy command is supported by JAX-RPC applications. The JAX-WS model that is implemented by the application server does not support the wsdeploy command. If wer Web services application contains only JAX-WS endpoints, you do not need to run the wsdeploy command, as this command is used to process only JAX-RPC endpoints.

The deployment classes that are added by the wsdeploy tool to a Web services-compatible EAR file or a JAR file include:

• Stubs

• Serializers and deserializers

• Implementations of service interfaces

This deployment step must be performed at least once, and can be performed more often. Deployment can be performed separately using the wsdeploy command, assembly tools, or when the application is installed. When using the wsadmin command for installation, specify the -deployws option.

The wsdeploy command operates as noted in the following list:

• Each module in the enterprise application or JAR file is examined.

• If the module contains Web services implementations, indicated by the presence of the webservices.xml deployment descriptor, the associated WSDL files are located and the WSDL2Java command is run with the role deploy-server option.

• If the module contains Web services clients, indicated by the presence of the client deployment descriptor, the associated WSDL files are located and the WSDL2Java command is run with the role deploy-client option.

• The files generated by the WSDL2Java command are compiled and repackaged.

See WSDL2Java for more information about the files that are generated for deployment.

When the generated files are compiled, they can reference application-specific classes outside the EAR or JAR file, if the EAR or JAR file is not self-contained. In this case, use either the -jardir or -cp option to specify additional JAR or zip files to be added to CLASSPATH variable when the generated files are compiled.

 

wsdeploy command syntax

The command syntax is noted in the following example:

wsdeploy Input_filename Output_filename [options] 

Required options:

• Input_filename

  Path to the EAR or JAR file to deploy.

• Output_filename

  Path of the deployed EAR or JAR file. If output_filename already exists, it is silently overwritten. The output_filename can be the same as the input_filename.

Other options:

• -jardir directory

  Directory that contains JAR or zip files. All JAR and zip files in this directory are added to the CLASSPATH used to compile the generated files. This option can be specified zero or more times.

• -cp entries

  Specifies entries to add to the CLASSPATH when the generated classes are compiled. Multiple entries are separated the same as they are in the CLASSPATH environment variable.

• -codegen

  Specifies to generate but not compile deployment code. This option implicitly specifies the -keep option.

• -debug

  Includes debugging information when compiling, that is, use javac -g to compile.

• -help

  Displays a help message and exit.

• -ignoreerrors

  Do not stop deployment if validation or compilation errors are encountered.

• -keep

  Do not delete working directories containing generated classes. A message is displayed indicating the name of the working directory that is retained.

• -novalidate

  Do not validate the Web services deployment descriptors in the input file.

• -trace

  Displays processing information, including the names of the generated files.

Example

The following example illustrates how the options are used with the wsdeploy command:

wsdeploy x.ear x_deployed.ear -trace -keep   Processing web service module x_client.jar.    Keeping directory: f:\temp\Base53383.tmp for module: x_client.jar.    Parsing XML file:f:\temp\Base53383.tmp\WarDeploy.wsdl    Generating f:\temp\Base53383.tmp\generatedSource\com\test\WarDeploy.java    Generating f:\temp\Base53383.tmp\generatedSource\com\test\WarDeployLocator.java    Generating f:\temp\Base53383.tmp\generatedSource\com\test\HelloWsBindingStub.java    Compiling f:\temp\Base53383.tmp\generatedSource\com\test\WarDeploy.java.    Compiling f:\temp\Base53383.tmp\generatedSource\com\test\WarDeployLocator.java.    Compiling f:\temp\Base53383.tmp\generatedSource\com\test\HelloWsBindingStub.java.    Done processing module x_client.jar.  

Messages

• Flag -f is not valid.

  Option f was not recognized as a valid option.

• Flag -c is ambiguous.

  Options can be abbreviated, but the abbreviation must be unique. In this case, the wsdeploy command cannot determine which option was intended.

• Flag -c is missing parameter -p.

  A required parameter for an option is omitted.

• Missing p parameter.

  A required option is omitted.

Related concepts

Assembly tools

Related tasks

Deploy Web services applications onto appservers

Related

WSDL2Java command for JAX-RPC applications