Generating Java artifacts for JAX-WS applications

Use JAX-WS tools to generate the necessary JAX-WS and JAXB Java artifacts that are needed for JAX-WS Web services applications when starting from Java Beansor enterprise beans components.

To develop a JAX-WS Web service application, first develop a service endpoint interface (SEI) implementation that explicitly or implicitly describes the SEI.

When using a bottom-up approach to develop JAX-WS Web services, use the wsgen command-line tool on the existing service endpoint implementation. The wsgen tool processes a compiled service endpoint implementation class as input and generates the following portable artifacts:

• JAXB classes that are required to marshal and unmarshal the message contents.

• a WSDL file if the optional -wsdl argument is specified.

Supported configurations: 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.

You are not required to develop a WSDL file when developing JAX-WS Web services using the bottom-up approach of starting with Java Beans. The use of annotations provides all of the WSDL information necessary to configure the service endpoint or the client. The appserver supports WSDL 1.1 documents that comply with WS-I Basic Profile 1.1 specifications and are either Document/Literal style documents or RPC/Literal style documents. Additionally, WSDL documents with bindings that declare a USE attribute of value LITERAL are supported while the value, ENCODED, is not supported. For WSDL documents that implement a Document/Literal wrapped pattern, a root element is declared in the XML schema and is used as an operation wrapper for a message flow. Separate wrapper element definitions exist for both the request and the response.

To ensure the wsgen command does not miss inherited methods on a service endpoint implementation bean, either add the @WebService annotation to the desired superclass or we can override the inherited method in the implementation class with a call to the superclass method. Implementation classes only expose methods from superclasses that are annotated with the @WebService annotation.

Although a WSDL file is typically optional when developing a JAX-WS service implementation bean, it is required if the JAX-WS endpoints are exposed using the SOAP over JMS transport and we are publishing the WSDL file. If developing an enterprise Java Beans service implementation bean that is invoked using the SOAP over JMS transport, and you want to publish the WSDL so that the published WSDL file contains the fully resolved JMS endpoint URL, then have wsgen tool generate the WSDL file by specifying the -wsdl argument. In this scenario, package the WSDL file with the Web service application.

 

1. Locate the service endpoint implementation class file.

2. Run the wsgen command to generate the portable artifacts. The wsgen tool is located in...

   APP_ROOT\bin\

   (Windows)

   APP_ROOT\bin\wsgen.bat [options] service_implementation_class
   

   
   [AIX] [HP-UX] [Linux] [Solaris]

   APP_ROOT/bin/ wsgen.sh [options] service_implementation_class
   

   (Optional) Use the following options with the wsgen command:

   • Use the -verbose option to see a list of generated files along with additional informational messages.

   • Use the -keep option to keep generated Java files.

   • Use the -wsdl option to generate a WSDL file. If developing a service implementation bean that will be invoked using the HTTP transport, then the WSDL file generated by the wsgen command-line tool during this step is optional. However, if we are developing a service implementation bean that will be invoked using the SOAP over JMS transport, then the WSDL file generated by the wsgen tool during this step is required in subsequent developing JAX-WS applications steps, so it is not optional.

   Read about wsgen to learn more about this command and additional options that we can specify.

 

Results

we have the required Java artifacts to create a JAX-WS Web service.

Avoid trouble: The wsgen command does not differentiate the XML namespace between multiple XMLType annotations that have the same @XMLType name defined within different Java packages. When this scenario occurs, the following error is produced:

Error: Two classes have the same XML type name .... Use @XmlType.name and @XmlType.namespace to assign different names to them...

This error indicates we have class names or @XMLType.name values that have the same name, but exist within different Java packages. To prevent this error, add the @XML.Type.namespace class to the existing @XMLType annotation to differentiate between the XML types.

 

Example

The following example demonstrates how to use the wsgen command to process the service endpoint implementation class to generate JAX-WS artifacts. This example EchoService service implementation class uses an explicit Java Beans service endpoint.

