synapse-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From p..@apache.org
Subject svn commit: r355794 - /incubator/synapse/trunk/java/src/org/apache/synapse/SynapseEnvironment.java
Date Sat, 10 Dec 2005 23:06:00 GMT
Author: pzf
Date: Sat Dec 10 15:05:58 2005
New Revision: 355794

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

Modified:
    incubator/synapse/trunk/java/src/org/apache/synapse/SynapseEnvironment.java

Modified: incubator/synapse/trunk/java/src/org/apache/synapse/SynapseEnvironment.java
URL: http://svn.apache.org/viewcvs/incubator/synapse/trunk/java/src/org/apache/synapse/SynapseEnvironment.java?rev=355794&r1=355793&r2=355794&view=diff
==============================================================================
--- incubator/synapse/trunk/java/src/org/apache/synapse/SynapseEnvironment.java (original)
+++ incubator/synapse/trunk/java/src/org/apache/synapse/SynapseEnvironment.java Sat Dec 10
15:05:58 2005
@@ -20,14 +20,65 @@
  *
  * 
  * <p>Common stuff needed to embed Synapse into a given runtime (e.g. Axis2) 
+ * <p>This interface is used by the processors, and also by EnvironmentAware mediators
+ * 
+ *
+ */
+/**
+ * @author Paul
  *
  */
 public interface SynapseEnvironment {
+	
+	/* 
+	 * This method injects a new message into the Synapse engine
+	 * It is used in a couple of ways. Firstly, this is how, for example, 
+	 * Axis2 kicks messages into Synapse to start with.
+	 * <p>
+	 * Also mediators can use this to send messages that they want to be mediated by Synapse
+	 * <p>For example if you want to send a copy of a message somewhere, you can clone
it and then 
+	 * injectMessage() 
+	 */
 	public void injectMessage(SynapseMessage smc);
+	
+	/*
+	 * Processors or Mediators that wish to load classes should use the ClassLoader given here
+	 */
 	public ClassLoader getClassLoader();
+	
+	
+	/**
+	 * This method allows you send messages on. As opposed to injectMessage send message does
not 
+	 * process these through Synapse.
+	 * <p>
+	 * This will send request messages on, and send response messages back to the client
+	 */
 	public void send(SynapseMessage smc);
+	
+	
+	/**
+	 * This is used by the references to find a processor with a given name
+	 * 
+	 */
 	public Processor lookupProcessor(String name);
+	
+	
+	/**
+	 * This is how you add a processor to the list of processors. The name which it can be
+	 * retrieved by is the processor.getName()
+	 */
 	public void addProcessor(Processor p);
+	
+	
+	/**
+	 * This returns the "Master Processor" which is the root processor for this instance of

+	 * Synapse. Usually this would be the processor derived from &ltsynapse>.  
+	 */
 	public Processor getMasterProcessor();
+	
+	
+	/**
+	 * This sets the root processor for the engine. 
+	 */
 	public void setMasterProcessor(Processor p);
 }



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


Mime
View raw message