Author: veithen Date: Wed May 1 10:00:07 2013 New Revision: 1477940 URL: http://svn.apache.org/r1477940 Log: Improved the documentation of the Maven plugins.
Added: axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/ axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/apt/ axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/apt/index.apt axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/site.xml (with props) axis/axis1/java/trunk/maven/src/site/xdoc/ axis/axis1/java/trunk/maven/src/site/xdoc/index.xml (with props) Modified: axis/axis1/java/trunk/maven/maven-axis-server-plugin/pom.xml axis/axis1/java/trunk/maven/maven-axis-server-plugin/src/site/site.xml axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/pom.xml axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/main/java/org/apache/axis/tools/maven/java2wsdl/GenerateWsdlMojo.java axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/site/site.xml axis/axis1/java/trunk/maven/maven-wsdd-plugin/pom.xml axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/pom.xml axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/src/site/site.xml axis/axis1/java/trunk/maven/pom.xml Modified: axis/axis1/java/trunk/maven/maven-axis-server-plugin/pom.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-axis-server-plugin/pom.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-axis-server-plugin/pom.xml (original) +++ axis/axis1/java/trunk/maven/maven-axis-server-plugin/pom.xml Wed May 1 10:00:07 2013 @@ -79,12 +79,4 @@ <scope>test</scope> </dependency> </dependencies> - <reporting> - <plugins> - <plugin> - <artifactId>maven-plugin-plugin</artifactId> - <version>2.9</version> - </plugin> - </plugins> - </reporting> </project> Modified: axis/axis1/java/trunk/maven/maven-axis-server-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-axis-server-plugin/src/site/site.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-axis-server-plugin/src/site/site.xml (original) +++ axis/axis1/java/trunk/maven/maven-axis-server-plugin/src/site/site.xml Wed May 1 10:00:07 2013 @@ -17,7 +17,7 @@ ~ specific language governing permissions and limitations ~ under the License. --> -<project name="maven-axis-server-plugin"> +<project> <body> <menu name="Overview"> <item name="Introduction" href="index.html"/> Modified: axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/pom.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/pom.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/pom.xml (original) +++ axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/pom.xml Wed May 1 10:00:07 2013 @@ -76,12 +76,4 @@ <version>1.8.1</version> </dependency> </dependencies> - <reporting> - <plugins> - <plugin> - <artifactId>maven-plugin-plugin</artifactId> - <version>2.9</version> - </plugin> - </plugins> - </reporting> </project> Modified: axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/main/java/org/apache/axis/tools/maven/java2wsdl/GenerateWsdlMojo.java URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/main/java/org/apache/axis/tools/maven/java2wsdl/GenerateWsdlMojo.java?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/main/java/org/apache/axis/tools/maven/java2wsdl/GenerateWsdlMojo.java (original) +++ axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/main/java/org/apache/axis/tools/maven/java2wsdl/GenerateWsdlMojo.java Wed May 1 10:00:07 2013 @@ -25,7 +25,7 @@ import org.apache.maven.plugin.MojoExecu import org.apache.maven.plugin.MojoFailureException; /** - * + * Generates a WSDL description from a Java class. * * @goal generate-wsdl * @requiresDependencyResolution compile Modified: axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/site/site.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/site/site.xml (original) +++ axis/axis1/java/trunk/maven/maven-java2wsdl-plugin/src/site/site.xml Wed May 1 10:00:07 2013 @@ -17,7 +17,7 @@ ~ specific language governing permissions and limitations ~ under the License. --> -<project name="maven-java2wsdl-plugin"> +<project> <body> <menu name="Overview"> <item name="Introduction" href="index.html"/> Modified: axis/axis1/java/trunk/maven/maven-wsdd-plugin/pom.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-wsdd-plugin/pom.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-wsdd-plugin/pom.xml (original) +++ axis/axis1/java/trunk/maven/maven-wsdd-plugin/pom.xml Wed May 1 10:00:07 2013 @@ -57,12 +57,4 @@ <artifactId>ulog</artifactId> </dependency> </dependencies> - <!-- reporting> - <plugins> - <plugin> - <artifactId>maven-plugin-plugin</artifactId> - <version>2.9</version> - </plugin> - </plugins> - </reporting --> </project> Added: axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/apt/index.apt URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/apt/index.apt?rev=1477940&view=auto ============================================================================== --- axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/apt/index.apt (added) +++ axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/apt/index.apt Wed May 1 10:00:07 2013 @@ -0,0 +1,53 @@ +~~ Licensed to the Apache Software Foundation (ASF) under one +~~ or more contributor license agreements. See the NOTICE file +~~ distributed with this work for additional information +~~ regarding copyright ownership. The ASF licenses this file +~~ to you under the Apache License, Version 2.0 (the +~~ "License"); you may not use this file except in compliance +~~ with the License. You may obtain a copy of the License at +~~ +~~ http://www.apache.org/licenses/LICENSE-2.0 +~~ +~~ Unless required by applicable law or agreed to in writing, +~~ software distributed under the License is distributed on an +~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +~~ KIND, either express or implied. See the License for the +~~ specific language governing permissions and limitations +~~ under the License. + + ------------ + Introduction + ------------ + +maven-wsdd-plugin + + Historically, the recommended way to deploy Axis services was based on the following procedure: + + [[1]] Deploy the Axis WAR to a servlet container or application server. + + [[2]] Add the Web service code to the <<<WEB-INF/classes>>> or <<<WEB-INF/lib>>> folder in the + (exploded) Axis WAR. + + [[3]] Create a WSDD file (or use the WSDD file generated by wsdl2java) and deploy it using + the admin client. This will add the definitions contained in the submitted WSDD file + to the <<<server-config.wsdd>>> file. + + This procedure is described in more details in the {{{../../install.html}Installation Guide}}. + + However, nowadays the preferred approach - especially for enterprise projects - is to have a build + process that packages the Web service(s) together with the Axis libraries into a WAR that is then + deployed to the application server. This requires that the <<<server-config.wsdd>>> file is + constructed before the WAR is built. With Axis 1.4, developers would typically maintain that file + by hand, either by editing it directly (and copying the contents of WSDD files created by wsdl2java) + or by using e.g. the Axis 1.4 tooling in Eclipse. The file is then added to the project files under source control + so that it is available during the build. + + This approach is suboptimal because in most cases the <<<server-config.wsdd>>> file contains + content generated by wsdl2java. That content should not be under source control. Instead, + the <<<server-config.wsdd>>> file should be assembled automatically during the build process, + based on the output of wsdl2java. + + This is exactly what the maven-wsdd-plugin does: it takes a set of WSDD files and merges them + into a single output WSDD. The input WSDD files are typically generated by + {{{../wsdl2java/index.html}maven-wsdl2java-plugin}}, but the set may also contain + manually created WSDD files, e.g. to configure custom handlers or to override configuration properties. Added: axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/site.xml?rev=1477940&view=auto ============================================================================== --- axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/site.xml (added) +++ axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/site.xml Wed May 1 10:00:07 2013 @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> +<project> + <body> + <menu name="Overview"> + <item name="Introduction" href="index.html"/> + <item name="Goals" href="plugin-info.html"/> + </menu> + </body> +</project> Propchange: axis/axis1/java/trunk/maven/maven-wsdd-plugin/src/site/site.xml ------------------------------------------------------------------------------ svn:eol-style = native Modified: axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/pom.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/pom.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/pom.xml (original) +++ axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/pom.xml Wed May 1 10:00:07 2013 @@ -114,21 +114,4 @@ </build> </profile> </profiles> - <reporting> - <plugins> - <plugin> - <artifactId>maven-plugin-plugin</artifactId> - <version>2.9</version> - </plugin> - <plugin> - <artifactId>maven-project-info-reports-plugin</artifactId> - <version>2.4</version> - <reportSets> - <reportSet> - <reports/> - </reportSet> - </reportSets> - </plugin> - </plugins> - </reporting> </project> Modified: axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/src/site/site.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/src/site/site.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/src/site/site.xml (original) +++ axis/axis1/java/trunk/maven/maven-wsdl2java-plugin/src/site/site.xml Wed May 1 10:00:07 2013 @@ -17,7 +17,7 @@ ~ specific language governing permissions and limitations ~ under the License. --> -<project name="maven-wsdl2java-plugin"> +<project> <body> <menu name="Overview"> <item name="Introduction" href="index.html"/> Modified: axis/axis1/java/trunk/maven/pom.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/pom.xml?rev=1477940&r1=1477939&r2=1477940&view=diff ============================================================================== --- axis/axis1/java/trunk/maven/pom.xml (original) +++ axis/axis1/java/trunk/maven/pom.xml Wed May 1 10:00:07 2013 @@ -76,13 +76,16 @@ <build> <plugins> <plugin> - <!-- This overrides the set of reports just for this project (we don't want to - generate the reports defined in the parent POM) --> + <!-- This overrides the set of reports (we don't want to generate the reports defined in the parent POM) --> <artifactId>maven-site-plugin</artifactId> - <inherited>false</inherited> <configuration> <reportPlugins> <plugin> + <!-- This will be ignored for this project, but executed in submodules --> + <artifactId>maven-plugin-plugin</artifactId> + <version>2.9</version> + </plugin> + <plugin> <artifactId>maven-project-info-reports-plugin</artifactId> <version>2.6</version> <reports> Added: axis/axis1/java/trunk/maven/src/site/xdoc/index.xml URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/maven/src/site/xdoc/index.xml?rev=1477940&view=auto ============================================================================== --- axis/axis1/java/trunk/maven/src/site/xdoc/index.xml (added) +++ axis/axis1/java/trunk/maven/src/site/xdoc/index.xml Wed May 1 10:00:07 2013 @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> +<document xmlns="http://maven.apache.org/XDOC/2.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> + <properties> + <title>Introduction</title> + </properties> + <body> + <section name="Axis Maven Plugins"> + <p> + Starting with version 1.4.1, Axis provides a set of Maven plugins that can be used + as an alternative to the existing <a href="../ant/index.html">Ant tasks</a>. + The plugins also introduce a couple of features not found in the Ant tasks and that + are essential to properly support the Maven build lifecycle. + </p> + <p> + The following table provides an overview of these plugins and their relationships + with the existing Ant tasks: + </p> + <table class="table table-bordered"> + <thead> + <tr> + <td>Maven plugin</td> + <td>Description</td> + <td>Corresponding Ant tasks</td> + </tr> + </thead> + <tbody> + <tr> + <td><a href="wsdl2java/index.html">maven-wsdl2java-plugin</a></td> + <td>Generates Java artifacts from a WSDL file</td> + <td><a href="../ant/axis-wsdl2java.html">axis-wsdl2java</a></td> + </tr> + <tr> + <td><a href="java2wsdl/index.html">maven-java2wsdl-plugin</a></td> + <td>Generates a WSDL description from a Java class</td> + <td><a href="../ant/axis-java2wsdl.html">axis-java2wsdl</a></td> + </tr> + <tr> + <td><a href="wsdd/index.html">maven-wsdd-plugin</a></td> + <td></td> + <td rowspan="2" style="vertical-align: middle">N/A</td> + </tr> + <tr> + <td><a href="axis-server/index.html">maven-axis-server-plugin</a></td> + <td>Starts/stops a stand-alone Axis server</td> + </tr> + </tbody> + </table> + </section> + </body> +</document> Propchange: axis/axis1/java/trunk/maven/src/site/xdoc/index.xml ------------------------------------------------------------------------------ svn:eol-style = native