1 '\" t 2 .\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. 3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 .\" 5 .\" This code is free software; you can redistribute it and/or modify it 6 .\" under the terms of the GNU General Public License version 2 only, as 7 .\" published by the Free Software Foundation. 8 .\" 9 .\" This code is distributed in the hope that it will be useful, but WITHOUT 10 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 .\" version 2 for more details (a copy is included in the LICENSE file that 13 .\" accompanied this code). 14 .\" 15 .\" You should have received a copy of the GNU General Public License version 16 .\" 2 along with this work; if not, write to the Free Software Foundation, 17 .\" Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 .\" 19 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 .\" or visit www.oracle.com if you need additional information or have any 21 .\" questions. 22 .\" 23 .\" Arch: generic 24 .\" Software: JDK 8 25 .\" Date: 21 November 2013 26 .\" SectDesc: Java Web Services Tools 27 .\" Title: wsimport.1 28 .\" 29 .if n .pl 99999 30 .TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools" 31 .\" ----------------------------------------------------------------- 32 .\" * Define some portability stuff 33 .\" ----------------------------------------------------------------- 34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 35 .\" http://bugs.debian.org/507673 36 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html 37 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 38 .ie \n(.g .ds Aq \(aq 39 .el .ds Aq ' 40 .\" ----------------------------------------------------------------- 41 .\" * set default formatting 42 .\" ----------------------------------------------------------------- 43 .\" disable hyphenation 44 .nh 45 .\" disable justification (adjust text to left margin only) 46 .ad l 47 .\" ----------------------------------------------------------------- 48 .\" * MAIN CONTENT STARTS HERE * 49 .\" ----------------------------------------------------------------- 50 51 .SH NAME 52 wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&. 53 .SH SYNOPSIS 54 .sp 55 .nf 56 57 \fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR 58 .fi 59 .sp 60 .TP 61 \fIoptions\fR 62 The command-line options\&. See Options\&. 63 .TP 64 \fIwsdl\fR 65 The file that contains the machine-readable description of how the web service can be called, what parameters it expects, and what data structures it returns\&. 66 .SH DESCRIPTION 67 The \f3wsimport\fR command generates the following JAX-WS portable artifacts\&. These artifacts can be packaged in a WAR file with the WSDL and schema documents and the endpoint implementation to be deployed\&. The \f3wsimport\fR command also provides a \f3wsimport\fR Ant task, see the Tools tab of the Wsimport Ant Task page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html 68 .TP 0.2i 69 \(bu 70 Service Endpoint Interface (SEI) 71 .TP 0.2i 72 \(bu 73 Service 74 .TP 0.2i 75 \(bu 76 Exception class is mapped from \f3wsdl:fault\fR (if any) 77 .TP 0.2i 78 \(bu 79 Async Response Bean is derived from response \f3wsdl:message\fR (if any) 80 .TP 0.2i 81 \(bu 82 JAXB generated value types (mapped java classes from schema types) 83 .PP 84 To start the \f3wsgen\fR command, do the following: 85 .PP 86 \fIOracle Solaris/Linux\fR: 87 .sp 88 .nf 89 \f3/bin/wsimport\&.sh \-help\fP 90 .fi 91 .nf 92 \f3\fP 93 .fi 94 .sp 95 \fIWindows\fR: 96 .sp 97 .nf 98 \f3\ebin\ewsimport\&.bat \-help\fP 99 .fi 100 .nf 101 \f3\fP 102 .fi 103 .sp 104 .SH OPTIONS 105 .TP 106 -d \fIdirectory\fR 107 .br 108 Specifies where to place generated output files\&. 109 .TP 110 -b \fIpath\fR 111 .br 112 Specifies external JAX-WS or JAXB binding files\&. Multiple JAX-WS and JAXB binding files can be specified with the \f3-b\fR option\&. You can use these files to customize package names, bean names, and so on\&. For more information about JAX-WS and JAXB binding files, see the \fIUsers Guide\fR tab of WSDL Customization at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html 113 .TP 114 -B \fIjaxbOption\fR 115 .br 116 Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&. 117 .TP 118 -catalog 119 .br 120 Specifies a catalog file to resolve external entity references\&. The \f3-catalog\fR option supports the TR9401, XCatalog, and OASIS XML Catalog formats\&. See the \fIUsers Guide\fR tab of the Catalog Support page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html 121 .TP 122 -extension 123 .br 124 Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&. 125 .TP 126 -help 127 .br 128 Displays a help message for the \f3wsimport\fR command\&. 129 .TP 130 -httpproxy: \fIhost\fR:\fIport\fR 131 .br 132 Specifies an HTTP proxy server\&. The default is 8080\&. 133 .TP 134 -keep 135 .br 136 Keeps generated files\&. 137 .TP 138 -p \fIname\fR 139 .br 140 Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&. 141 .TP 142 -s \fIdirectory\fR 143 .br 144 Specifies where to place generated source files\&. 145 .TP 146 -verbose 147 .br 148 Displays compiler messages\&. 149 .TP 150 -version 151 .br 152 Prints release information\&. 153 .TP 154 -wsdllocation \fIlocation\fR 155 .br 156 Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&. 157 .TP 158 -target 159 .br 160 Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&. 161 .TP 162 -quiet 163 .br 164 Suppresses the \f3wsimport\fR command output\&. 165 .PP 166 Multiple \f3JAX-WS\fR and \f3JAXB\fR binding files can be specified using the \f3-b\fR option, and they can be used to customize various things such as package names and bean names\&. More information about \f3JAX-WS\fR and \f3JAXB\fR binding files can be found in the customization documentation at https://jax-ws\&.dev\&.java\&.net/nonav/2\&.1\&.1/docs/customizations\&.html 167 .SH NONSTANDARD\ OPTIONS 168 .TP 169 -XadditionalHeaders 170 .br 171 Maps headers not bound to a request or response message to Java method parameters\&. 172 .TP 173 -Xauthfile \fIfile\fR 174 .br 175 The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format: 176 177 http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&. 178 .TP 179 -Xdebug 180 .br 181 Prints debugging information\&. 182 .TP 183 -Xno-addressing-databinding 184 .br 185 Enables binding of W3C EndpointReferenceType to Java\&. 186 .TP 187 -Xnocompile 188 .br 189 Does not compile the generated Java files\&. 190 .SH EXAMPLE 191 The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR 192 .sp 193 .nf 194 \f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP 195 .fi 196 .nf 197 \f3\fP 198 .fi 199 .sp 200 .SH SEE\ ALSO 201 .TP 0.2i 202 \(bu 203 wsgen(1) 204 .TP 0.2i 205 \(bu 206 The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html 207 .TP 0.2i 208 \(bu 209 The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html 210 .TP 0.2i 211 \(bu 212 The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html 213 .RE 214 .br 215 'pl 8.5i 216 'bp