WSDL2Java command for JAX-RPC applications

 

+

Search Tips   |   Advanced Search

 

A Web Services Description Language (WSDL) file describes a Web service.

JAX-RPC 1.1 defines a Java API mapping that interacts with the Web service.

The Web Services for J2EE 1.1 specification defines deployment descriptors that deploy a Web service in a J2EE environment.

The WSDL2Java command is run against the WSDL file to create Java APIs and deployment descriptor templates according to these specifications.

Review the API documentation for a complete list of API's.

 

Command-line syntax

The command-line syntax is:

WSDL2Java [arguments] WSDL-URI

 

Required arguments

• WSDL-URI

  Location of the input WSDL file using a URI. You can also use a regular file path if the WSDL file is on the local file system.

 

Important arguments

• -role j2ee role

  J2EE development role that identifies which files to generate. Valid arguments include:

  client	A combination of the develop-client and deploy-client arguments.
  deploy-client	Generates binding files for client deployment.
  deploy-server	Generates binding files for server deployment.
  develop-client (default)	Generates files for client development.
  develop-server	Generates files for server development.
  server	A combination of the develop-server and deploy-server arguments.

• -container j2ee-container

  J2EE container to use. Valid arguments include:

  client	Client container.
  ejb	EJB container.
  none	No container.
  web	Web container.

  For client roles (see the -role option), the default argument is none. For server roles, the container must be ejb or web. The same container option must be used for both development and deployment.

• -output directory

  Set the root directory for emitted files.

• -inputMappingFile mapping file

  File name of the Web Services for J2EE 1.1 mapping file.

• -introspect

  Uses existing Java beans with a new Web service API.

  In some scenarios, it is good to use existing Java classes instead of generating new classes. The -introspect option directs the WSDL2Java command to examine existing Java classes when generating classes. The existing classes are validated against the JAX-RPC specification. For example: Suppose you have an existing Java bean

   public class Bean 
  { 
      public Date x; 
  }
  
  

  The WSDL file defines x as xsd:dateTime.

  Without the -introspect option, the WSDL2Java command generates a Java bean that is similar to...

   public class Bean 
  {
    private Calendar x;
    public void setx(Calendar value) (x=value;)
    public Calendar getX() { return x;)
  }
  
  

  The WSDL2Java command uses the -introspect option to examine the original Java bean and to generate classes that are compatible with existing Java beans.

• -classpath paths

  Defines an alternative class path to search for Java classes.

• -noDataBinding

  Disables the binding of XML types to Java types. Instead, each XML type is mapped to a javax.xml.soap.SOAPElement interface defined by the SOAP with Attachments API for Java (SAAJ) specification.

  The JAX-RPC programming model supports SAAJ 1.2.

  The Java programming models define Java mappings for a subset of XML types. Several XML types cannot be mapped to Java beans or primitives. In this situation, the WSDL2Java command maps the type to an SAAJ SOAPElement. A SAAJ SOAPElement is a generic representation of the element in the message. The methods on the SOAPElement can be used to examine the element and its children.

  In some scenarios, it might be more appropriate to use the generic SOAPElement mapping exclusively. To read more about the use of SOAPElement see SOAP with Attachments API for Java and Custom data binders.

  Review the API documentation for a complete list of API's. You can also review several articles about the development of Web services at Web services: Resources for learning.

• -help

  Display a help message and exits.

• -helpX

  Display a help message for extended options. The options include:

• -verbose

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

• -NStoPkg namespace=package

  By default, package names are automatically derived from the namespace strings in the WSDL file. For example, if the namespace is of the form http://x.y.com or urn:x.y.com, the corresponding package is com.y.x.

  You can provide your own mapping by using the -NStoPkg argument, which you can repeat as often as necessary, once for each unique namespace mapping. For example, if a namespace in the WSDL file is called urn:AddressFetcher2, and you want files generated from the objects in this namespace to reside in the samples.addr package, provide the argument...

  -NStoPkg "http://urn:AddressFetcher2/"=samples.addr

  ...to the WSDL2Java command.

• -timeout seconds

  How long the WSDL2Java command waits, in seconds, for the WSDL-URI to respond before giving up. The default is 45 seconds; -1 disables the timeout.

• -genResolver

  Generates an absolute-import resolver class. The purpose of this class is to record the contents of the imported WSDL files that are used by the WSDL URI. This class is used by the run time and can also be used for future WSDL2Java command runs. This flexibility is desirable when the imported WSDL files are remote and possibly inaccessible. When an import resolver is used, the possibility that a remote WSDL file has different contents at run time that it did during development is eliminated. The generated class is named _AbsoluteImportResolver.java. Compile and package this class with the other Java classes that are generated by the WSDL2Java command.

• -useResolver resolver-class

  An absolute-import resolver class to use during parsing. This class must be created during a previous run of the WSDL2Java command that uses the -genResolver option. The class must be available in the CLASSPATH variable.

• -deployScope argument How to deploy the server implementation. Valid arguments include:

  Application	Uses one instance of the implementation class for all requests.
  Request	Creates a new instance of the implementation class for each request.
  Session	Creates a new instance of the implementation class for each session.

 

Other arguments

• -user id

  Login user name to access the WSDL URI.

• -password password

  Login user password to access the WSDL URI.

• -all

  Generates Java files for all types, even those that are not referenced.

• -debug

  Prints debugging information.

• -genJava argument Generates Java files. Valid arguments include:
  • IfNotExists, default
  • Overwrite
  • No

• -javaSearch argumentThe -javaSearch option is used with the -genJava option. If the -genJava IfNotExists, use the -javaSearch option to determine how file existence is detected.

  File (default)	Looks for a file in the output directory
  Classpath	Looks for a class in the CLASSPATH variable
  Both	Looks for a file in the output directory or in a class in the CLASSPATH variable

• -genXML argument Generates the .xml and .xmi files. Valid arguments are:
  • IfNotExists, default
  • Overwrite
  • No

• -genImplSer true or false

  Indicates that each generated Java bean implements the java.io.Serializable. The default is false.

• -genEquals true or false

  Indicates that each generated Java bean have equals and hashCode methods. The default is false.

• -noWrappedOperations

  Disables wrapped operations detection. Java beans for the request and response messages are generated.

• -noWrappedArrays

  Disables wrapped array detection.

• -fileNStoPkg file name

  File of the namespace to package mappings. The default is NStoPKG.properties.

• service wsdl service name

  Generates files for the installed WSDL service only.

• -testCase

  Generates the template for a JUnit test case for testing Web services. JUnit is a simple framework to write repeatable tests.

---

 

Related concepts

Custom data binders

 

Related tasks

Develop a service endpoint interface for JAX-RPC applications

 

Related Reference

Java2WSDL command for JAX-RPC applications
Map between Java language, WSDL and XML for JAX-RPC applications
Web services: Resources for learning