From 5963a2d3d6860fe57afc138f095bf2d2eb5a7b80 Mon Sep 17 00:00:00 2001 From: lresende Date: Mon, 7 Oct 2013 22:23:21 +0000 Subject: Official Tuscany 2.0.1 Release git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@1530096 13f79535-47bb-0310-9956-ffa450edef68 --- .../learning-more/binding-comet/chat-webapp/README | 99 +++++++++++++++++++ .../binding-comet/chat-webapp/pom.xml | 81 +++++++++++++++ .../tuscany/sca/sample/comet/ChatService.java | 36 +++++++ .../tuscany/sca/sample/comet/ChatServiceImpl.java | 56 +++++++++++ .../src/main/webapp/META-INF/MANIFEST.MF | 2 + .../src/main/webapp/WEB-INF/web.composite | 37 +++++++ .../chat-webapp/src/main/webapp/WEB-INF/web.xml | 34 +++++++ .../chat-webapp/src/main/webapp/index.html | 109 +++++++++++++++++++++ 8 files changed, 454 insertions(+) create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/README create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/pom.xml create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatService.java create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatServiceImpl.java create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml create mode 100644 sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html (limited to 'sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp') diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/README b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/README new file mode 100644 index 0000000000..303c63146a --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/README @@ -0,0 +1,99 @@ +Tuscany - Learning More - Binding Comet - Chat Webapp +----------------------------------------------------------------- + +This sample demonstrates how Tuscany can expose services via Comet techniques +as well as how to interact with them using Tuscany's javascript toolkit. It +also demonstrates how to push multiple responses for a single request using +SCA callbacks via comet techniques. + +This project contains a service (ChatService) that handles chat operations like +register and postMessage. Once a client is registered it will receive messages +that are sent to the chat room. + +By adding to a service definition, the Tuscany runtime +will handle the communication between the browser client and the service +implementation using Comet techniques. This enables bidirectional communication +over HTTP, therefore enabling server push. For more information, check +http://en.wikipedia.org/wiki/Comet_(programming). + +The comet binding is using the Atmosphere Framework under the hood to acomodate +as many deployment envorinments as possible. Basically, it checks if the +application server supports Servlet 3.0 falling back to a number of native +comet solutions provided by vendors (Jetty, Tomcat, WebLogic, GlassFish and +others). If none is available, Atmosphere will fallback to blocking IO. + +In order to enable callbacks to push multiple responses, you need to declare the +CometCallback in the service definition as follows: + + + + + + +The callback object has methods that facilitate sending messages back to the +calling client. It can be injected in the service implementation using the @Callback +annotation. However, the service implementation for this sample has the COMPOSITE +scope so the callback reference has to be obtained from the ComponentContext. + +One requirement that service methods have to meet to enable multiple response +support is that they have to be annotated with @OneWay to enable non-blocking +support. Without it, methods are treated synchronously sending a single response +which is the object returned by the method call. + +Invoking comet services can be done using Tuscany's javascript API which simulates +SCA in the browser. It uses the Atmosphere jQuery plugin under the hood. In order +to use it, the following script has to be included in the client page: + + +The javascript toolkit permits choosing between two comet techniques: HTTP streaming +and long polling. More detailed information about them can be found on the previously +mentioned wikipedia page. + +First, a connect operation has to be issued in order to initiate communication +with the server side using the technique of your choice. This is done using the +connection method as follows: + SCA.TuscanyComet.connect('streaming'); // for HTTP streaming + SCA.TuscanyComet.connect('long-polling'); // for long polling + SCA.TuscanyComet.connect(); // starts with HTTP streaming and falls back to long polling if necessary + +The Tuscany Comet toolkit will inject proxies for all services defined in the composite +that are using binding.comet. All invocation and connection management is handled +under the hood so in order to invoke a comet service, the following should be called: + SCA.CometComponentContext..(, callback); + +The callback parameter is the function that will handle responses received for a +certain service operation. It has a single argument which is the response: + function callback(response) { + // handle response + }; + +Note that the data exchange is automatically handled by the binding, so parameters +will be mapped to the data types defined in the method definition. Also, the response +will have the same data type as the server side object used to wrap the response. +Objects are passed over the wire in JSON format. + +Another detail worth mentioning is that the binding will use a single HTTP +connection to handle communication between a browser client and all services +defined using binding.comet in the same composite. Requests and responses will get +multiplexed via the same channel and get routed to the appropriate service +implementation, respectively javascript function. This is done in order to avoid +the 2 HTTP connection limit imposed by browsers. For more info, check +http://www.openajax.org/runtime/wiki/The_Two_HTTP_Connection_Limit_Issue. + +In order to run the sample, you can execute "mvn clean install t7:run" which will +start a Tomcat 7 instance automatically or use "mvn package" and deploy the resulting +war to the application server of your choice. + +Next, point your browser at + http://localhost:8080/sample-binding-comet-chat-webapp/ + +You can now chat using multiple tabs or browsers. You can see the persistent HTTP +streaming connection or long polling subsequent connections using the developer tools +provided by your browser. + +The comet binding is an experimental binding so community feedback is much +appreciated. Feel free to send comments or suggestions on the Apache Tuscany +dev mailing list (dev@tuscany.apache.org). \ No newline at end of file diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/pom.xml b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/pom.xml new file mode 100644 index 0000000000..d83b1150fc --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/pom.xml @@ -0,0 +1,81 @@ + + + + 4.0.0 + + org.apache.tuscany.sca.samples + tuscany-samples-binding-comet + 2.0.1 + ../pom.xml + + + sample-binding-comet-chat-webapp + war + 2.0.1 + Apache Tuscany SCA Sample binding.comet Chat Webapp + + + + org.apache.tuscany.sca + tuscany-binding-comet-runtime + 2.0.1 + + + javax + javaee-web-api + 6.0 + provided + + + org.apache.tuscany.sca + tuscany-base-runtime-pom + 2.0.1 + pom + compile + + + com.google.guava + guava + r09 + jar + compile + + + + + + + com.googlecode.t7mp + maven-t7-plugin + 0.9.6 + + + + org.apache.tuscany.sca.samples + sample-binding-comet-chat-webapp + 2.0.1 + + + + + + + + diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatService.java b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatService.java new file mode 100644 index 0000000000..acb224715a --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatService.java @@ -0,0 +1,36 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.tuscany.sca.sample.comet; + +import org.apache.tuscany.sca.binding.comet.runtime.callback.CometCallback; +import org.oasisopen.sca.annotation.Callback; +import org.oasisopen.sca.annotation.OneWay; +import org.oasisopen.sca.annotation.Remotable; + +@Callback(CometCallback.class) +@Remotable +public interface ChatService { + + @OneWay + void register(); + + @OneWay + void postMessage(String user, String message); + +} diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatServiceImpl.java b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatServiceImpl.java new file mode 100644 index 0000000000..c4f3241c5b --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatServiceImpl.java @@ -0,0 +1,56 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.tuscany.sca.sample.comet; + +import java.util.ArrayList; +import java.util.concurrent.CopyOnWriteArrayList; + +import org.apache.tuscany.sca.binding.comet.runtime.callback.CometCallback; +import org.apache.tuscany.sca.binding.comet.runtime.callback.Status; +import org.oasisopen.sca.ComponentContext; +import org.oasisopen.sca.annotation.Context; +import org.oasisopen.sca.annotation.Scope; +import org.oasisopen.sca.annotation.Service; + +@Service(ChatService.class) +@Scope("COMPOSITE") +public class ChatServiceImpl implements ChatService { + + @Context + protected ComponentContext context; + + private CopyOnWriteArrayList clients = new CopyOnWriteArrayList(); + + @Override + public void postMessage(String user, String message) { + for (CometCallback callback : new ArrayList(clients)) { + Status status = callback.sendMessage(user + ": " + message); + if (status == Status.CLIENT_DISCONNECTED) { + clients.remove(callback); + } + } + } + + @Override + public void register() { + // saving the callback object during register() method so it will push data back to the client + // using the callback method defined for the register operation in the js when used + clients.add(context.getRequestContext(). getCallback()); + } +} diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..58630c02ef --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF @@ -0,0 +1,2 @@ +Manifest-Version: 1.0 + diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite new file mode 100644 index 0000000000..c535a38116 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml new file mode 100644 index 0000000000..25b06c457a --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml @@ -0,0 +1,34 @@ + + + + Apache Tuscany Stock Comet Sample + + tuscany + org.apache.tuscany.sca.host.webapp.TuscanyServletFilter + true + + + tuscany + /* + + + index.html + + \ No newline at end of file diff --git a/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html new file mode 100644 index 0000000000..1aa79ed0b6 --- /dev/null +++ b/sca-java-2.x/tags/2.0.1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html @@ -0,0 +1,109 @@ + + + + Apache Tuscany Comet Sample + + + + + + +

Apache Tuscany Comet Sample

+

Chat

+

+

+ + + + + + +
Nickname
+
+
+

Server notifications

+ + + + + + +
+
+ + -- cgit v1.2.3