svn commit: r740250 - in /webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy: builders/MTOM10AssertionBuilder.java builders/MTOM11AssertionBuilder.java model/MTOM10Assertion.java model/MTOM11Assertion.java model/MTOMAssertion.java

[na...@apache.org]

Author: nandana
Date: Tue Feb  3 09:12:23 2009
New Revision: 740250

URL: http://svn.apache.org/viewvc?rev=740250&view=rev
Log:
AXIS2-4220 applying javadoc patches. Thanks Dobri.

Modified:
    webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM10AssertionBuilder.java
    webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM11AssertionBuilder.java
    webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM10Assertion.java
    webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM11Assertion.java
    webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOMAssertion.java

Modified: webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM10AssertionBuilder.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM10AssertionBuilder.java?rev=740250&r1=740249&r2=740250&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM10AssertionBuilder.java (original)
+++ webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM10AssertionBuilder.java Tue Feb  3 09:12:23 2009
@@ -38,6 +38,8 @@
 import javax.xml.namespace.QName;
 
 /**
+ * This builder is responsible for the creation of a MTOM assertion object </br>
+ * (compliant with the WS-MTOMPolicy verion 1.0).
  * The builder will be picked by the
  * "org.apache.neethi.AssertionBuilderFactory".
  */

Modified: webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM11AssertionBuilder.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM11AssertionBuilder.java?rev=740250&r1=740249&r2=740250&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM11AssertionBuilder.java (original)
+++ webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/builders/MTOM11AssertionBuilder.java Tue Feb  3 09:12:23 2009
@@ -32,6 +32,13 @@
 import org.apache.neethi.Constants;
 import org.apache.neethi.builders.AssertionBuilder;
 
+/**
+ * This builder is responsible for the creation of a MTOM assertion object </br>
+ * (compliant with the WS-MTOMPolicy verion 1.1).
+ * The builder will be picked by the
+ * "org.apache.neethi.AssertionBuilderFactory".
+ */
+
 public class MTOM11AssertionBuilder implements AssertionBuilder{
     
     private static Log log = LogFactory.getLog(MTOM10AssertionBuilder.class);

Modified: webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM10Assertion.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM10Assertion.java?rev=740250&r1=740249&r2=740250&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM10Assertion.java (original)
+++ webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM10Assertion.java Tue Feb  3 09:12:23 2009
@@ -28,8 +28,9 @@
 import org.apache.neethi.PolicyComponent;
 
 /**
- * Assertion to pick up the QName <wsoma:OptimizedMimeSerialization
- * xmlns:wsoma="http://schemas.xmlsoap.org/ws/2004/09/policy/optimizedmimeserialization"/>
+ * Assertion to pick up the QName &ltwsoma:OptimizedMimeSerialization
+ * xmlns:wsoma="http://schemas.xmlsoap.org/ws/2004/09/policy/optimizedmimeserialization"/&gt  which is compliant <br>
+ * with the WS-MTOMPolicy verion 1.0.
  */
 public class MTOM10Assertion extends MTOMAssertion {
 

Modified: webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM11Assertion.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM11Assertion.java?rev=740250&r1=740249&r2=740250&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM11Assertion.java (original)
+++ webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOM11Assertion.java Tue Feb  3 09:12:23 2009
@@ -27,6 +27,12 @@
 import org.apache.neethi.Constants;
 import org.apache.neethi.PolicyComponent;
 
+/**
+ * Assertion to pick up the QName &ltwsoma:MTOM
+ * xmlns:wsoma="http://www.w3.org/2007/08/soap12-mtom-policy"/&gt which is compliant </br>
+ * with the WS-MTOMPolicy verion 1.1.
+ */
+
 public class MTOM11Assertion extends MTOMAssertion {
 
     // creating a logger instance

Modified: webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOMAssertion.java
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOMAssertion.java?rev=740250&r1=740249&r2=740250&view=diff
==============================================================================
--- webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOMAssertion.java (original)
+++ webservices/axis2/trunk/java/modules/mtompolicy/src/org/apache/axis2/policy/model/MTOMAssertion.java Tue Feb  3 09:12:23 2009
@@ -21,14 +21,33 @@
 
 import org.apache.neethi.Assertion;
 
+/**
+ * 
+ * This abstract class specifies the common features of a MTOM assertion. 
+ *
+ */
 public abstract class MTOMAssertion implements Assertion {
 
+	/** Specifies if the MTOM assertion is optional. The request can be MTOMised or non-MTOMised,</br>
+	 *  but the response will be MTOMised only if request is MTOMised. */
     protected boolean optional = false;
     
+    /**
+     * Checks if the MTOM assertion is optional. The request can be MTOMised or non-MTOMised,</br>
+	 * but the response will be MTOMised only if request is MTOMised.
+	 * 
+	 * @return <code>true</code> if the MTOM assertion is optional, otherwise returns <code>false</code>.
+     */
     public boolean isOptional() {
         return optional;
     }
     
+    /**
+     * Sets the <code>optional</code> parameter.  
+     * 
+     * @param isOptional sets if the MTOM assertion is optional or not. If set to <code>true</code> </br>
+     * then if the request is MTOMised then the response should be MTOMised, too.
+     */
     public void setOptional(boolean isOptional) {
         this.optional = isOptional;
     }