1. Copy the sample EchoServicePortTypeImpl service implementation class file and the associated EchoServicePortType service interface class file into a directory. The directory must contain a directory tree structure that corresponds to the com.ibm.was.wssample.echo package name for the class file.

   /* This is a sample EchoServicePortTypeImpl.java file.    */ package com.ibm.was.wssample.echo;
   
   
   @javax.jws.WebService(serviceName = "EchoService", endpointInterface = 
   "com.ibm.was.wssample.echo.EchoServicePortType",  targetNamespace="http://com/ibm/was/wssample/echo/", portName="EchoServicePort")
    public class EchoServicePortTypeImpl implements EchoServicePortType {
   
     public EchoServicePortTypeImpl() {
     }
   
     public String invoke(String obj) {
       System.out.println(">> JAXB Provider Service:  Request received.\n");
       String str = "Failed";
       if (obj != null) {
         try {
           str = obj;
         } catch (Exception e) {
           e.printStackTrace();
         }
       }
       return str;
   
     }
   
   }  
   

   /* This is a sample EchoServicePortType.java file.    */ package com.ibm.was.wssample.echo;
    import javax.jws.WebMethod;
    import javax.jws.WebParam;
    import javax.jws.WebResult;
    import javax.jws.WebService;
    import javax.xml.ws.RequestWrapper;
    import javax.xml.ws.ResponseWrapper;
   
   
   @WebService(name = "EchoServicePortType", targetNamespace = 
   "http://com/ibm/was/wssample/echo/", 
    wsdlLocation="WEB-INF/wsdl/Echo.wsdl")
    public interface EchoServicePortType {
   
   
       /**
        * 
        * @param arg0
        * @return
        *     returns java.lang.String
        */
       @WebMethod
       @WebResult(name = "response", targetNamespace = 
       "http://com/ibm/was/wssample/echo/")
       @RequestWrapper(localName = "invoke", targetNamespace = 
       "http://com/ibm/was/wssample/echo/", 
        className = "com.ibm.was.wssample.echo.Invoke")
       @ResponseWrapper(localName = "echoStringResponse", 
        targetNamespace = "http://com/ibm/was/wssample/echo/", 
        className = "com.ibm.was.wssample.echo.EchoStringResponse")
       public String invoke(
           @WebParam(name = "arg0", targetNamespace = 
           "http://com/ibm/was/wssample/echo/")
           String arg0);
   
   }
   
   

2. Run the wsgen command from the APP_ROOT\bin\ directory. The -cp option specifies the location of the service implementation class file. The -s option specifies the directory for the generated source files. The -d option specifies the directory for the generated output files. When using the -s or -d options, first create the directory for the generated output files.

   (Windows)

   APP_ROOT\bin\wsgen.bat -wsdl -s c:\generated_source\ -cp c:\my_application\classes\ com.ibm.was.wssample.echo.EchoServicePortTypeImpl -verbose -d c:\generated_artifacts\

   [Linux] [AIX] [HP-UX] [Solaris]

   Run the wsgen command; for example:

   APP_ROOT/bin/wsgen.sh -wsdl -s c:/generated_source/ -cp c:/my_application/classes/ com.ibm.was.wssample.echo.EchoServicePortTypeImpl -verbose -d c:/generated_artifacts/

After generating the Java artifacts using the wsgen command, the following files are generated:

/generated_source/com/ibm/was/wssample/echo/EchoStringResponse.java
/generated_source/com/ibm/was/wssample/echo/Invoke.java
/generated_artifacts/EchoService.wsdl
/generated_artifacts/EchoService_schema1.xsd
/generated_artifacts/com/ibm/was/wssample/echo/EchoStringResponse.class
/generated_artifacts/com/ibm/was/wssample/echo/Invoke.class

The EchoStringResponse.java and Invoke.java files are the generated Java class files. The compiled versions of the generated Java files are EchoStringResponse.class and Invoke.class files. The EchoService.wsdl and EchoService_schema1.xsd files are generated because the -wsdl option was specified.

 

Next steps

Complete the implementation of the JAX-WS Web service application.

wsgen command for JAX-WS applications
Mapping between Java language, WSDL and XML for JAX-WS applications

 

Related concepts

JAX-WS
WSDL
Assembly tools

 

Related tasks

Implementing Web services applications with JAX-WS
Develop a JAX-WS service endpoint implementation with annotations
Completing the Java Beans implementation for JAX-WS applications
Completing the EJB implementation for JAX-WS applications
Use SOAP over Java Message Service to transport Web services

 

Related information

Web services specifications and APIs
Java API for XML Web Services (JAX-WS) API documentation