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: wsgen.1
  28 .\"
  29 .if n .pl 99999
  30 .TH wsgen 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 wsgen \- Reads a web service endpoint implementation (SEI) class and generates all of the required artifacts for web service deployment, and invocation\&.
  53 .SH SYNOPSIS    
  54 .sp     
  55 .nf     
  56 
  57 \fBwsgen\fR [ \fIoptions\fR ] \fISEI\fR
  58 .fi     
  59 .sp     
  60 .TP     
  61 \fIoptions\fR
  62 The command-line options\&. See Options\&.
  63 .TP     
  64 \fISEI\fR
  65 The web service endpoint implementation class (SEI) to be read\&.
  66 .SH DESCRIPTION    
  67 The \f3wsgen\fR command generates JAX-WS portable artifacts used in JAX-WS web services\&. The tool reads a web service endpoint class and generates all the required artifacts for web service deployment and invocation\&. JAXWS 2\&.1\&.1 RI also provides a \f3wsgen\fR Ant task, see the \fITools\fR tab of the JAX-WS (wsgen) page at http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html
  68 .PP
  69 To start the \f3wsgen\fR command, do the following:
  70 .sp     
  71 .nf     
  72 \f3export JAXWS_HOME=/pathto/jaxws\-ri\fP
  73 .fi     
  74 .nf     
  75 \f3$JAXWS_HOME/bin/wsgen\&.sh \-help\fP
  76 .fi     
  77 .nf     
  78 \f3\fP
  79 .fi     
  80 .sp     
  81 .SH OPTIONS    
  82 .TP
  83 -classpath \fIpath\fR
  84 .br
  85 The location of the input class files\&.
  86 .TP
  87 -cp \fIpath\fR
  88 .br
  89 The location of the input class files\&.
  90 .TP
  91 -d \fIdirectory\fR
  92 .br
  93 The location for where to place generated output files\&.
  94 .TP
  95 -extension
  96 .br
  97 Allow vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&.
  98 .TP
  99 -help
 100 .br
 101 Displays a help message about the \f3wsgen\fR command\&.
 102 .TP
 103 -keep
 104 .br
 105 Keeps the generated files\&.
 106 .TP
 107 -r \fIdirectory\fR
 108 .br
 109 Uses this option with the \f3-wsdl\fR option to specify where to place generated resource files such as WSDLs\&.
 110 .TP
 111 -s \fIdirectory\fR
 112 .br
 113 The location for where to place generated source files\&.
 114 .TP
 115 -verbose
 116 .br
 117 Displays compiler messages\&.
 118 .TP
 119 -version
 120 .br
 121 Prints release information\&.
 122 .TP
 123 -wsdl [ :protocol ] \fI\fR
 124 .br
 125 An optional command that generates a WSDL file to review before endpoint deployment\&. The WSDL files contains a machine-readable description of how the service can be called, what parameters it expects, and what data structures it returns\&.
 126 
 127 By default the \f3wsgen\fR command does not generate a WSDL file\&. The \f3protocol\fR value is optional and is used to specify what protocol should be used for the WSDL binding (\f3wsdl:binding\fR)\&. Valid protocols are \f3soap1\&.1\fR and \f3Xsoap1\&.2\fR\&. The default is \f3soap1\&.1\fR\&. The \f3Xsoap1\&.2\fR protocol is not standard and can only be used with the \f3-extension\fR option\&.
 128 .TP
 129 -servicename \fIname\fR
 130 .br
 131 Used only with the \f3-wsdl\fR option to specify a particular WSDL service (\f3wsdl:service\fR) name to be generated in the WSDL, for example: \f3-servicename "{http://mynamespace/}MyService"\fR\&.
 132 .TP
 133 -portname \fIname\fR
 134 .br
 135 Used only with the \f3-wsdl\fR option to specify a particular WSDL port (\f3wsdl:port\fR) name to be generated in the WSDL, for example: \f3-portname "{http://mynamespace/}MyPort"\fR\&.
 136 .SH EXAMPLES    
 137 The following example generates the wrapper classes for \f3StockService\fR with \f3@WebService\fR annotations inside stock directory\&.
 138 .sp     
 139 .nf     
 140 \f3wsgen \-d stock \-cp myclasspath stock\&.StockService\fP
 141 .fi     
 142 .nf     
 143 \f3\fP
 144 .fi     
 145 .sp     
 146 The following example generates a SOAP 1\&.1 WSDL and schema for the \f3stock\&.StockService\fR class with \f3@WebService\fR annotations\&.
 147 .sp     
 148 .nf     
 149 \f3wsgen \-wsdl \-d stock \-cp myclasspath stock\&.StockService\fP
 150 .fi     
 151 .nf     
 152 \f3\fP
 153 .fi     
 154 .sp     
 155 The following example generates a SOAP 1\&.2 WSDL\&.
 156 .sp     
 157 .nf     
 158 \f3wsgen \-wsdl:Xsoap1\&.2 \-d stock \-cp myclasspath stock\&.StockService \fP
 159 .fi     
 160 .nf     
 161 \f3\fP
 162 .fi     
 163 .sp     
 164 \fINote:\fR You do not have to generate WSDL at development time because the JAXWS run time environment generates a WSDL for you when you deploy your service\&.
 165 .SH SEE\ ALSO    
 166 .TP 0.2i    
 167 \(bu
 168 wsimport(1)
 169 .TP 0.2i    
 170 \(bu
 171 \fIThe Tools\fR tab of the JAX-WS (wsgen) page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsgenant\&.html
 172 .RE
 173 .br
 174 'pl 8.5i
 175 'bp