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 ch...@apache.org on 2006/11/12 13:01:46 UTC
svn commit: r473946 - in
/webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins: ./
maven-aar-plugin.html maven-java2wsdl-plugin.html maven-wsdl2code-plugin.html
Author: chinthaka
Date: Sun Nov 12 04:01:45 2006
New Revision: 473946
URL: http://svn.apache.org/viewvc?view=rev&rev=473946
Log:
Adding the converted maven plugin docs. Need to do a bit more with the last document. (Committing as soon as I get the internet
access)
Added:
webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/
webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-aar-plugin.html
webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-java2wsdl-plugin.html
webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html
Added: webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-aar-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-aar-plugin.html?view=auto&rev=473946
==============================================================================
--- webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-aar-plugin.html (added)
+++ webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-aar-plugin.html Sun Nov 12 04:01:45 2006
@@ -0,0 +1,170 @@
+<html>
+<head>
+<title>::Maven AAR Plugin ::</title>
+</head>
+
+<body>
+<h1>Maven AAR Plugin Help</h1>
+
+<h2>Introduction</h2>
+<p>This plugin generates an Axis 2 service file (AAR file).</p>
+
+<h2>Goals</h2>
+
+<p>The Aar plugin allows the packaging of an Axis 2 service aar in 3 different modes:</p>
+
+<ol>
+ <li><b>aar (default)</b>: generates the aar artifact</li>
+ <li><b>inplace</b> : package the aar in the source tree</li>
+ <li><b>exploded</b> : package an exploded aar application</li>
+</ol>
+
+ <p>Each mode is materialized by a goal. For instance, to generate an exploded
+ aar from the current project, one would type <pre>mvn aar:exploded</pre>
+</p>
+
+<h2>Configuration</h2>
+
+<p>All AAR plugin goals takes the following configuration parameters as input:</p>
+
+<table>
+<tr>
+ <td><strong>Parameter name</strong></td>
+ <td><strong>Default value</strong></td>
+ <td><strong>Description</strong></td>
+</tr>
+<tr>
+ <td>aarDirectory</td>
+ <td>${project.build.directory}/aar</td>
+ <td>Directory where the aar file is built</td>
+</tr>
+<tr>
+ <td>classesDirectory</td>
+ <td>${project.build.outputDirectory}</td>
+ <td>Directory with compiled classes and resources</td>
+</tr>
+<tr>
+ <td>fileSets</td>
+ <td></td>
+ <td>Additional file sets, which are being added to the archive. See "File Sets" below for an example</td>
+</tr>
+<tr>
+ <td>servicesXmlFile</td>
+ <td></td>
+ <td>Location of the services.xml file. By default, it is assumed that the file is already present in classesDirectory/META-INF and no special processing is required</td>
+</tr>
+<tr>
+ <td>wsdlFile</td>
+ <td></td>
+ <td>Location of the WSDL file. By default, it is assumed that the file is already present in classesDirectory/META-INF and no special processing is required</td>
+</tr>
+<tr>
+ <td>wsdlFileName</td>
+ <td>service.wsdl</td>
+ <td>Name, to which the WSDL file should be mapped</td>
+</tr>
+</table>
+
+<h3>The aar goal</h3>
+
+ <p>The aar goal allows the following additional parameters:</p>
+
+ <table>
+<tr>
+ <td><strong>Parameter name</strong></td>
+ <td><strong>Default value</strong></td>
+ <td><strong>Description</strong></td>
+</tr>
+<tr>
+ <td>outputDirectory</td>
+ <td>${project.build.directory}</td>
+ <td>Directory where to generate the AAR file</td>
+</tr>
+<tr>
+ <td>aarName</td>
+ <td>${project.build.finalName}</td>
+ <td>The generated AAR files name</td>
+</tr>
+<tr>
+ <td>archive</td>
+ <td></td>
+ <td>A Maven archive configuration. This allows, for example, to configure the MANIFEST.MF file</td>
+</tr>
+<tr>
+ <td>classifier</td>
+ <td></td>
+ <td>A classifier, which should be added to the generated AAR files name. Setting this parameter has the side effect, that the artifact is treated as an attachment and not as the projects primary artifact</td>
+</tr>
+<tr>
+ <td>primaryArtifact</td>
+ <td>true</td>
+ <td>Setting this property to false disables installation or deployment of the artifact as the projects primary artifact</td>
+</tr>
+</table>
+
+
+<h3>File Sets</h3>
+
+ <p>Additional file sets may be configured for inclusion into the AAR file. A file set looks
+ as follows:</p>
+
+
+<pre>
+ <fileSets>
+ <fileSet>
+ <directory>src/aar/files</directory>
+ <outputDirectory>META-INF/docs</outputDirectory>
+ <includes>
+ <include>**/*.html</include>
+
+ </includes>
+ </fileSet>
+ <fileSet>
+ <directory>src/aar/files</directory>
+ <outputDirectory>META-INF/etc</outputDirectory>
+
+ <excludes>
+ <exclude>**/*.html</exclude>
+ </excludes>
+ </fileSet>
+ </fileSets>
+ </pre>
+
+
+ <p>The example specifies, that the contents of the directory src/aar/files shall
+ be added to the AAR file. HTML files will go into META-INF/docs, all other
+ files to META-INF/etc.</p>
+
+ <p>A file set is configured through the following configuration parameters:</p>
+
+
+ <table>
+ <tr>
+ <td><strong>Parameter Name</strong></td>
+ <td><strong>Description</strong></td>
+ </tr>
+ <tr>
+ <td>directory</td>
+ <td>The directory, from which to read the file set. This parameter is required</td>
+ </tr>
+ <tr>
+ <td>outputDirectory</td>
+ <td>The target directory within the AAR file. Defaults to the AAR files root directory</td>
+ </tr>
+ <tr>
+ <td>includes</td>
+ <td>Configures the set of files, which shall be included into the AAR file. Defaults to **/* </td>
+ </tr>
+ <tr>
+ <td>excludes</td>
+ <td>Configures a set of files, which shall be excluded from the file set. Defaults to the Maven default excludes (**/*~, **/cvs/**/*, **/.svn/**/*, etc.)</td>
+ </tr>
+ <tr>
+ <td>skipDefaultExcludes</td>
+ <td>If this parameter is set to true, then no default excludes are being used</td>
+ </tr>
+ </table>
+</p>
+
+</body>
+</html>
\ No newline at end of file
Added: webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-java2wsdl-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-java2wsdl-plugin.html?view=auto&rev=473946
==============================================================================
--- webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-java2wsdl-plugin.html (added)
+++ webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-java2wsdl-plugin.html Sun Nov 12 04:01:45 2006
@@ -0,0 +1,118 @@
+<html>
+<head>
+<title>:: Maven 2 Java2WSDL Plugin ::</title>
+</head>
+<body>
+<h1>Maven 2 Java2WSDL Plugin Help</h1>
+
+<h2>Introduction</h2>
+
+<p>This plugin takes as input a Java class and generates a WSDL,
+ which describes a web service for invoking the classes
+ methods.</p>
+
+ <h2>Goals</h2>
+
+ <p>The Java2WSDL plugin offers a single goal:</p>
+
+<ul>
+<li>java2wsdl (default): Reads a java class and generates a WSDL for invoking the classes methods as a web service.</li>
+</ul>
+
+
+ <p>To run the plugin, add the following section to your POM:</p>
+
+
+ <pre>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.axis2.maven2</groupId>
+ <artifactId>axis2-java2wsdl-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <goals>
+ <goal>java2wsdl</goal>
+ </goals>
+ </execution>
+ <configuration>
+ <className>com.foo.myservice.MyHandler</className>
+ </configuration>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </pre>
+
+
+ <p>The plugin will be invoked automatically in the generate-resources
+ phase. You can also invoke it directly from the command line by
+ running the command: <pre>mvn java2wsdl:java2wsdl</pre></p>
+
+<h3>The Java2WSDL Goal</h3>
+
+ <p>By default, the plugin reads the given Java class and creates a
+ file <strong>target/generated-resources/java2wsdl/service.xml</strong>. The
+ Java class is given by the configuration element <strong>className</strong>
+ above.</p>
+
+ <h2>Configuration</h2>
+
+ <p>The Java2WSDL goal takes the following parameters as input. All parameters can be set from the command line by using properties. For example, the parameter "className" may be set using the property
+ "axis2.java2wsdl.className". If the parameter isn't set via property or in the POM, then a default
+ value applies.</p>
+
+
+ <table>
+ <tr>
+ <td><strong>Parameter name</strong></td>
+ <td><strong>Command line property</strong></td>
+ <td><strong>Description</strong></td>
+ <td><strong>Default value</strong></td>
+</tr>
+<tr>
+ <td>className</td>
+ <td>${axis2.java2wsdl.className}</td>
+ <td>Fully qualified name of the class, which is being read and transformed into a WSDL</td>
+ <td></td>
+</tr>
+<tr>
+ <td>outputFileName</td>
+ <td>${axis2.java2wsdl.outputFileName}</td>
+ <td>Path of the generated service file.</td>
+ <td></td>
+</tr>
+<tr>
+ <td>schemaTargetNamespace</td>
+ <td>${axis2.java2wsdl.schemaTargetNamespace}</td>
+ <td>Target namespace of the generated schema. </td>
+ <td></td>
+</tr>
+<tr>
+ <td>schemaTargetNamespacePrefix</td>
+ <td>${axis2.java2wsdl.schemaTargetNamespacePrefix}</td>
+ <td>Prefix, which is being associated with the schemas target namespace.</td>
+ <td></td>
+</tr>
+<tr>
+ <td>serviceName</td>
+ <td>${axis2.java2wsdl.serviceName} </td>
+ <td>Name of the generated web service. </td>
+ <td>Unqualified name of the input class.</td>
+</tr>
+<tr>
+ <td>targetNamespace</td>
+ <td>${axis2.java2wsdl.targetNamespace} </td>
+ <td>Target namespace of the generated WSDL</td>
+ <td>Default namespace </td>
+</tr>
+<tr>
+ <td>targetNamespacePrefix</td>
+ <td>${axis2.java2wsdl.targetNamespacePrefix}</td>
+ <td>Prefix, which is being associated with the target namespace</td>
+ <td></td>
+</tr>
+</table>
+
+</body>
+</html>
\ No newline at end of file
Added: 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=auto&rev=473946
==============================================================================
--- webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html (added)
+++ webservices/axis2/branches/java/1_1/xdocs/tools/1_1/maven-plugins/maven-wsdl2code-plugin.html Sun Nov 12 04:01:45 2006
@@ -0,0 +1,179 @@
+<html>
+<head>
+<title>:: Maven 2 WSDL2Code Plugin ::</title>
+</head>
+
+<body>
+<h1>Maven 2 WSDL2Code Plugin Help</h1>
+
+<h2>Introduction</h2>
+
+<p>This plugin takes as input a WSDL and generates client
+ and server stubs for calling or implementing a web service
+ matching the WSDL.</p>
+
+ <h2>Goals</h2>
+
+ <p>The WSDl2Code offers a single goal:</p>
+
+<ul>
+<li>wsdl2code (default): Reads the WSDL and generates code.</li>
+</ul>
+
+
+ <p>To run the plugin, add the following section to your POM:</p>
+
+
+ <pre>
+ <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>
+</pre>
+
+ <p>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 <pre>mvn wsdl2code:wsdl2code</pre></p>
+
+
+<h3>The WSDL2Code Goal</h3>
+
+ <p>By default, the plugin reads the file <strong>src/main/axis2/service.wsdl</strong>.
+ Sources for the Java programming language and the ADB data binding are
+ generated into <strong>target/generated-sources/axis2/wsdl2code</strong>.
+ Note the configuration element <strong>packageName</strong> above, which sets
+ the package name, thus a subdirectory.</p>
+
+ <h2>Configuration</h2>
+
+ <p>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.</p>
+
+<table>
+ <tr align="center">
+ <td><strong>Parameter name</strong></td>
+ <td><strong>Command line property</strong></td>
+ <td><strong>Description</strong></td>
+ <td><strong>Default value</strong></td>
+ </tr>
+ <tr align="center">
+ <td>databindingName</td>
+ <td>${axis2.wsdl2code.databindingName}</td>
+ <td>Data binding framework, which is being used by the generated sources. </td>
+ <td>adb</td>
+ </tr>
+ <tr align="center">
+ <td>generateAllClasses</td>
+ <td>${axis2.wsdl2code.generateAllClasses}</td>
+ <td>Whether to generate simply all classes. This is only valid in conjunction with "generateServerSide".</td>
+ <td>false</td>
+ </tr>
+ <tr align="center">
+ <td>generateServerSide</td>
+ <td>${axis2.wsdl2code.generateServerSide}</td>
+ <td>Whether server side sources are being generated.</td>
+ <td>false</td>
+ </tr>
+ <tr align="center">
+ <td>generateServerSideInterface</td>
+ <td>${axis2.wsdl2code.generateServerSideInterface}</td>
+ <td>Whether to generate the server side interface.</td>
+ <td>false</td>
+ </tr>
+ <tr align="center">
+ <td>generateServicesXml</td>
+ <td>${axis2.wsdl2code.generateServicesXml}</td>
+ <td>Whether a "services.xml" file is being generated.</td>
+ <td>false</td>
+ </tr>
+ <tr align="center">
+ <td>generateTestcase</td>
+ <td>${axis2.wsdl2code.generateTestCase}</td>
+ <td>Whether a test case is being generated.</td>
+ <td>false</td>
+ </tr>
+ <tr align="center">
+ <td>language</td>
+ <td>${axis2.wsdl2code.language}</td>
+ <td>Programming language of the generated sources.</td>
+ <td>java</td>
+ </tr>
+ <tr align="center">
+ <td>namespaceToPackages</td>
+ <td>${axis2.wsdl2code.namespaceToPackages}</td>
+ <td>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.</td>
+ <td></td>
+ </tr>
+ <tr align="center">
+ <td>namespaceURIs</td>
+ <td></td>
+ <td>Map of namespace URI to packages. Example:
+ <namespaceURIs>
+ <namespaceURI>
+ <uri>uri1</uri>
+ <package>package1</package>
+ </namespaceURI>
+ ........
+</namespaceURI></td>
+
+ <td></td>
+ </tr>
+ <tr align="center">
+ <td>outputDirectory</td>
+ <td>${axis2.wsdl2code.target}</td>
+ <td>Target directory, where sources are being target/generated-sources/axis2/wsdl2code generated.</td>
+ <td></td>
+ </tr>
+ <tr align="center">
+ <td>packageName</td>
+ <td>${axis2.wsdl2code.package}</td>
+ <td>Package name of the generated sources.</td>
+ <td></td>
+ </tr>
+ <tr align="center">
+ <td>portName</td>
+ <td>${axis2.wsdl2code.portName}</td>
+ <td>Port name, for which sources are being generated. By default, sources are generated for all ports.</td>
+ <td></td>
+ </tr>
+ <tr align="center">
+ <td>serviceName</td>
+ <td>${axis2.wsdl2code.serviceName}</td>
+ <td>Service name, for which sources are being generated. By default, sources are generated for all services. </td>
+ <td></td>
+ </tr>
+ <tr align="center">
+ <td></td>
+ <td></td>
+ <td></td>
+ <td></td>
+ </tr>
+</table>
+
+
+| 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. |
+*-----------------------------+------------------------------------------------+------------------------------------------------+
+
+
+</body>
+</html>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org