You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@synapse.apache.org by ve...@apache.org on 2008/05/03 01:31:17 UTC
svn commit: r652948 - in
/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse:
config/xml/endpoints/ endpoints/ endpoints/utils/
Author: veithen
Date: Fri May 2 16:31:17 2008
New Revision: 652948
URL: http://svn.apache.org/viewvc?rev=652948&view=rev
Log:
Improved documentation of AddressEndpoint(Factory|Serializer).
Modified:
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointFactory.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointSerializer.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/AddressEndpoint.java
synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/utils/EndpointDefinition.java
Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointFactory.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointFactory.java?rev=652948&r1=652947&r2=652948&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointFactory.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointFactory.java Fri May 2 16:31:17 2008
@@ -33,24 +33,27 @@
import javax.xml.namespace.QName;
/**
- * Creates AddressEndpoint using a XML configuration.
+ * Creates {@link AddressEndpoint} using a XML configuration.
+ * <p>
+ * Configuration syntax:
+ * <pre>
+ * <endpoint [name="<em>name</em>"] [trace="enable|disable"]>
+ * <address uri="<em>url</em>" [format="soap11|soap12|pox|get"] [optimize="mtom|swa"] [statistics="enable|disable"]>
+ * .. extensibility ..
*
- * <endpoint [name="name"] [trace="enable|disable"]>
- * <suspendDurationOnFailue>suspend-duration</suspendDurationOnFailue>
- * <address uri="url" [format="soap11|soap12|pox"] [optimize="mtom|swa"]>
- * .. extensibility ..
+ * <enableRM [policy="<em>key</em>"]/>?
+ * <enableSec [policy="<em>key</em>"]/>?
+ * <enableAddressing [version="final|submission"] [separateListener="true|false"]/>?
*
- * <timeout>
- * <duration>duration in milliseconds</duration>
- * <action>discard | fault</action>
- * </timeout>?
+ * <timeout>
+ * <duration><em>timeout duration in seconds</em></duration>
+ * <action>discard|fault</action>
+ * </timeout>?
*
- * <enableRM [policy="key"]/>?
- * <enableSec [policy="key"]/>?
- * <enableAddressing [version=("final" | "submission")]/>?
- * <suspendDurationOnFailure>suspend-duration</suspendDurationOnFailure>?
- * </address>
- * </endpoint>
+ * <suspendDurationOnFailure><em>suspend duration in seconds</em></suspendDurationOnFailure>?
+ * </address>
+ * </endpoint>
+ * </pre>
*/
public class AddressEndpointFactory implements EndpointFactory {
Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointSerializer.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointSerializer.java?rev=652948&r1=652947&r2=652948&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointSerializer.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/config/xml/endpoints/AddressEndpointSerializer.java Fri May 2 16:31:17 2008
@@ -31,34 +31,9 @@
import org.apache.commons.logging.LogFactory;
/**
- * Serializes AddressEndpoint to XML.
- *
- * <endpoint [name="name"]>
- * <suspendDurationOnFailue>suspend-duration</suspendDurationOnFailue>
- * <address uri="url">
- *
- * .. extensibility ..
- *
- * <!-- Axis2 Rampart configurations : may be obsolete soon -->
- * <parameter name="OutflowSecurity">
- * ...
- * </parameter>+
- *
- * <wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"..>
- * ...
- * </Policy>+
- *
- * <enableRM/>?
- * <enableSec/>?
- * <enableAddressing [version=("fianl" | "submission")]/>?
- *
- * <timeout>
- * <duration>duration in milliseconds</duration>
- * <action>discard | fault</action>
- * </timeout>
- *
- * </address>
- * </endpoint>
+ * Serializes {@link AddressEndpoint} to XML.
+ *
+ * @see AddressEndpointFactory
*/
public class AddressEndpointSerializer implements EndpointSerializer {
Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/AddressEndpoint.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/AddressEndpoint.java?rev=652948&r1=652947&r2=652948&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/AddressEndpoint.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/AddressEndpoint.java Fri May 2 16:31:17 2008
@@ -248,6 +248,11 @@
return suspendOnFailDuration;
}
+ /**
+ * Set the suspend on fail duration.
+ *
+ * @param suspendOnFailDuration a duration in milliseconds
+ */
public void setSuspendOnFailDuration(long suspendOnFailDuration) {
this.suspendOnFailDuration = suspendOnFailDuration;
}
Modified: synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/utils/EndpointDefinition.java
URL: http://svn.apache.org/viewvc/synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/utils/EndpointDefinition.java?rev=652948&r1=652947&r2=652948&view=diff
==============================================================================
--- synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/utils/EndpointDefinition.java (original)
+++ synapse/trunk/java/modules/core/src/main/java/org/apache/synapse/endpoints/utils/EndpointDefinition.java Fri May 2 16:31:17 2008
@@ -301,6 +301,11 @@
return timeoutDuration;
}
+ /**
+ * Set the timeout duration.
+ *
+ * @param timeoutDuration a duration in milliseconds
+ */
public void setTimeoutDuration(long timeoutDuration) {
this.timeoutDuration = timeoutDuration;
}