Javadoc

core-tiger/pom.xml

@@ -20,6 +20,16 @@
             </plugin>
         </plugins>
     </build>
+    <reporting>
+        <plugins>
+            <plugin>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <stylesheetfile>${basedir}/../src/main/javadoc/javadoc.css</stylesheetfile>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
     <dependencies>
         <!-- Spring-WS dependencies -->
         <dependency>

core/pom.xml

@@ -12,6 +12,16 @@
     <packaging>jar</packaging>
     <name>Spring WS Core</name>
     <description>Spring Web Services Core package.</description>
+    <reporting>
+        <plugins>
+            <plugin>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <stylesheetfile>${basedir}/../src/main/javadoc/javadoc.css</stylesheetfile>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
     <dependencies>
         <!-- Spring-WS dependencies -->
         <dependency>

core/src/main/java/org/springframework/ws/client/core/WebServiceTemplate.java

@@ -56,11 +56,43 @@ import org.springframework.ws.transport.support.DefaultStrategiesHelper;
  * receiving {@link WebServiceMessage} instances.
  * <p/>
  * Code using this class need only implement callback interfaces, provide {@link Source} objects to read data from, or
- * use the pluggable {@link Marshaller} support.
+ * use the pluggable {@link Marshaller} support. For invoking the {@link #marshalSendAndReceive marshalling methods},
+ * the {@link #setMarshaller(Marshaller) marshaller} and {@link #setUnmarshaller(Unmarshaller) unmarshaller} properties
+ * must be set.
  * <p/>
  * This template uses a {@link SoapFaultMessageResolver} to handle fault response messages. Another {@link
  * FaultMessageResolver} can be defined with with {@link #setFaultMessageResolver(FaultMessageResolver)
- * faultMessageResolver}  property. If this property is set to <code>null</code>, no fault resolving is performed.
+ * faultMessageResolver} property. If this property is set to <code>null</code>, no fault resolving is performed.
+ * <p/>
+ * This template uses the following algorithm for sending and receiving.
+ * <ol>
+ * <li>Call to {@link #createConnection(String) createConnection()}.</li>
+ * <li>Call to {@link WebServiceMessageFactory#createWebServiceMessage() createWebServiceMessage()} on the registered
+ *     message factory to create a request message.</li>
+ * <li>Invoke {@link WebServiceMessageCallback#doWithMessage(WebServiceMessage) doWithMessage()} on the request
+ *     callback, if any. This step stores content in the request message, based on <code>Source</code>, marshalling,
+ * etc.</li>
+ * <li>Call {@link WebServiceConnection#send(WebServiceMessage) send()} on the connection.</li>
+ * <li>Call {@link #hasError(WebServiceConnection, WebServiceMessage) hasError()} to check if the connection has an
+ *     error. For an HTTP transport, a status code other than <code>2xx</code> indicates an error. However, since a
+ *     status code of 500 can also indicate a SOAP fault, the template verifies whether the error is not a fault.</li>
+ * <ul>
+ *     <li>If the connection has an error, call the {@link #handleError handleError()} method, which by default throws a
+ *         {@link WebServiceTransportException}.</li>
+ *     <li>If the connection has no error, continue with the next step.
+ * </ul>
+ * <li>Invoke {@link WebServiceConnection#receive(WebServiceMessageFactory) receive} on the connection to read the
+ *     response message, if any.</li>
+ * <ul>
+ *     <li>If no response was received, return <code>null</code> or <code>false</code></li>
+ *     <li>Call {@link #hasFault(WebServiceConnection, WebServiceMessage) hasFault()} to determine whether the response
+ *         has a fault. If it has, call the {@link #handleFault handleFault()} method.</li>
+ *     <li>Otherwise, invoke {@link WebServiceMessageExtractor#extractData(WebServiceMessage) extractData()} on the
+ *         response extractor, or {@link WebServiceMessageCallback#doWithMessage(WebServiceMessage) doWithMessage} on
+ *         the response callback.</li>
+ * </ul>
+ * <li>Call to {@link WebServiceConnection#close() close} on the connection.</li>
+ * </ol>
  *
  * @author Arjen Poutsma
  */

core/src/main/java/org/springframework/ws/soap/SoapMessageFactory.java

@@ -31,7 +31,7 @@ public interface SoapMessageFactory extends WebServiceMessageFactory {
     /**
      * Sets the SOAP Version used by this factory.
      *
-     * @return the version constant
+     * @param version the version constant
      * @see SoapVersion#SOAP_11
      * @see SoapVersion#SOAP_12
      */

core/src/main/java/org/springframework/ws/transport/WebServiceMessageSender.java

@@ -42,7 +42,7 @@ public interface WebServiceMessageSender {
     WebServiceConnection createConnection(String uri) throws IOException;
 
     /**
-     * Does this {@link {@link WebServiceMessageSender}} support the supplied URI?
+     * Does this {@link WebServiceMessageSender} support the supplied URI?
      *
      * @param uri the URI to be checked
      * @return <code>true</code> if this <code>WebServiceMessageSender</code> supports the supplied URI

oxm-tiger/pom.xml

@@ -40,6 +40,16 @@
             </plugin>
         </plugins>
     </build>
+    <reporting>
+        <plugins>
+            <plugin>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <stylesheetfile>${basedir}/../src/main/javadoc/javadoc.css</stylesheetfile>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
     <dependencies>
         <!-- Spring-WS dependencies -->
         <dependency>

oxm/pom.xml

@@ -66,6 +66,16 @@
             </plugin>
         </plugins>
     </build>
+    <reporting>
+        <plugins>
+            <plugin>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <stylesheetfile>${basedir}/../src/main/javadoc/javadoc.css</stylesheetfile>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
     <dependencies>
         <!-- Spring-WS dependencies -->
         <dependency>

pom.xml

@@ -86,6 +86,10 @@
             <name>Kristoffer Moum</name>
         </contributor>
     </contributors>
+    <organization>
+        <name>The Spring Web Services Framework</name>
+        <url>http://www.springframework.org/spring-ws</url>
+    </organization>
     <licenses>
         <license>
             <name>The Apache Software License, Version 2.0</name>
@@ -281,6 +285,10 @@
                 <configuration>
                     <aggregate>true</aggregate>
                     <breakiterator>true</breakiterator>
+                    <header>Spring Web Services Framework</header>
+                    <source>1.5</source>
+                    <stylesheetfile>${basedir}/src/main/javadoc/javadoc.css</stylesheetfile>
+                    <overview>${basedir}/src/main/javadoc/overview.html</overview>
                     <groups>
                         <group>
                             <title>Spring-WS</title>

src/main/javadoc/javadoc.css

@@ -1,7 +1,7 @@
 /* Spring-specific Javadoc style sheet rules */
 
 #overviewBody {
-	
+
 }
 
 .code {
@@ -13,12 +13,12 @@
 /* Vanilla Javadoc style sheet rules */
 
 body {
-	font-family: Arial;
+	font-family: Helvetica, Arial, sans-serif;
 	background-color: white;
 	font-size: 10pt;
 }
 
-td { font-size: 10pt; font-family: Arial }/* Javadoc style sheet */
+td { font-size: 10pt; font-family: Helvetica, Arial, sans-serif }/* Javadoc style sheet */
 
 /* Define colors, fonts and other style attributes here to override the defaults */
 

src/main/javadoc/overview.html

@@ -0,0 +1,23 @@
+<html>
+<body>
+This document is the API specification for the Spring Web Services Framework
+<hr/>
+<div id="overviewBody">
+    <p>
+        For further API reference and developer documentation, see the
+        <a href="http://static.springframework.org/spring-ws/site/reference.html" target="_top">Spring
+            Web Services reference documentation</a>.
+        That documentation contains more detailed, developer-targeted
+        descriptions, with conceptual overviews, definitions of terms,
+        workarounds, and working code examples.
+    </p>
+
+    <p>
+        If you are interested in commercial training, consultancy, and
+        support for the Spring Web Services Framework,
+        <a href="http://www.interface21.com/" target="_top">Interface 21</a> provides
+        such commercial support.
+    </p>
+</div>
+</body>
+</html>

xml/pom.xml

@@ -10,6 +10,16 @@
     <packaging>jar</packaging>
     <name>Spring XML</name>
     <description>Various XML support classes for Spring Web Services</description>
+    <reporting>
+        <plugins>
+            <plugin>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <stylesheetfile>${basedir}/../src/main/javadoc/javadoc.css</stylesheetfile>
+                </configuration>
+            </plugin>
+        </plugins>
+    </reporting>
     <dependencies>
         <!-- XML handling dependencies -->
         <dependency>