wsimport - Java™ API for XML Web Services (JAX-WS) 2.0
Specification Version: 2.1
Implementation Version: 2.1.1
Contents
Overview
The wsimport tool generates JAX-WS portable artifacts, such as:
- Service Endpoint Interface (SEI)
- Service
- Exception class mapped from wsdl:fault (if any)
- Async Reponse Bean derived from response wsdl:message (if any)
- JAXB generated value types (mapped java classes from schema types)
These artifacts can be packaged in a WAR file with the WSDL and schema documents
along with the endpoint implementation to be deployed. also provides wsimport ant task,
see Wsimport
ant task.
Launching wsimport
- Solaris/Linux
/bin/wsimport.sh -help
- Windows
\bin\wsimport.bat -help
Syntax
wsimport [options] <wsdl>
The following table lists the wsimport options.
| Option |
Description |
|---|---|
-d <directory> |
Specify where to place generated output files |
-b <path> |
Specify external JAX-WS or JAXB binding files (Each
|
-B <jaxbOption> |
Pass this option to JAXB schema compiler |
-catalog |
Specify catalog file to resolve external entity references, it supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the documentation of catalog and see catalog sample. |
-extension |
Allow vendor extensions (functionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations |
-help |
Display help |
-httpproxy:<host>:<port> |
Specify an HTTP proxy server (port defaults to 8080) |
-keep |
Keep generated files |
-p |
Specifying a target package via this command-line option, overrides any wsdl and schema binding customization for package name and the default package name algorithm defined in the specification |
-s <directory> |
Specify where to place generated source files |
-verbose |
Output messages about what the compiler is doing |
-version |
Print version information |
-wsdllocation <location> |
@WebServiceClient.wsdlLocation value |
-target |
Generate code as per the given JAX-WS specification version. version 2.0 will generate compliant code for JAX-WS 2.0 spec. |
-quiet |
Suppress wsimport output |
Multiple JAX-WS and JAXB binding files can be specified using -b
option and they can be used to customize various things like package names, bean
names, etc. More information on JAX-WS and JAXB binding files can be found in the
customization
documentation.
The following table lists wsimport non-standard options:
| Option |
Description |
|---|---|
-XadditionalHeaders |
Map headers not bound to request or response message to Java method parameters. |
-Xauthfile <file> |
WSDL URI that specifies the file that contains authorization information; this URI is in the following format: http://username:password@example.org/stock?wsdl |
-Xdebug |
Print debugging information. |
-Xno-addressing-databinding |
Enable binding of W3C |
-Xnocompile |
Do not compile generated Java files. |
Example
wsimport -p stockquote http://stockquote.xyz/quote?wsdl
This will generate the Java artifacts and compile them by importing the
http://stockquote.xyz/quote?wsdl.