You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicemix.apache.org by gn...@apache.org on 2007/10/24 12:05:49 UTC

svn commit: r587845 - in /incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api: Endpoint.java Pattern.java Role.java Status.java event/EndpointListener.java

Author: gnodet
Date: Wed Oct 24 03:05:47 2007
New Revision: 587845

URL: http://svn.apache.org/viewvc?rev=587845&view=rev
Log:
Add some javadocs

Modified:
    incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Endpoint.java
    incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Pattern.java
    incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Role.java
    incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Status.java
    incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/event/EndpointListener.java

Modified: incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Endpoint.java
URL: http://svn.apache.org/viewvc/incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Endpoint.java?rev=587845&r1=587844&r2=587845&view=diff
==============================================================================
--- incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Endpoint.java (original)
+++ incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Endpoint.java Wed Oct 24 03:05:47 2007
@@ -54,6 +54,11 @@
     String WSDL_URL = "WSDL_URL";
 
     /**
+     * Meta-data for the version number of this endpoint
+     */
+    String VERSION = "VERSION";
+
+    /**
      * Set the channel so that the endpoint can send exchanges back
      * when they are processed or act as a consumer itself.
      * This method will be called by the NMR while the endpoint is registered.

Modified: incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Pattern.java
URL: http://svn.apache.org/viewvc/incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Pattern.java?rev=587845&r1=587844&r2=587845&view=diff
==============================================================================
--- incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Pattern.java (original)
+++ incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Pattern.java Wed Oct 24 03:05:47 2007
@@ -33,7 +33,7 @@
     InOptionalOut;
 
 
-    protected static final Map<String, Pattern> map = new HashMap<String, Pattern>();
+    protected static final Map<String, Pattern> map;
 
     /**
      * Returns the WSDL URI for this message exchange pattern
@@ -63,6 +63,7 @@
     }
 
     static {
+        map = new HashMap<String, Pattern>();
         for (Pattern mep : values()) {
             String uri = mep.getWsdlUri();
             map.put(uri, mep);

Modified: incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Role.java
URL: http://svn.apache.org/viewvc/incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Role.java?rev=587845&r1=587844&r2=587845&view=diff
==============================================================================
--- incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Role.java (original)
+++ incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Role.java Wed Oct 24 03:05:47 2007
@@ -24,6 +24,10 @@
  * @since 4.0
  */
 public enum Role {
+
+    /** The endpoint processing the exchange is the consumer */
     Consumer,
+
+    /** The endpoint processing the exchange is the provider */
     Provider,
 }

Modified: incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Status.java
URL: http://svn.apache.org/viewvc/incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Status.java?rev=587845&r1=587844&r2=587845&view=diff
==============================================================================
--- incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Status.java (original)
+++ incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/Status.java Wed Oct 24 03:05:47 2007
@@ -23,7 +23,13 @@
  * @since 4.0
  */
 public enum Status {
-    Active, 
-    Done, 
+
+    /** The exchange is active */
+    Active,
+
+    /** The exchange is terminated */
+    Done,
+
+    /** The exchange is terminated with an error */
     Error,
 }

Modified: incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/event/EndpointListener.java
URL: http://svn.apache.org/viewvc/incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/event/EndpointListener.java?rev=587845&r1=587844&r2=587845&view=diff
==============================================================================
--- incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/event/EndpointListener.java (original)
+++ incubator/servicemix/branches/servicemix-4.0/api/src/main/java/org/apache/servicemix/api/event/EndpointListener.java Wed Oct 24 03:05:47 2007
@@ -19,10 +19,25 @@
 import org.apache.servicemix.api.Endpoint;
 
 
+/**
+ * A specific kind of Listener that will receive events
+ * about new registered endpoints or endpoints being
+ * unregistered.
+ */
 public interface EndpointListener extends Listener {
 
+    /**
+     * An endpoint has been registered
+     *
+     * @param endpoint the registered endpoint
+     */
     void endpointRegistered(Endpoint endpoint);
-    
+
+    /**
+     * An endpoint has been unregistered
+     *
+     * @param endpoint the unregistered endpoint
+     */
     void endpointUnregistered(Endpoint endpoint);
     
 }