Network Deployment (Distributed operating systems), v8.0 > Reference > Command-line utilities
wsimport command for JAX-WS applications
The wsimport command-line tool processes an existing Web Services Description Language (WSDL) file and generates the required artifacts for developing Java API for JAX-WS web service applications. The generated artifacts are Java 5 compliant, making them portable across different Java versions and platforms.
The wsimport command-line tool supports the top-down approach to developing JAX-WS web services. When you start with an existing WSDL file, use the wsimport command-line tool to generate the required JAX-WS artifacts.
The wsimport, wsgen, schemagen and xjc command-line tools are not supported on the z/OS platform. This functionality is provided by the assembly tools provided with WAS running on the z/OS platform. Read about these command-line tools for JAX-WS applications to learn more about these tools.
WAS provides Java API for XML-Based Web Services (JAX-WS) and Java Architecture for XML Binding (JAXB) tooling. The wsimport, wsgen, schemagen and xjc command-line tools are located in...
WAS_HOME\bin\Similar tooling is provided by the Java SE Development Kit (JDK) 6. On some occasions, the artifacts generated by both the tooling provided by WAS and the JDK support the same levels of the specifications. In general, the artifacts generated by the JDK tools are portable across other compliant runtime environments. However, it is a best practice to use the tools provided with this product to achieve seamless integration within the WAS environment and to take advantage of the features that may be only supported in WAS.
To take advantage of JAX-WS and JAXB V2.2 tooling, use the tools provided with the application server that are located in the WAS_HOME\bin\ directory.
The wsimport tool reads an existing WSDL file and generates the following artifacts:
- Service Endpoint Interface (SEI) - The SEI is the annotated Java representation of the WSDL file for the web service. This interface is used for implementing JavaBeans endpoints or creating dynamic proxy client instances.
- javax.xml.ws.Service extension class - This is a generated class that extends the javax.xml.ws.Service class. This class is used to configure and create both dynamic proxy and dispatch instances.
- required data beans, including any Java Architecture
for XML Binding (JAXB) beans that are required to model the web service data.
We can package the generated artifacts in a web application archive (WAR) file with the WSDL file and schema files along with the endpoint implementation to be deployed.
To correctly use the wsimport tool, adhere to the following requirements:
- We must define all your services within the main WSDL file. Services
that are defined within an imported WSDL file are not processed by the wsimport tool.
- If you run the wsimport tool on a WSDL file that implements a Document or Literal style pattern, the complexTypes
elements that define the input and output types must be composed of unique names to prevent naming conflicts in the parameter list for the operation..
- If you run the wsimport tool and pass a ?wsdl Uniform
Resource Identifier (URI) as a parameter for a WSDL file, ensure that you are using the actual resolved WSDL URI. The wsimport tool
correctly resolves the ?wsdl URI, but other relative
URIs that are referenced might not resolve correctly.
In addition to using the tools from the command line, you can invoke these JAX-WS tools from within the Ant build environments. Use the com.sun.tools.ws.ant.WsImport Ant task from within the Ant build environment to invoke the wsimport tool.
To function properly, this Ant task requires that you invoke Ant using the ws_ant script.
The command-line syntax is:
(Windows)
WAS_HOME\bin\wsimport.bat [options] WSDL_URI(AIX)
(Solaris)
WAS_HOME/bin/wsimport.sh [options] WSDL_URI
Parameters
The WSDL_URI is the only parameter that is required. The following parameters are optional for the wsimport command:
The wsimport tool does not set the @WebService.wsdlLocation value either by default or when the -wsdlLocation attribute is specified. The wsimport command-line tool updates the @WebServiceClient.wsdlLocation annotation only. You can manually update the @WebService.wsdlLocation annotation with a relative URL that specifies the location of the Web Services Description Language (WSDL) file. If the @WebService.wsdlLocation annotation is present on an endpoint implementation class, then the value must be a relative URL and the WSDL document that it references must be packaged with the application. If you specify an HTTPS URL for the -wsdlLocation parameter, the wsimport tool generates a service class with a no-argument constructor that is not valid. Avoid using the no-argument service constructor to instantiate your service. Instead, pass the HTTPS URL to one of the service class constructors that takes a WSDL URL for an argument; for example:
MyService("https://example.ibm.com/My?wsdl");
Assembly tools
Generate Java artifacts for JAX-WS applications from a WSDL file
Implement web services applications with JAX-WS
Related
wsgen command for JAX-WS applications
xjc command for JAXB applications
Web services specifications and APIs
Java API for XML Web Services (JAX-WS) API documentation
Java API for XML Web Services (JAX-WS) 2.2 Tools Reference implementation