:: Maven 2 WSDL2Code Plugin ::

Return-Path: Delivered-To: apmail-ws-axis-dev-archive@www.apache.org Received: (qmail 10117 invoked from network); 12 Nov 2006 20:30:57 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 12 Nov 2006 20:30:57 -0000 Received: (qmail 47310 invoked by uid 500); 12 Nov 2006 20:31:07 -0000 Delivered-To: apmail-ws-axis-dev-archive@ws.apache.org Received: (qmail 47229 invoked by uid 500); 12 Nov 2006 20:31:07 -0000 Mailing-List: contact axis-cvs-help@ws.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list axis-cvs@ws.apache.org Received: (qmail 47218 invoked by uid 500); 12 Nov 2006 20:31:07 -0000 Delivered-To: apmail-ws-axis2-cvs@ws.apache.org Received: (qmail 47215 invoked by uid 99); 12 Nov 2006 20:31:07 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 12 Nov 2006 12:31:07 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 12 Nov 2006 12:30:55 -0800 Received: by eris.apache.org (Postfix, from userid 65534) id 057DF1A9846; Sun, 12 Nov 2006 12:30:26 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r474033 - /webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html Date: Sun, 12 Nov 2006 20:30:25 -0000 To: axis2-cvs@ws.apache.org From: chinthaka@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20061112203026.057DF1A9846@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: chinthaka Date: Sun Nov 12 12:30:25 2006 New Revision: 474033 URL: http://svn.apache.org/viewvc?view=rev&rev=474033 Log: Updated the last bit of maven2 plugin docs. Now these are good for some one to review. Modified: webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html Modified: webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html?view=diff&rev=474033&r1=474032&r2=474033 ============================================================================== --- webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html (original) +++ webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html Sun Nov 12 12:30:25 2006 @@ -1,6 +1,6 @@ -:: Maven 2 WSDL2Code Plugin :: + :: Maven 2 WSDL2Code Plugin :: @@ -8,172 +8,181 @@

Introduction

This plugin takes as input a WSDL and generates client - and server stubs for calling or implementing a web service - matching the WSDL.

- -

Goals

- -

The WSDl2Code offers a single goal:

This plugin takes as input a WSDL and generates client + and server stubs for calling or implementing a web service + matching the WSDL.

+ +

Goals

+ +

The WSDl2Code offers a single goal:

wsdl2code (default): Reads the WSDL and generates code.

- - -

To run the plugin, add the following section to your POM:

- - -

-  <build>
-    <plugins>
-      <plugin>
-        <groupId>org.apache.axis2.maven2</groupId>
-        <artifactId>axis2-wsdl2code-maven-plugin</artifactId>
-        <executions>
-          <execution>
-            <goals>
-              <goal>wsdl2code</goal>
-            </goals>
-          </execution>
-          <configuration>
-            <packageName>com.foo.myservice</packageName>
-          </configuration>
-        </executions>
-      </plugin>
-    </plugins>
-  </build>
-

- -

The plugin will be invoked automatically in the generate-sources - phase. You can also invoke it directly from the command line by - running the command

mvn wsdl2code:wsdl2code

- - -

The WSDL2Code Goal

- -

By default, the plugin reads the file src/main/axis2/service.wsdl. - Sources for the Java programming language and the ADB data binding are - generated into target/generated-sources/axis2/wsdl2code. - Note the configuration element packageName above, which sets - the package name, thus a subdirectory.

- -

Configuration

- -

The WSDL2Code goal takes the following parameters as input. All parameters can be set from the command line by using properties. For example, the parameter "generateServerSide" may be set using the property "axis2.wsdl2code.generateServerSide". If the parameter isn't set via property or in the POM, then a default value applies.

wsdl2code (default): Reads the WSDL and generates code.

+ + + +

To run the plugin, add the following section to your POM:

+ + +

+    <build>
+    <plugins>
+    <plugin>
+    <groupId>org.apache.axis2.maven2</groupId>
+    <artifactId>axis2-wsdl2code-maven-plugin</artifactId>
+    <executions>
+    <execution>
+    <goals>
+    <goal>wsdl2code</goal>
+    </goals>
+    </execution>
+    <configuration>
+    <packageName>com.foo.myservice</packageName>
+    </configuration>
+    </executions>
+    </plugin>
+    </plugins>
+    </build>
+

+ +

The plugin will be invoked automatically in the generate-sources + phase. You can also invoke it directly from the command line by + running the command

mvn wsdl2code:wsdl2code

