You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by bu...@apache.org on 2002/10/02 15:06:35 UTC
cvs commit: xml-axis/java/docs reference.html
butek 2002/10/02 06:06:35
Modified: java/docs reference.html
Log:
The WSDL2Java and Java2WSDL sections now match the tools.
Revision Changes Path
1.12 +77 -61 xml-axis/java/docs/reference.html
Index: reference.html
===================================================================
RCS file: /home/cvs/xml-axis/java/docs/reference.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- reference.html 27 Sep 2002 02:41:55 -0000 1.11
+++ reference.html 2 Oct 2002 13:06:34 -0000 1.12
@@ -30,7 +30,6 @@
</ul>
<h2> <a name="Tools"></a>Tools Reference</h2>
<h3><a name="WSDL2Java"></a>WSDL2Java Reference</h3>
-<h4>Other WSDL2Java details</h4>
<p>Usage: java org.apache.axis.wsdl.WSDL2Java [options] WSDL-URI <br>
Options: <br>
-h, --help <br>
@@ -39,6 +38,18 @@
-v, --verbose <br>
print informational messages <br>
+ -n, --noImports <br>
+
+ only generate code for the immediate WSDL document <br>
+ -O, --timeout <argument> <br>
+
+ timeout in seconds (default is 45, specify -1 to disable) <br>
+ -D, --Debug <br>
+
+ print debug information <br>
+ -W, --noWrapped<br>
+
+ turn off support for "wrapped" document/literal<br>
-s, --server-side <br>
emit server-side bindings for web service <br>
@@ -69,38 +80,56 @@
-t, --testCase <br>
emit junit testcase class for web service <br>
- -n, --noImports <br>
-
- only generate code for the immediate WSDL document <br>
-a, --all <br>
generate code for all elements, even unreferenced ones <br>
- -D, --Debug <br>
+ -T, --typeMappingVersion <br>
- print debug information <br>
+ indicate 1.1 or 1.2. The default is 1.1 (SOAP 1.1 JAX-RPC compliant.
+
+ 1.2 indicates SOAP 1.1 encoded.) <br>
-F, --factory <argument> <br>
-
- name of the JavaWriterFactory class for extending Java generation functions
- <br>
-
- ompliant) <br>
- -O, --timeout <argument> <br>
-
- timeout in seconds (default is 45, specify -1 to disable) <br>
+
+ name of a custom class that implements GeneratorFactory interface
+
+ (for extending Java generation functions) <br>
+ -H, --helperGen <br>
+
+ emits separate Helper classes for meta data <br>
-U, --user <argument> <br>
username to access the WSDL-URI <br>
-P, --password <argument> <br>
password to access the WSDL-URI <br>
- -W, --noWrapped<br>
-
- turn off support for "wrapped" document/literal<br>
<h4> -h, --help</h4>
Print the usage statement and exit
<h4> -v, --verbose</h4>
See what the tool is generating as it is generating it.
+<h4> -n, --noImports</h4>
+Only generate code for the WSDL document that appears on the command line.
+The default behaviour is to generate files for all WSDL documents, the immediate
+one and all imported ones.
+<h4> -O, --timeout</h4>
+Timeout in seconds. The default is 45. Use -1 to disable the timeout.
+<h4> -D, --Debug</h4>
+Print debug information, which currently is WSDL2Java's symbol table. Note that this is only printed after the symbol table is complete, ie., after the WSDL is parsed successfully.
+<h4>-W, --noWrapped</h4>
+This turns off the special treatment of what is called "wrapped" document/literal
+style operations. By default, WSDL2Java will recognize the following
+conditions:<br>
+<ul>
+ <li>If an input message has is a single part.</li>
+ <li>The part is an element.</li>
+ <li>The element has the same name as the operation</li>
+ <li>The element's complex type has no attributes<br>
+ </li>
+</ul>
+When it sees this, WSDL2Java will 'unwrap' the top level element, and treat each
+of the components of the element as arguments to the operation. This type of WSDL
+is the default for Microsoft .NET web services, which wrap up RPC style arguments
+in this top level schema element.
<h4> -s, --server-side</h4>
Emit the server-side bindings for the web service:
<ul>
@@ -172,10 +201,6 @@
0 or false for primitive types). Like the generated implementation file,
the generated test case file could be considered a template that you may fill
in.
-<h4> -n, --noImports</h4>
-Only generate code for the WSDL document that appears on the command line.
-The default behaviour is to generate files for all WSDL documents, the immediate
-one and all imported ones.
<h4> -a, --all</h4>
Generate code for all elements, even unreferenced ones. By default, WSDL2Java
only generates code for those elements in the WSDL file that are referenced.
@@ -197,13 +222,13 @@
then that portType will be generated and only those types that are referenced
by that portType.
<p>Note that the anchor is searched for in the WSDL file appearing on the command line, <b>not</b> in imported WSDL files. This allows one WSDL file to import constructs defined in another WSDL file without the nuisance of having all the imported WSDL file's constructs generated.
-<h4> -D, --Debug</h4>
-Print debug information, which currently is WSDL2Java's symbol table.
<h4> -T, --typeMappingVersion <argument></h4>
Indicate 1.1 or 1.2. The default is 1.2 (SOAP 1.2 JAX-RPC compliant).
<h4> -F, --factory <argument></h4>
Used to extend the functionality of the WSDL2Java emitter. The argument is the
name of a class which extends JavaWriterFactory.
+<h4> -H, --helperGen</h4>
+Emits separate Helper classes for meta data.
<h4> -U, --user <argument></h4>
This username is used in resolving the WSDL-URI provided as the input to WSDL2Java.
If the URI contains a username, this will override the command line switch.
@@ -212,21 +237,6 @@
This password is used in resolving the WSDL-URI provided as the input to WSDL2Java.
If the URI contains a password, this will override the command line switch.
<br>
-<h4>-W, --noWrapped</h4>
-This turns off the special treatment of what is called "wrapped" document/literal
-style operations. By default, WSDL2Java will recognize the following
-conditions:<br>
-<ul>
- <li>If an input message has is a single part.</li>
- <li>The part is an element.</li>
- <li>The element has the same name as the operation</li>
- <li>The element's complex type has no attributes<br>
- </li>
-</ul>
-When it sees this, WSDL2Java will 'unwrap' the top level element, and treat each
-of the components of the element as arguments to the operation. This type of WSDL
-is the default for Microsoft .NET web services, which wrap up RPC style arguments
-in this top level schema element.<br>
<h3><a name="Java2WSDL"></a>Java2WSDL Reference</h3>
<p>Here is the help message generated from the current tool: </p>
@@ -300,13 +310,9 @@
<tt><font color="#993366"> -O, --outputImpl
<argument></font></tt> <br>
<tt><font color="#993366">
- output Implementation WSDL filename, setting this causes --outputWsdlMode to
- be ignored</font></tt> <br>
- <tt><font color="#993366"> -f, --factory
- <argument></font></tt> <br>
+ output Implementation WSDL filename, setting this causes</font></tt> <br>
<tt><font color="#993366">
- name of the Java2WSDLFactory class for extending WSDL generation functions</font></tt>
- <br>
+ --outputWsdlMode to be ignored</font></tt> <br>
<tt><font color="#993366"> -i, --implClass
<argument></font></tt> <br>
<tt><font color="#993366">
@@ -322,10 +328,6 @@
<argument></font></tt> <br>
<tt><font color="#993366">
space or comma separated list of methods not to export</font></tt> <br>
- <tt><font color="#993366"> -y, --style
- <argument></font></tt> <br>
- <tt><font color="#993366">
- the style of the wsdl document: RPC, DOCUMENT or WRAPPED</font></tt> <br>
<tt><font color="#993366"> -c, --stopClasses
<argument></font></tt> <br>
<tt><font color="#993366">
@@ -338,6 +340,22 @@
<tt><font color="#993366">
indicate 1.1 or 1.2. The default is 1.2 (SOAP 1.2 JAX-RPC compliant)</font></tt>
<br>
+ <tt><font color="#993366"> -A, --soapAction
+ <argument></font></tt> <br>
+ <tt><font color="#993366">
+ value of the operations soapAction field. Values are DEFAULT,</font></tt> <br>
+ <tt><font color="#993366">
+ OPERATION or NONE. OPERATION forces soapAction to the name</font></tt> <br>
+ <tt><font color="#993366">
+ of the operation. DEFAULT causes the soapAction to be set</font></tt> <br>
+ <tt><font color="#993366">
+ according to the operations meta data (usually ""). NONE</font></tt> <br>
+ <tt><font color="#993366">
+ forces the soapAction to "". The default is DEFAULT.</font></tt> <br>
+ <tt><font color="#993366"> -y, --style
+ <argument></font></tt> <br>
+ <tt><font color="#993366">
+ the style of the wsdl document: RPC, DOCUMENT or WRAPPED</font></tt> <br>
<tt><font color="#993366">Details:</font></tt> <br>
<tt><font color="#993366"> portType element name= <.portTypeName
value> OR <class-of-portType name></font></tt> <br>
@@ -352,27 +370,27 @@
<p><b>-h , --help</b> <br>
Prints the help message.
-<p><b>-o, --output <WSDL file></b> <br>
- Indicates the name of the output WSDL file. If not specified, a suitable
- default WSDL file is written into the current directory.
<p><b>-I, --input <WSDL file></b> <br>
Optional parameter that indicates the name of the input wsdl file. The output
wsdl file will contain everything from the input wsdl file plus the new constructs.
If a new construct is already present in the input wsdl file, it is not added.
This option is useful for constructing a wsdl file with multiple ports, bindings,
or portTypes.
+<p><b>-o, --output <WSDL file></b> <br>
+ Indicates the name of the output WSDL file. If not specified, a suitable
+ default WSDL file is written into the current directory.
<p><b>-l, --location <location></b> <br>
Indicates the url of the location of the service. The name after the last
slash or backslash is the name of the service port (unless overridden by the
-s option). The service port address location attribute is assigned the
specified value.
-<p><b>-p, --portTypeName <name></b> <br>
+<p><b>-P, --portTypeName <name></b> <br>
Indicates the name to use use for the portType element. If not specified, the
class-of-portType name is used.
<p><b>-b, --bindingName <name></b> <br>
Indicates the name to use use for the binding element. If not specified, the
value of the --servicePortName + "SoapBinding" is used.
-<p><b>-s, --serviceElementName <name></b> <br>
+<p><b>-S, --serviceElementName <name></b> <br>
Indicates the name of the service element. If not specified, the service
element is the <portTypeName>Service.
<p><b>-s, --servicePortName <name></b> <br>
@@ -411,24 +429,22 @@
Use this option to indicate the name of the output implementation WSDL file.
If specified, Java2WSDL will produce interface and implementation WSDL files.
If this option is used, the -w option is ignored.
-<p><b>-f, --factory <class></b> <br>
- (No longer used.)
<p><b>-i, --implClass <impl-class></b> <br>
Sometimes extra information is available in the implementation class file. Use
this option to specify the implementation class.
-<p><b>-f, --factory <class></b> <br>
- (No longer used.)
<p><b>-x, --exclude <list></b> <br>
List of methods to not exclude from the wsdl file.
+<p><b>-c, --stopClasses <list></b> <br>
+ List of classes which stop the Java2WSDL inheritance search.
+<p><b>-T, --typeMappingVersion <version></b> <br>
+ Choose the default type mapping registry to use. Either 1.1 or 1.2.</p>
+<p><b>-A, --soapAction <argument></b> <br>
+ The value of the operations soapAction field. Values are DEFAULT, OPERATION or NONE. OPERATION forces soapAction to the name of the operation. DEFAULT causes the soapAction to be set according to the operation's meta data (usually ""). NONE forces the soapAction to "". The default is DEFAULT.
<p><b>-y, --style <argument></b> <br>
The style of the WSDL document: RPC, DOCUMENT or WRAPPED.
If RPC, a rpc/encoded wsdl is generated.
If DOCUMENT, a document/literal wsdl is generated.
If WRAPPED, a document/literal wsdl is generated using the wrapped approach.
-<p><b>-c, --stopClasses <list></b> <br>
- List of classes which stop the Java2WSDL inheritance search.
-<p><b>-T, --typeMappingVersion <version></b> <br>
- Choose the default type mapping registry to use. Either 1.1 or 1.2.</p>
<h2><a name="Deployment"></a>Deployment (WSDD) Reference</h2>
Note : all the elements referred to in this section are in the WSDD namespace,
namely "http://xml.apache.org/axis/wsdd/".