diff options
Diffstat (limited to 'sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp')
8 files changed, 421 insertions, 0 deletions
diff --git a/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/README b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/README new file mode 100644 index 0000000000..5a9381f980 --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/README @@ -0,0 +1,88 @@ +Tuscany - Learning More - Binding Websocket - Chat Webapp +----------------------------------------------------------------- + +This sample demonstrates how Tuscany can expose services via websockets as well +as how to interact with them using Tuscany's javascript API. It also demonstrates +how to push multiple responses from the server to the client for a single request +using SCA callbacks. + +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.websocket port="8090"/> to a service definition, the +Tuscany runtime will start a websocket server listening for requests coming +in for the exposed service at the specified port. If no port is specified, the +runtime will use port 9000 as a default. + +The websocket binding uses embedded Jetty instances as websocket servers. At the +moment, Jetty 8.0.0-M3 is used which has support for the 00, 01, 06 and 07 +versions of the websocket protocol drafts. + +IN ORDER TO RUN THIS SAMPLE SUCCESSFULLY PLEASE CHECK IF YOUR BROWSER SUPPORTS +THE ABOVE WEBSOCKET PROTOCOL VERSIONS AND THAT THE WEBSOCKET SUPPORT IS ENABLED. + +In order to enable callbacks to push multiple responses, you need to declare the +WebsocketBindingCallback in the service definition as follows: + + <interface.java interface="sample.ChatService" + callbackInterface="org.apache.tuscany.sca.binding.websocket.runtime.WebsocketBindingCallback" /> + <tuscany:binding.websocket /> + <callback> + <tuscany:binding.websocket /> + </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. + +The websocket binding also features a javascript API to simulate SCA in the +browser. In order to use it, the following script has to be included in the +client page: + <script type="text/javascript" + src="org.apache.tuscany.sca.WebsocketComponentContext.js"> + </script> + +This will inject proxies for all services defined in the composite that are +using binding.websocket. All invocation and connection management is handled +under the hood so in order to invoke a websocket service, the following should +be called: + Tuscany.WebsocketComponentContext.<component name>.<service name>.<operation name>(<parameters>); + +Given the asynchornous nature of websockets, a function should be defined in +order to handle responses received for a certain service operation. This should +be done as follows: + Tuscany.WebsocketComponentContext.<component name>.<service name>.<operation name>.responseHandler = function(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 persistent +websocket connection to handle communication between a browser client and all services +defined using binding.websocket on the same port. Requests and responses will get +multiplexed via the same channel and get routed to the appropriate service +implementation, respectively javascript function. + +In order to run the sample, you can execute "mvn jetty:run" which will start a Jetty +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-websocket-chat-webapp/ + +You can now chat using multiple tabs or browsers. You can see the persistent websocket +connection using the developer tools provided by your browser. + +The websocket 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/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/pom.xml b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/pom.xml new file mode 100644 index 0000000000..847795ff74 --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/pom.xml @@ -0,0 +1,67 @@ +<?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-websocket</artifactId>
+ <version>2.0</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+
+ <artifactId>sample-binding-websocket-chat-webapp</artifactId>
+ <packaging>war</packaging>
+ <version>2.0</version>
+ <name>Apache Tuscany SCA Sample binding.websocket Chat Webapp</name>
+
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.tuscany.sca</groupId>
+ <artifactId>tuscany-binding-websocket</artifactId>
+ <version>2.0</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.tuscany.sca</groupId>
+ <artifactId>tuscany-base-runtime-pom</artifactId>
+ <version>2.0</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>org.mortbay.jetty</groupId>
+ <artifactId>maven-jetty-plugin</artifactId>
+ <version>6.1.26</version>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
+
diff --git a/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/java/sample/ChatService.java b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/java/sample/ChatService.java new file mode 100644 index 0000000000..7ec6a547a9 --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/java/sample/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 sample; + +import org.apache.tuscany.sca.binding.websocket.runtime.WebsocketBindingCallback; +import org.oasisopen.sca.annotation.Callback; +import org.oasisopen.sca.annotation.OneWay; +import org.oasisopen.sca.annotation.Remotable; + +@Callback(WebsocketBindingCallback.class) +@Remotable +public interface ChatService { + + @OneWay + void register(); + + @OneWay + void postMessage(String user, String message); + +} diff --git a/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/java/sample/ChatServiceImpl.java b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/java/sample/ChatServiceImpl.java new file mode 100644 index 0000000000..6fd4455ba9 --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/java/sample/ChatServiceImpl.java @@ -0,0 +1,58 @@ +/* + * 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 sample; + +import java.util.ArrayList; +import java.util.concurrent.CopyOnWriteArrayList; + +import org.apache.tuscany.sca.binding.websocket.runtime.WebsocketBindingCallback; +import org.apache.tuscany.sca.binding.websocket.runtime.WebsocketStatus; +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<WebsocketBindingCallback> clients = new CopyOnWriteArrayList<WebsocketBindingCallback>(); + + @Override + public void postMessage(String user, String message) { + for (WebsocketBindingCallback callback : new ArrayList<WebsocketBindingCallback>(clients)) { + WebsocketStatus status = callback.sendMessage(user + ": " + message); + if (status == WebsocketStatus.CLOSED) { + 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().<WebsocketBindingCallback> getCallback()); + } +} diff --git a/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..58630c02ef --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/META-INF/MANIFEST.MF @@ -0,0 +1,2 @@ +Manifest-Version: 1.0
+
diff --git a/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/WEB-INF/web.composite b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/WEB-INF/web.composite new file mode 100644 index 0000000000..4e83fee9e8 --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/WEB-INF/web.composite @@ -0,0 +1,37 @@ +<?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="sample.ChatServiceImpl" /> + <service name="ChatService"> + <interface.java interface="sample.ChatService" + callbackInterface="org.apache.tuscany.sca.binding.websocket.runtime.WebsocketBindingCallback" /> + <tuscany:binding.websocket /> + <callback> + <tuscany:binding.websocket /> + </callback> + </service> + </component> + +</composite>
\ No newline at end of file diff --git a/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/WEB-INF/web.xml b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/WEB-INF/web.xml new file mode 100644 index 0000000000..25b06c457a --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/WEB-INF/web.xml @@ -0,0 +1,34 @@ +<?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/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/index.html b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/index.html new file mode 100644 index 0000000000..2309be8533 --- /dev/null +++ b/sca-java-2.x/branches/2.0/samples/learning-more/binding-websocket/chat-webapp/src/main/webapp/index.html @@ -0,0 +1,99 @@ +<!-- + * 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 Websocket Sample</title> + <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js" type="text/javascript"></script> + <script type="text/javascript" src="org.apache.tuscany.sca.WebsocketComponentContext.js"></script> + <script type="text/javascript"> + var user = ""; + + $(document).ready(function() + { + $("#chat").hide(); + $("#username").focus(); + + $("#register").click(function() { + register(); + }); + + $("#username").keyup(function(e) { + if(e.keyCode == 13) { + register(); + } + }); + + Tuscany.WebsocketComponentContext.ChatComponent.ChatService.register.responseHandler = function(response) { + var textarea = document.getElementById('textarea'); + textarea.value += response + "\n"; + textarea.scrollTop = textarea.scrollHeight; + } + + function register() { + Tuscany.WebsocketComponentContext.ChatComponent.ChatService.register(); + user = $("#username").val(); + $("#login").hide(); + $("#chat").show(); + $("#message").focus(); + } + + $("#send").click(function() { + postMessage(user, $("#message").val()); + }); + + $("#message").keyup(function(e) { + if(e.keyCode == 13) { + postMessage(user, $("#message").val()); + } + }); + + function postMessage(user, message) { + Tuscany.WebsocketComponentContext.ChatComponent.ChatService.postMessage(user, message); + $("#message").val(""); + $("#message").focus(); + } + + }); + </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> |