svn commit: r355871 - in /incubator/synapse/trunk/java/src/org/apache/synapse: Processor.java SynapseMessage.java

[pz...@apache.org]

Author: pzf
Date: Sat Dec 10 18:10:24 2005
New Revision: 355871

URL: http://svn.apache.org/viewcvs?rev=355871&view=rev
Log:
updated javadoc

Modified:
    incubator/synapse/trunk/java/src/org/apache/synapse/Processor.java
    incubator/synapse/trunk/java/src/org/apache/synapse/SynapseMessage.java

Modified: incubator/synapse/trunk/java/src/org/apache/synapse/Processor.java
URL: http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/src/org/apache/synapse/Processor.java?rev=355871&r1=355870&r2=355871&view=diff
==============================================================================
--- incubator/synapse/trunk/java/src/org/apache/synapse/Processor.java (original)
+++ incubator/synapse/trunk/java/src/org/apache/synapse/Processor.java Sat Dec 10 18:10:24 2005
@@ -18,17 +18,41 @@
 
 
 /**
- *
+ * Processors are the main extension mechanism for Synapse. 
+ * <p>
+ * A Processor together with the XML ProcessorConfigurator extends both the synapse.xml 
+ * and the actual processing power of Synapse.
+ * <p>
+ * Some of the processors are "builtin" and those are defined in the ProcessorConfiguratorFinder
+ * <p>
+ * Other processors can be registered using the JAR Service Provider model:
+ * <br><a href="http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider">http://java.sun.com/j2se/1.3/docs/guide/jar/jar.html#Service%20Provider</a><p>
  * 
  * The processor then deals with a message. It returns false if no further
  * processing is desired. It can have a name (or null)
- * 
+ * <p>
  * Processors can either devolve processing to other processors (e.g. a rule,
  * stage, etc) or deal with the message itself (e.g. mediator)
  * 
  */
 public interface Processor {
+	
+	
+	/**
+	 * This method is used to process a message. A response of true indicates continue processing.
+	 * A response of false indicates to stop processing.
+	 */
 	public boolean process(SynapseEnvironment se, SynapseMessage sm);
+	
+	
+	/**
+	 * the name of the instance of this processor
+	 */
 	public String getName();
+	
+	
+	/**
+	 * set the name of the instance of the processor
+	 */
 	public void setName(String name);
 }

Modified: incubator/synapse/trunk/java/src/org/apache/synapse/SynapseMessage.java
URL: http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/src/org/apache/synapse/SynapseMessage.java?rev=355871&r1=355870&r2=355871&view=diff
==============================================================================
--- incubator/synapse/trunk/java/src/org/apache/synapse/SynapseMessage.java (original)
+++ incubator/synapse/trunk/java/src/org/apache/synapse/SynapseMessage.java Sat Dec 10 18:10:24 2005
@@ -24,8 +24,14 @@
 /**
  *
  * 
- * <p> The core definition of a message flowing thru Axis.
- *
+ * <p> The core definition of a message flowing thru Synapse.
+ * <p> The aim of this is to capture the Message Addressing Properties
+ * (aka Message Information Headers) and the SOAP Envelope. 
+ * The core To/From/FaultTo/ReplyTo/MessageID/RelatesTo stuff is here. <p>
+ * In addition this has get/setEnvelope.
+ * <p>
+ *  There is also a bag of properties<p>
+ *  There are markers for whether we support REST, MTOM and also if this is a response or not
  */
 public interface SynapseMessage {
 



---------------------------------------------------------------------
To unsubscribe, e-mail: synapse-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: synapse-dev-help@ws.apache.org