wsimport.1 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. '\" t
  2. .\" Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
  3. .\" Arch: generic
  4. .\" Software: JDK 8
  5. .\" Date: 21 November 2013
  6. .\" SectDesc: Java Web Services Tools
  7. .\" Title: wsimport.1
  8. .\"
  9. .if n .pl 99999
  10. .TH wsimport 1 "21 November 2013" "JDK 8" "Java Web Services Tools"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH NAME
  31. wsimport \- Generates JAX-WS portable artifacts that can be packaged in a web application archive (WAR) file and provides an Ant task\&.
  32. .SH SYNOPSIS
  33. .sp
  34. .nf
  35. \fBwsimport\fR [ \fIoptions\fR ] \fIwsdl\fR
  36. .fi
  37. .sp
  38. .TP
  39. \fIoptions\fR
  40. The command-line options\&. See Options\&.
  41. .TP
  42. \fIwsdl\fR
  43. 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\&.
  44. .SH DESCRIPTION
  45. 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
  46. .TP 0.2i
  47. \(bu
  48. Service Endpoint Interface (SEI)
  49. .TP 0.2i
  50. \(bu
  51. Service
  52. .TP 0.2i
  53. \(bu
  54. Exception class is mapped from \f3wsdl:fault\fR (if any)
  55. .TP 0.2i
  56. \(bu
  57. Async Response Bean is derived from response \f3wsdl:message\fR (if any)
  58. .TP 0.2i
  59. \(bu
  60. JAXB generated value types (mapped java classes from schema types)
  61. .PP
  62. To start the \f3wsgen\fR command, do the following:
  63. .PP
  64. \fIOracle Solaris/Linux\fR:
  65. .sp
  66. .nf
  67. \f3/bin/wsimport\&.sh \-help\fP
  68. .fi
  69. .nf
  70. \f3\fP
  71. .fi
  72. .sp
  73. \fIWindows\fR:
  74. .sp
  75. .nf
  76. \f3\ebin\ewsimport\&.bat \-help\fP
  77. .fi
  78. .nf
  79. \f3\fP
  80. .fi
  81. .sp
  82. .SH OPTIONS
  83. .TP
  84. -d \fIdirectory\fR
  85. .br
  86. Specifies where to place generated output files\&.
  87. .TP
  88. -b \fIpath\fR
  89. .br
  90. 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
  91. .TP
  92. -B \fIjaxbOption\fR
  93. .br
  94. Passes the \f3jaxbOption\fR option to the JAXB schema compiler\&.
  95. .TP
  96. -catalog
  97. .br
  98. 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
  99. .TP
  100. -extension
  101. .br
  102. Allows vendor extensions\&. Use of extensions can result in applications that are not portable or that do not work with other implementations\&.
  103. .TP
  104. -help
  105. .br
  106. Displays a help message for the \f3wsimport\fR command\&.
  107. .TP
  108. -httpproxy: \fIhost\fR:\fIport\fR
  109. .br
  110. Specifies an HTTP proxy server\&. The default is 8080\&.
  111. .TP
  112. -keep
  113. .br
  114. Keeps generated files\&.
  115. .TP
  116. -p \fIname\fR
  117. .br
  118. Specifies a target package \fIname\fR to override the WSDL and schema binding customizations, and the default algorithm defined in the specification\&.
  119. .TP
  120. -s \fIdirectory\fR
  121. .br
  122. Specifies where to place generated source files\&.
  123. .TP
  124. -verbose
  125. .br
  126. Displays compiler messages\&.
  127. .TP
  128. -version
  129. .br
  130. Prints release information\&.
  131. .TP
  132. -wsdllocation \fIlocation\fR
  133. .br
  134. Specifies the \f3@WebServiceClient\&.wsdlLocation\fR value\&.
  135. .TP
  136. -target
  137. .br
  138. Generates code according to the specified JAX-WS specification version\&. Version 2\&.0 generates compliant code for the JAX-WS 2\&.0 specification\&.
  139. .TP
  140. -quiet
  141. .br
  142. Suppresses the \f3wsimport\fR command output\&.
  143. .PP
  144. 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
  145. .SH NONSTANDARD\ OPTIONS
  146. .TP
  147. -XadditionalHeaders
  148. .br
  149. Maps headers not bound to a request or response message to Java method parameters\&.
  150. .TP
  151. -Xauthfile \fIfile\fR
  152. .br
  153. The WSDL URI that specifies the file that contains authorization information\&. This URI is in the following format:
  154. http://\fIuser-name\fR:\f3password\fR@\fIhost-name\fR/\fIweb-service-name\fR>?wsdl\&.
  155. .TP
  156. -Xdebug
  157. .br
  158. Prints debugging information\&.
  159. .TP
  160. -Xno-addressing-databinding
  161. .br
  162. Enables binding of W3C EndpointReferenceType to Java\&.
  163. .TP
  164. -Xnocompile
  165. .br
  166. Does not compile the generated Java files\&.
  167. .SH EXAMPLE
  168. The following example generates the Java artifacts and compiles the artifacts by importing \f3http://stockquote\&.example\&.com/quote?wsdl\fR
  169. .sp
  170. .nf
  171. \f3wsimport \-p stockquote http://stockquote\&.example\&.com/quote?wsdl\fP
  172. .fi
  173. .nf
  174. \f3\fP
  175. .fi
  176. .sp
  177. .SH SEE\ ALSO
  178. .TP 0.2i
  179. \(bu
  180. wsgen(1)
  181. .TP 0.2i
  182. \(bu
  183. The Tools tab of Wsimport Ant Task page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html
  184. .TP 0.2i
  185. \(bu
  186. The \fIUsers Guide\fR tab of Catalog Support page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/catalog-support\&.html
  187. .TP 0.2i
  188. \(bu
  189. The \fIUsers Guide\fR tab of WSDL Customization page http://jax-ws\&.java\&.net/nonav/2\&.1\&.1/docs/wsimportant\&.html
  190. .RE
  191. .br
  192. 'pl 8.5i
  193. 'bp