0N/A." Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
0N/A." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A." This code is free software; you can redistribute it
and/or modify it
0N/A." under the terms of the GNU General Public License version 2 only, as
0N/A." published by the Free Software Foundation.
0N/A." This code is distributed in the hope that it will be useful, but WITHOUT
0N/A." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A." version 2 for more details (a copy is included in the LICENSE file that
0N/A." accompanied this code).
0N/A." You should have received a copy of the GNU General Public License version
0N/A." 2 along with this work; if not, write to the Free Software Foundation,
0N/A." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
0N/A." CA 95054 USA or visit
www.sun.com if you need additional information or
0N/A." have any questions.
0N/A.TH wsimport 1 "07 Aug 2006"
0N/A." Generated by html2man
0N/Awsimport \- JAX\-WS 2.0 Beta
0N/Awsimport [options] <wsdl>
0N/AThe \f2wsimport\fP tool generates JAX\-WS portable artifacts, such as:
0N/AService Endpoint Interface (SEI)
0N/AException class mapped from wsdl:fault (if any)
0N/AAsync Reponse Bean derived from response wsdl:message (if any)
0N/AJAXB generated value types (mapped java classes from schema types)
0N/AThese artifacts can be packaged in a WAR file with the WSDL and schema documents along with the endpoint implementation to be deployed.
0N/Awsimport tool can be launched using the command line script
wsimport.sh (Unix) or
wsimport.bat(windows). There is also and ant task to import and compile the wsdl, see the details below.
0N/AThe following table lists the \f2wsimport\fP options.
0N/ATable 1\-1 wsimport Options
0N/A.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
0N/A.if \(ts\n(.z\(ts\(ts .ds #d nl
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify where to place generated output files
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify external JAX\-WS or JAXB binding files (Each \f2<file>\fP must have its own \f2\-b\fP)
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify catalog file to resolve external entity references, it supports TR9401, XCatalog, and OASIS XML Catalog format. Please read the XML Entity and URI Resolvers document or see \f3wsimport_catalog\fP sample.
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/Aallow 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
0N/A.if \n(.l<\n(80 .ll \n(80u
0N/A\f2\-httpproxy:<host>:<port>\fP
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify an HTTP proxy server (port defaults to 8080)
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecifying 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
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify where to place generated source files
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/AOutput messages about what the compiler is doing
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/APrint version information
0N/A.if \n(.l<\n(80 .ll \n(80u
0N/A\f2\-wsdllocation <location>\fP
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/A\f2@WebService.wsdlLocation\fP and \f2@WebServiceClient.wsdlLocation\fP value
0N/A.nr 38 \w\f3Option\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-d <directory>\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-b <path>\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-extension\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-help\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-keep\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-s <directory>\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-verbose\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2\-version\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f3Description\fP
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.nr 38 \wDisplay help
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.nr 38 \wKeep generated files
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.nr 40 \n(79+(0*\n(38)
0N/A.nr 41 \n(80+(3*\n(38)
0N/A.if t .if \n(TW>\n(.li .tm Table at line 124 file Input is too wide - \n(TW units
0N/A.if \(ts\n(.z\(ts\(ts .ds #d nl
0N/A\&\h'|\n(40u'\f3Option\fP\h'|\n(41u'\f3Description\fP
0N/A.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-d <directory>\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-b <path>\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\-catalog\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-extension\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A\&\h'|\n(40u'\f2\-help\fP\h'|\n(41u'Display help
0N/A.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v)
0N/A.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A\&\h'|\n(40u'\f2\-keep\fP\h'|\n(41u'Keep generated files
0N/A.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-p\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-s <directory>\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-verbose\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\f2\-version\fP\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v)
0N/A.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v)
0N/A\&\h'|\n(40u'\h'|\n(41u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n-(b.=0 .nr c. \n(.c-\n(d.-54
0N/AMultiple JAX\-WS and JAXB binding files can be specified using \f2\-b\fP 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.
0N/AAn Ant task for the \f2wsimport\fP tool is provided along with the tool. The attributes and elements supported by the Ant task are listed below:
0N/A destdir="directory for generated class files"\fP
0N/A sourcedestdir="directory for generated source files"\fP
0N/A keep="true|false"\fP
0N/A extension="true|false"\fP
0N/A verbose="true|false"\fP
0N/A version="true|false"\fP
0N/A wsdlLocation="..."\fP
0N/A catalog="catalog file"\fP
0N/A package="package name"\fP
0N/A <binding dir="..." includes="..." />\fP
0N/A.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
0N/A.if \(ts\n(.z\(ts\(ts .ds #d nl
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify where to place output generated classes
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify where to place generated source files, keep is turned on with this option
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/AKeep generated files, tunred on with sourcedestdir option
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/AOutput messages about what the compiler is doing
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify external JAX\-WS or JAXB binding files
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/Aallow vendor extentions (funcionality not specified by the specification). Use of extensions may result in applications that are not portable or may not interoperate with other implementations
0N/A.if \n(.l<\n(80 .ll \n(80u
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/AThe wsdl URI passed thru this option will be used to set the value of \f2@WebService.wsdlLocation\fP and \f2@WebServiceClient.wsdlLocation\fP annotation elements on the generated SEI and Service interface
0N/A.if \n(.l<\n(82 .ll \n(82u
0N/A.if \n(.l<\n(80 .ll \n(80u
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecify catalog file to resolve external entity references, it supports TR9401, XCatalog, and OASIS XML Catalog format. Additionally, ant xmlcatalog type can be used to resolve entities, see wsimport_catalog sample.
0N/A.if \n(.l<\n(82 .ll \n(82u
0N/A.if \n(.l<\n(80 .ll \n(80u
0N/A.if \n(.l<\n(81 .ll \n(81u
0N/ASpecifies the target package
0N/A.if \n(.l<\n(82 .ll \n(82u
0N/A.nr 38 \w\f3Attribute\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2destdir\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \wsourcedestdir
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2verbose\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2binding\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f2extension\fP
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.if \n(80<\n(38 .nr 80 \n(38
0N/A.nr 38 \w\f3Description\fP
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.if \n(81<\n(38 .nr 81 \n(38
0N/A.nr 38 \w\f3Command line\fP
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.nr 38 \w\f2\-keep\fP
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.nr 38 \w\f2\-verbose\fP
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.nr 38 \w\f2\-extension\fP
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.if \n(82<\n(38 .nr 82 \n(38
0N/A.nr 40 \n(79+(0*\n(38)
0N/A.nr 41 \n(80+(3*\n(38)
0N/A.nr 42 \n(81+(3*\n(38)
0N/A.if t .if \n(TW>\n(.li .tm Table at line 261 file Input is too wide - \n(TW units
0N/A.if \(ts\n(.z\(ts\(ts .ds #d nl
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f3Attribute\fP\h'|\n(41u'\f3Description\fP\h'|\n(42u'\f3Command line\fP
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f2wsdl\fP\h'|\n(41u'WSDL file\h'|\n(42u'WSDL
0N/A.if (\n(a|+\n(#^-1v)>\n(#- .nr #- +(\n(a|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f2destdir\fP\h'|\n(41u'\h'|\n(42u'\f2\-d\fP
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(b|+\n(#^-1v)>\n(#- .nr #- +(\n(b|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'sourcedestdir\h'|\n(41u'\h'|\n(42u'\f2\-s\fP
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(c|+\n(#^-1v)>\n(#- .nr #- +(\n(c|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f2keep\fP\h'|\n(41u'\h'|\n(42u'\f2\-keep\fP
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(d|+\n(#^-1v)>\n(#- .nr #- +(\n(d|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f2verbose\fP\h'|\n(41u'\h'|\n(42u'\f2\-verbose\fP
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(e|+\n(#^-1v)>\n(#- .nr #- +(\n(e|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f2binding\fP\h'|\n(41u'\h'|\n(42u'\f2\-b\fP
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\f2extension\fP\h'|\n(41u'\h'|\n(42u'
0N/A.if (\n(f|+\n(#^-1v)>\n(#- .nr #- +(\n(f|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u'\f2\-extension\fP
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(g|+\n(#^-1v)>\n(#- .nr #- +(\n(g|+\n(#^-\n(#--1v)
0N/A.if (\n(h|+\n(#^-1v)>\n(#- .nr #- +(\n(h|+\n(#^-\n(#--1v)
0N/A.if (\n(i|+\n(#^-1v)>\n(#- .nr #- +(\n(i|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(j|+\n(#^-1v)>\n(#- .nr #- +(\n(j|+\n(#^-\n(#--1v)
0N/A.if (\n(k|+\n(#^-1v)>\n(#- .nr #- +(\n(k|+\n(#^-\n(#--1v)
0N/A.if (\n(l|+\n(#^-1v)>\n(#- .nr #- +(\n(l|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if (\n(m|+\n(#^-1v)>\n(#- .nr #- +(\n(m|+\n(#^-\n(#--1v)
0N/A.if (\n(n|+\n(#^-1v)>\n(#- .nr #- +(\n(n|+\n(#^-\n(#--1v)
0N/A.if (\n(o|+\n(#^-1v)>\n(#- .nr #- +(\n(o|+\n(#^-\n(#--1v)
0N/A.ta \n(80u \n(81u \n(82u
0N/A\&\h'|\n(40u'\h'|\n(41u'\h'|\n(42u'
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n(32>\n(31 .nr 31 \n(32
0N/A.if \n-(b.=0 .nr c. \n(.c-\n(d.-63
0N/AThe \f2binding\fP attributes is like a
0N/A\f2path\-like structure\fP @
0N/Ahttp://ant.apache.org/manual/using.html#path and can also be set via nested \f2<binding>\fP elements, respectively. Before this task can be used, a \f2<taskdef>\fP element needs to be added to the project as given below:
0N/A\f2path\-like structure\fP @
0N/ASummary of Changed and Removed wsimport ant attributes:
0N/A\f3base\fP replaced by \f3destdir\fP
0N/A\f3sourceBase\fP is replaced by \f3sourcedestdir\fP
0N/A\f3wsdlFile\fP is replaced by \f3wsdl\fP
0N/A\f3httpProxy\fP is removed. Use ant's setproxy task instead for proxy configuration.
0N/A\f3version\fP is removed