You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by fm...@apache.org on 2010/08/16 08:38:58 UTC

svn commit: r985812 - in /tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src: main/java/org/apache/tuscany/sca/binding/comet/runtime/ test/java/org/apache/tuscany/sca/test/

Author: fmoga
Date: Mon Aug 16 06:38:58 2010
New Revision: 985812

URL: http://svn.apache.org/viewvc?rev=985812&view=rev
Log:
Added javadocs.

Modified:
    tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometBindingProviderFactory.java
    tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometInvoker.java
    tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometReferenceBindingProvider.java
    tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/test/java/org/apache/tuscany/sca/test/CometTest.java

Modified: tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometBindingProviderFactory.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometBindingProviderFactory.java?rev=985812&r1=985811&r2=985812&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometBindingProviderFactory.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometBindingProviderFactory.java Mon Aug 16 06:38:58 2010
@@ -29,10 +29,19 @@ import org.apache.tuscany.sca.provider.S
 import org.apache.tuscany.sca.runtime.RuntimeEndpoint;
 import org.apache.tuscany.sca.runtime.RuntimeEndpointReference;
 
+/**
+ * Factory for binding providers.
+ */
 public class CometBindingProviderFactory implements BindingProviderFactory<CometBinding> {
 
+    /**
+     * Underlying servlet host. Injected by constructor.
+     */
     private ServletHost servletHost;
 
+    /**
+     * Constructor.
+     */
     public CometBindingProviderFactory(ExtensionPointRegistry extensionPoints) {
         this.servletHost = ServletHostHelper.getServletHost(extensionPoints);
     }
@@ -41,10 +50,16 @@ public class CometBindingProviderFactory
         return CometBinding.class;
     }
 
+    /**
+     * Creates a provider for a reference that has comet binding specified in the scdl.
+     */
     public ReferenceBindingProvider createReferenceBindingProvider(RuntimeEndpointReference endpoint) {
         return new CometReferenceBindingProvider(endpoint);
     }
 
+    /**
+     * Creates a provider for a service that has comet binding specified in the scdl.
+     */
     public ServiceBindingProvider createServiceBindingProvider(RuntimeEndpoint endpoint) {
         return new CometServiceBindingProvider(endpoint, servletHost);
     }

Modified: tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometInvoker.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometInvoker.java?rev=985812&r1=985811&r2=985812&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometInvoker.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometInvoker.java Mon Aug 16 06:38:58 2010
@@ -24,8 +24,12 @@ import org.apache.tuscany.sca.interfaced
 import org.apache.tuscany.sca.invocation.Invoker;
 import org.apache.tuscany.sca.invocation.Message;
 
+/**
+ * Invoker for a service binding. Invoking is made from client Javascript so no
+ * behavior is needed.
+ */
 public class CometInvoker implements Invoker {
-    
+
     protected Operation operation;
     protected EndpointReference endpoint;
 
@@ -34,6 +38,9 @@ public class CometInvoker implements Inv
         this.endpoint = endpoint;
     }
 
+    /**
+     * No behavior.
+     */
     public Message invoke(Message msg) {
         return null;
     }

Modified: tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometReferenceBindingProvider.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometReferenceBindingProvider.java?rev=985812&r1=985811&r2=985812&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometReferenceBindingProvider.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/main/java/org/apache/tuscany/sca/binding/comet/runtime/CometReferenceBindingProvider.java Mon Aug 16 06:38:58 2010
@@ -25,6 +25,10 @@ import org.apache.tuscany.sca.interfaced
 import org.apache.tuscany.sca.invocation.Invoker;
 import org.apache.tuscany.sca.provider.ReferenceBindingProvider;
 
+/**
+ * Provider for references that have comet binding specified in the scdl.
+ * Not used as comet binding references would occur in client browser's Javascript.
+ */
 public class CometReferenceBindingProvider implements ReferenceBindingProvider {
 
     private EndpointReference endpoint;
@@ -32,13 +36,20 @@ public class CometReferenceBindingProvid
     public CometReferenceBindingProvider(EndpointReference endpoint) {
         this.endpoint = endpoint;
     }
+    
     public Invoker createInvoker(Operation operation) {
         return new CometInvoker(operation, endpoint);
     }
 
+    /**
+     * No behavior.
+     */
     public void start() {
     }
 
+    /**
+     * No behavior.
+     */
     public void stop() {
     }
 

Modified: tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/test/java/org/apache/tuscany/sca/test/CometTest.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/test/java/org/apache/tuscany/sca/test/CometTest.java?rev=985812&r1=985811&r2=985812&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/test/java/org/apache/tuscany/sca/test/CometTest.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-comet-runtime/src/test/java/org/apache/tuscany/sca/test/CometTest.java Mon Aug 16 06:38:58 2010
@@ -26,6 +26,9 @@ import org.apache.tuscany.sca.node.Contr
 import org.apache.tuscany.sca.node.Node;
 import org.apache.tuscany.sca.node.NodeFactory;
 
+/**
+ * Test for node startup. 
+ */
 public class CometTest extends TestCase {
 
     public void testComet() {