diff options
author | lresende <lresende@13f79535-47bb-0310-9956-ffa450edef68> | 2013-10-07 22:23:21 +0000 |
---|---|---|
committer | lresende <lresende@13f79535-47bb-0310-9956-ffa450edef68> | 2013-10-07 22:23:21 +0000 |
commit | 5963a2d3d6860fe57afc138f095bf2d2eb5a7b80 (patch) | |
tree | 018d3d8c637e265b8292d34e5f7c11ca8ce11b7d /sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp | |
parent | 132aa8a77685ec92bc90c03f987650d275a7b639 (diff) |
Official Tuscany 2.0.1 Release
git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@1530096 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp')
8 files changed, 0 insertions, 454 deletions
diff --git a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/README b/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/README deleted file mode 100644 index 303c63146a..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/README +++ /dev/null @@ -1,99 +0,0 @@ -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 <tuscany:binding.comet/> 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: - <interface.java interface="org.apache.tuscany.sca.sample.comet.ChatService" - callbackInterface="org.apache.tuscany.sca.binding.comet.runtime.callback.CometCallback" /> - <tuscany:binding.comet /> - <callback> - <tuscany:binding.comet /> - </callback> - -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: - <script type="text/javascript" - src="tuscany-comet-js/org.apache.tuscany.sca.CometComponentContext.js"> - </script> - -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.<service name>.<operation name>(<parameters>, 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-RC1/samples/learning-more/binding-comet/chat-webapp/pom.xml b/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/pom.xml deleted file mode 100644 index d83b1150fc..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/pom.xml +++ /dev/null @@ -1,81 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?>
-<!--
- * 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.
--->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <parent>
- <groupId>org.apache.tuscany.sca.samples</groupId>
- <artifactId>tuscany-samples-binding-comet</artifactId>
- <version>2.0.1</version>
- <relativePath>../pom.xml</relativePath>
- </parent>
-
- <artifactId>sample-binding-comet-chat-webapp</artifactId>
- <packaging>war</packaging>
- <version>2.0.1</version>
- <name>Apache Tuscany SCA Sample binding.comet Chat Webapp</name>
-
- <dependencies>
- <dependency>
- <groupId>org.apache.tuscany.sca</groupId>
- <artifactId>tuscany-binding-comet-runtime</artifactId>
- <version>2.0.1</version>
- </dependency>
- <dependency>
- <groupId>javax</groupId>
- <artifactId>javaee-web-api</artifactId>
- <version>6.0</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.apache.tuscany.sca</groupId>
- <artifactId>tuscany-base-runtime-pom</artifactId>
- <version>2.0.1</version>
- <type>pom</type>
- <scope>compile</scope>
- </dependency>
- <dependency>
- <groupId>com.google.guava</groupId>
- <artifactId>guava</artifactId>
- <version>r09</version>
- <type>jar</type>
- <scope>compile</scope>
- </dependency>
- </dependencies>
-
- <build>
- <plugins>
- <plugin>
- <groupId>com.googlecode.t7mp</groupId>
- <artifactId>maven-t7-plugin</artifactId>
- <version>0.9.6</version>
- <configuration>
- <webapps>
- <webappArtifact>
- <groupId>org.apache.tuscany.sca.samples</groupId>
- <artifactId>sample-binding-comet-chat-webapp</artifactId>
- <version>2.0.1</version>
- </webappArtifact>
- </webapps>
- </configuration>
- </plugin>
- </plugins>
- </build>
-</project>
-
diff --git a/sca-java-2.x/tags/2.0.1-RC1/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-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatService.java deleted file mode 100644 index acb224715a..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatService.java +++ /dev/null @@ -1,36 +0,0 @@ -/* - * 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-RC1/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-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatServiceImpl.java deleted file mode 100644 index c4f3241c5b..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/java/org/apache/tuscany/sca/sample/comet/ChatServiceImpl.java +++ /dev/null @@ -1,56 +0,0 @@ -/* - * 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<CometCallback> clients = new CopyOnWriteArrayList<CometCallback>(); - - @Override - public void postMessage(String user, String message) { - for (CometCallback callback : new ArrayList<CometCallback>(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().<CometCallback> getCallback()); - } -} diff --git a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF b/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF deleted file mode 100644 index 58630c02ef..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF +++ /dev/null @@ -1,2 +0,0 @@ -Manifest-Version: 1.0
-
diff --git a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite b/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite deleted file mode 100644 index c535a38116..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.composite +++ /dev/null @@ -1,37 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * 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. ---> -<composite xmlns="http://docs.oasis-open.org/ns/opencsa/sca/200912" - xmlns:tuscany="http://tuscany.apache.org/xmlns/sca/1.1" - targetNamespace="http://samples" name="Chat"> - - <component name="ChatComponent"> - <implementation.java - class="org.apache.tuscany.sca.sample.comet.ChatServiceImpl" /> - <service name="ChatService"> - <interface.java interface="org.apache.tuscany.sca.sample.comet.ChatService" - callbackInterface="org.apache.tuscany.sca.binding.comet.runtime.callback.CometCallback" /> - <tuscany:binding.comet /> - <callback> - <tuscany:binding.comet /> - </callback> - </service> - </component> - -</composite>
\ No newline at end of file diff --git a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml b/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml deleted file mode 100644 index 25b06c457a..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/WEB-INF/web.xml +++ /dev/null @@ -1,34 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - * 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. ---> -<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:j2ee="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_3.0.xsd" version="3.0"> - <display-name>Apache Tuscany Stock Comet Sample</display-name> - <filter> - <filter-name>tuscany</filter-name> - <filter-class>org.apache.tuscany.sca.host.webapp.TuscanyServletFilter</filter-class> - <async-supported>true</async-supported> - </filter> - <filter-mapping> - <filter-name>tuscany</filter-name> - <url-pattern>/*</url-pattern> - </filter-mapping> - <welcome-file-list> - <welcome-file>index.html</welcome-file> - </welcome-file-list> -</web-app>
\ No newline at end of file diff --git a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html b/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html deleted file mode 100644 index 1aa79ed0b6..0000000000 --- a/sca-java-2.x/tags/2.0.1-RC1/samples/learning-more/binding-comet/chat-webapp/src/main/webapp/index.html +++ /dev/null @@ -1,109 +0,0 @@ -<!-- - * 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. ---> -<html> - <head> - <title>Apache Tuscany Comet Sample</title> - <!-- Tuscany Comet Javascript Toolkit is dependent on jQuery --> - <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js" type="text/javascript"></script> - <script type="text/javascript" src="tuscany-comet-js/org.apache.tuscany.sca.CometComponentContext.js"></script> - <script type="text/javascript"> - var user = ""; - - $(document).ready(function() - { - $("#chat").hide(); - $("#username").focus(); - - // Tuscany Comet specific API - SCA.TuscanyComet.connect(); - - $("#register").click(function() { - register(messageCallback); - }); - - $("#username").keyup(function(e) { - if(e.keyCode == 13) { - register(messageCallback); - } - }); - - function register(callback) { - SCA.CometComponentContext.ChatService.register(callback); - user = $("#username").val(); - $("#login").hide(); - $("#chat").show(); - $("#message").focus(); - } - - $("#send").click(function() { - postMessage(user, $("#message").val(), postCallback); - }); - - $("#message").keyup(function(e) { - if(e.keyCode == 13) { - postMessage(user, $("#message").val(), postCallback); - } - }); - - function postMessage(user, message, callback) { - SCA.CometComponentContext.ChatService.postMessage(user, message, callback); - $("#message").val(""); - $("#message").focus(); - } - - }); - - // this method is invoked on new messages because the CometCallback object is saved - // during the register call so uses it's callback to push data back - function messageCallback(response) { - var textarea = document.getElementById('textarea'); - textarea.value += response + "\n"; - textarea.scrollTop = textarea.scrollHeight; - } - - function postCallback(response) { - } - - </script> - </head> - <body> - <h2>Apache Tuscany Comet Sample</h2> - <h3>Chat</h3> - <p/> - <div id="login"> - <table> - <tr> - <td>Nickname</td> - <td><input type="text" id='username'/></td> - <td><input type="button" id='register' value='Login'/></td> - </tr> - </table> - </div> - <div id="chat"> - <h3>Server notifications</h3> - <textarea id="textarea" rows="15" cols="30" readonly></textarea> - <table> - <tr> - <td><input type="text" id='message'/></td> - <td><input type="button" id='send' value='Send'/></td> - </tr> - </table> - </div> - </body> -</html> |