+ + +

The WSDL2Code Goal

+ +

By default, the plugin reads the file src/main/axis2/service.wsdl. + Sources for the Java programming language and the ADB data binding are + generated into target/generated-sources/axis2/wsdl2code. + Note the configuration element packageName above, which sets + the package name, thus a subdirectory.

+ +

Configuration

+ +

The WSDL2Code goal takes the following parameters as input. All parameters can be set from the + command line by using properties. For example, the parameter "generateServerSide" may be set + using the property "axis2.wsdl2code.generateServerSide". If the parameter isn't set via property + or in the POM, then a default value applies.

- + - - + + - - + + - + - - + + - - + + - - + + - - + + - - + + - - + + - + - - + + - - + + - - + + - + - - + + - - + + - + - - + + - - - - - + - - - + + + + + + + + + + + + + + + + + + +

Parameter name	Command line property	Description	Default value
databindingName	${axis2.wsdl2code.databindingName}	Data binding framework, which is being used by the generated sources.	adb
generateAllClasses	${axis2.wsdl2code.generateAllClasses}	Whether to generate simply all classes. This is only valid in conjunction with "generateServerSide".	Whether to generate simply all classes. This is only valid in conjunction with + "generateServerSide".	false
generateServerSide	${axis2.wsdl2code.generateServerSide}	Whether server side sources are being generated.	false
generateServerSideInterface	${axis2.wsdl2code.generateServerSideInterface}	Whether to generate the server side interface.	false
generateServicesXml	${axis2.wsdl2code.generateServicesXml}	Whether a "services.xml" file is being generated.	false
generateTestcase	${axis2.wsdl2code.generateTestCase}	Whether a test case is being generated.	false
language	${axis2.wsdl2code.language}	Programming language of the generated sources.	java
namespaceToPackages	${axis2.wsdl2code.namespaceToPackages}	Map of namespace URI to packages in the format uri1=package1,uri2=package2,... Using this parameter is discouraged. In general, you should use the namespaceUris parameter. However, the latter cannot be set on the command line.	Map of namespace URI to packages in the format uri1=package1,uri2=package2,... Using this + parameter is discouraged. In general, you should use the namespaceUris parameter. However, + the latter cannot be set on the command line.
namespaceURIs		Map of namespace URI to packages. Example: - <namespaceURIs> - <namespaceURI> - <uri>uri1</uri> - <package>package1</package> - </namespaceURI> - ........ -</namespaceURI>	Map of namespace URI to packages. Example: + <namespaceURIs> + <namespaceURI> + <uri>uri1</uri> + <package>package1</package> + </namespaceURI> + ........ + </namespaceURI>
outputDirectory	${axis2.wsdl2code.target}	Target directory, where sources are being target/generated-sources/axis2/wsdl2code generated.	Target directory, where sources are being target/generated-sources/axis2/wsdl2code + generated.
packageName	${axis2.wsdl2code.package}	Package name of the generated sources.
portName	${axis2.wsdl2code.portName}	Port name, for which sources are being generated. By default, sources are generated for all ports.	Port name, for which sources are being generated. By default, sources are generated for all + ports.
serviceName	${axis2.wsdl2code.serviceName}	Service name, for which sources are being generated. By default, sources are generated for all services.
	Service name, for which sources are being generated. By default, sources are generated for + all services.
syncMode	${axis2.wsdl2code.syncMode}	Sync mode, for which sources are being generated; either of "sync", "async", or "both" + (default).	both
unpackClasses	${axis2.wsdl2code.unpackClasses}	Whether to unpack classes.
wsdlFile	${axis2.wsdl2code.wsdl}	Location of the WSDL file, which is read as input	src/main/axis2/service.wsdl

- - -| syncMode | ${axis2.wsdl2code.syncMode} | Sync mode, for which sources are being | -| | both | generated; either of "sync", "async", or | -| | | "both" (default). | -*-----------------------------+------------------------------------------------+------------------------------------------------+ -| unpackClasses | ${axis2.wsdl2code.unpackClasses} | Whether to unpack classes. | -*-----------------------------+------------------------------------------------+------------------------------------------------| -| wsdlFile | ${axis2.wsdl2code.wsdl} | Location of the WSDL file, which is read as | -| | src/main/axis2/service.wsdl | input. | -*-----------------------------+------------------------------------------------+------------------------------------------------+ - - --------------------------------------------------------------------- To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org For additional commands, e-mail: axis-cvs-help@ws.apache.org