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 2011/07/25 18:29:02 UTC
svn commit: r1150769 - in
/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket:
./ runtime/
Author: fmoga
Date: Mon Jul 25 16:28:59 2011
New Revision: 1150769
URL: http://svn.apache.org/viewvc?rev=1150769&view=rev
Log:
Improve source code documentation on the websocket binding.
Modified:
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/WebsocketBindingFactory.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JSONUtil.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptResourceServlet.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/TuscanyWebsocket.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingCallback.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingDispatcher.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingMessage.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingProviderFactory.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketCallbackInvoker.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketConnectionManager.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketReferenceBindingProvider.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServer.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceBindingProvider.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceInvoker.java
tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketStatus.java
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/WebsocketBindingFactory.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/WebsocketBindingFactory.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/WebsocketBindingFactory.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/WebsocketBindingFactory.java Mon Jul 25 16:28:59 2011
@@ -20,7 +20,7 @@
package org.apache.tuscany.sca.binding.websocket;
/**
- * Factory implementation to create Websocket Models
+ * Factory implementation to create Websocket models.
*/
public class WebsocketBindingFactory {
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JSONUtil.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JSONUtil.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JSONUtil.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JSONUtil.java Mon Jul 25 16:28:59 2011
@@ -27,32 +27,27 @@ import org.apache.tuscany.sca.interfaced
import com.google.gson.Gson;
/**
- * Helper class to facilitate JSON convertions.
+ * Utility class to handle JSON convertions.
*/
public class JSONUtil {
private static Gson gson = new Gson();
- public static String encodeMessage(WebsocketBindingMessage request) {
- return gson.toJson(request);
+ public static String encodeMessage(WebsocketBindingMessage message) {
+ return gson.toJson(message);
}
- public static WebsocketBindingMessage decodeMessage(String jsonRequest) {
- return gson.fromJson(jsonRequest, WebsocketBindingMessage.class);
+ public static WebsocketBindingMessage decodeMessage(String jsonMessage) {
+ return gson.fromJson(jsonMessage, WebsocketBindingMessage.class);
}
public static String encodePayload(Object payload) {
return gson.toJson(payload);
}
-
+
/**
- * Convert request parameters from JSON to operation parameter types.
- *
- * @param jsonData
- * parameters in JSON array format
- * @param operation
- * the operation to invoke
- * @return an array of objects
+ * Convert opeartion parameters from JSON to the appropriate parameter
+ * types.
*/
public static Object[] decodePayloadForOperation(String jsonData, Operation operation) {
Object[] args = new Object[operation.getInputType().getLogical().size()];
@@ -66,14 +61,10 @@ public class JSONUtil {
}
/**
- * Split the JSON array containing the arguments for the method call in
- * order to avoid converting JSON to Object[]. Converting each object
- * separately to it's corresponding type avoids type mismatch problems at
- * service invocation.
- *
- * @param jsonArray
- * the JSON array
- * @return an array of JSON formatted strings
+ * Split the JSON array containing the arguments for the opeartion in order
+ * to avoid converting JSON to Object[]. Converting each object separately
+ * to it's corresponding data type avoids type mismatch problems at service
+ * invocation.
*/
private static String[] parseArray(String jsonArray) {
List<String> objects = new ArrayList<String>();
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptGenerator.java Mon Jul 25 16:28:59 2011
@@ -42,12 +42,20 @@ import java.util.List;
import org.apache.tuscany.sca.interfacedef.Operation;
+/**
+ * Generates javascript service proxies using the websocket API. This enables
+ * simulating SCA on the client side javascript. This is a stateful singleton.
+ */
public class JavascriptGenerator {
private final static String CONTEXT = "this.WebsocketComponentContext";
private static final String LF = "\n";
private static StringBuilder builder = new StringBuilder();
+ /**
+ * Generate javascript code for one service and all it's operations. Add
+ * this to the state of the generator.
+ */
public static void generateServiceProxy(String component, String service, List<Operation> operations, int port) {
if (builder.length() == 0) {
builder.append(CONTEXT).append("={};").append(LF);
@@ -85,10 +93,16 @@ public class JavascriptGenerator {
return content;
}
+ /**
+ * Get the state of the generator.
+ */
public static String getServiceProxies() {
return builder.toString();
}
+ /**
+ * Reset the state of the generator.
+ */
public static void clear() {
builder.setLength(0);
}
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptResourceServlet.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptResourceServlet.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptResourceServlet.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/JavascriptResourceServlet.java Mon Jul 25 16:28:59 2011
@@ -49,6 +49,9 @@ import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+/**
+ * This servlet serves the generated javascript service proxies.
+ */
public class JavascriptResourceServlet extends HttpServlet {
private static final String WEBSOCKET_TOOLKIT_PATH = "js/TuscanyWebsocketToolkit.js";
@@ -76,6 +79,9 @@ public class JavascriptResourceServlet e
return websocketToolkit;
}
+ /**
+ * Read a resource from the disk by relative path.
+ */
private String getResource(String path) {
InputStream is = getClass().getClassLoader().getResourceAsStream(path);
BufferedReader r = new BufferedReader(new InputStreamReader(is));
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/TuscanyWebsocket.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/TuscanyWebsocket.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/TuscanyWebsocket.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/TuscanyWebsocket.java Mon Jul 25 16:28:59 2011
@@ -24,6 +24,12 @@ import java.util.UUID;
import org.eclipse.jetty.websocket.WebSocket;
+/**
+ * A websocket connection handling communication between one browser client and
+ * *all* websocket services hosted by a server. The connection is persisted as
+ * long as the client is connected and communication with all services is
+ * multiplexed via a single websocket connection.
+ */
public class TuscanyWebsocket implements WebSocket, WebSocket.OnTextMessage {
private String id;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingCallback.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingCallback.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingCallback.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingCallback.java Mon Jul 25 16:28:59 2011
@@ -20,6 +20,9 @@ package org.apache.tuscany.sca.binding.w
import org.oasisopen.sca.annotation.Remotable;
+/**
+ * Interface describing the websocket binding callback to a browser client.
+ */
@Remotable
public interface WebsocketBindingCallback {
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingDispatcher.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingDispatcher.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingDispatcher.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingDispatcher.java Mon Jul 25 16:28:59 2011
@@ -24,12 +24,15 @@ import java.util.Map;
import org.apache.tuscany.sca.interfacedef.Operation;
import org.apache.tuscany.sca.runtime.RuntimeEndpoint;
+/**
+ * A dispatcher stores all service invokers for a servers and is used to
+ * determine which one of them should be used when a request comes in.
+ */
public class WebsocketBindingDispatcher {
private Map<String, WebsocketServiceInvoker> invokers = new HashMap<String, WebsocketServiceInvoker>();
public void addOperation(String uri, RuntimeEndpoint endpoint, Operation operation) {
- System.out.println("Adding " + uri);
invokers.put(uri, new WebsocketServiceInvoker(operation, endpoint));
}
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingMessage.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingMessage.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingMessage.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingMessage.java Mon Jul 25 16:28:59 2011
@@ -18,6 +18,9 @@
*/
package org.apache.tuscany.sca.binding.websocket.runtime;
+/**
+ * The websocket binding message structure.
+ */
public class WebsocketBindingMessage {
private String operation;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingProviderFactory.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingProviderFactory.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingProviderFactory.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketBindingProviderFactory.java Mon Jul 25 16:28:59 2011
@@ -29,6 +29,9 @@ import org.apache.tuscany.sca.provider.S
import org.apache.tuscany.sca.runtime.RuntimeEndpoint;
import org.apache.tuscany.sca.runtime.RuntimeEndpointReference;
+/**
+ * Factory for reference and service binding providers.
+ */
public class WebsocketBindingProviderFactory implements BindingProviderFactory<WebsocketBinding> {
private ServletHost servletHost;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketCallbackInvoker.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketCallbackInvoker.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketCallbackInvoker.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketCallbackInvoker.java Mon Jul 25 16:28:59 2011
@@ -26,6 +26,10 @@ import org.apache.tuscany.sca.interfaced
import org.apache.tuscany.sca.invocation.Invoker;
import org.apache.tuscany.sca.invocation.Message;
+/**
+ * The callback invoker is used to send asynchronous responses back to the
+ * browser client.
+ */
public class WebsocketCallbackInvoker implements Invoker {
protected Operation operation;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketConnectionManager.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketConnectionManager.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketConnectionManager.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketConnectionManager.java Mon Jul 25 16:28:59 2011
@@ -22,6 +22,11 @@ package org.apache.tuscany.sca.binding.w
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
+/**
+ * The connection manager stores all active websocket connections in order to be
+ * able to retrieve the appropriate communication channel when an asynchronous
+ * response is sent.
+ */
public class WebsocketConnectionManager {
private static ConcurrentMap<String, TuscanyWebsocket> activeConnections = new ConcurrentHashMap<String, TuscanyWebsocket>();
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketReferenceBindingProvider.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketReferenceBindingProvider.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketReferenceBindingProvider.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketReferenceBindingProvider.java Mon Jul 25 16:28:59 2011
@@ -25,6 +25,12 @@ import org.apache.tuscany.sca.interfaced
import org.apache.tuscany.sca.invocation.Invoker;
import org.apache.tuscany.sca.provider.ReferenceBindingProvider;
+/**
+ * The reference binding provider is used to initiate the necessary
+ * infrastructure on the reference side. As the binding only supports browser
+ * clients, the reference binding provider is used as a factory for callback
+ * invokers.
+ */
public class WebsocketReferenceBindingProvider implements ReferenceBindingProvider {
private EndpointReference endpoint;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServer.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServer.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServer.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServer.java Mon Jul 25 16:28:59 2011
@@ -28,6 +28,10 @@ import org.eclipse.jetty.server.nio.Sele
import org.eclipse.jetty.websocket.WebSocket;
import org.eclipse.jetty.websocket.WebSocketHandler;
+/**
+ * The websocket server is an embedded Jetty instance which will be started on
+ * the port specified in the component definition.
+ */
public class WebsocketServer extends Server {
private WebsocketBindingDispatcher dispatcher;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceBindingProvider.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceBindingProvider.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceBindingProvider.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceBindingProvider.java Mon Jul 25 16:28:59 2011
@@ -29,6 +29,10 @@ import org.apache.tuscany.sca.interfaced
import org.apache.tuscany.sca.provider.ServiceBindingProvider;
import org.apache.tuscany.sca.runtime.RuntimeEndpoint;
+/**
+ * The service binding provider initiates the necessary infrastructure to expose
+ * services via websockets.
+ */
public class WebsocketServiceBindingProvider implements ServiceBindingProvider {
private static final int DEFAULT_PORT = 9000;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceInvoker.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceInvoker.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceInvoker.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketServiceInvoker.java Mon Jul 25 16:28:59 2011
@@ -49,6 +49,10 @@ import org.apache.tuscany.sca.interfaced
import org.apache.tuscany.sca.invocation.Message;
import org.apache.tuscany.sca.runtime.RuntimeEndpoint;
+/**
+ * The service invoker is used to call an operation implementation in a
+ * synchronous or asynchronous way.
+ */
public class WebsocketServiceInvoker {
protected Operation operation;
Modified: tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketStatus.java
URL: http://svn.apache.org/viewvc/tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketStatus.java?rev=1150769&r1=1150768&r2=1150769&view=diff
==============================================================================
--- tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketStatus.java (original)
+++ tuscany/sca-java-2.x/contrib/modules/binding-websocket/src/main/java/org/apache/tuscany/sca/binding/websocket/runtime/WebsocketStatus.java Mon Jul 25 16:28:59 2011
@@ -1,5 +1,9 @@
package org.apache.tuscany.sca.binding.websocket.runtime;
+/**
+ * The websocket status indicates the state of a websocket connection when a
+ * send operation is performed.
+ */
public enum WebsocketStatus {
OPEN, CLOSED
}