├── .gitignore ├── LICENSE ├── README.md ├── pom.xml └── src └── main ├── java ├── Chat.java └── ChatWebSocketHandler.java └── resources └── public ├── index.html ├── style.css └── websocketDemo.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io 2 | 3 | ### Windows ### 4 | # Windows image file caches 5 | Thumbs.db 6 | ehthumbs.db 7 | 8 | # Folder config file 9 | Desktop.ini 10 | 11 | # Recycle Bin used on file shares 12 | $RECYCLE.BIN/ 13 | 14 | # Windows Installer files 15 | *.cab 16 | *.msi 17 | *.msm 18 | *.msp 19 | 20 | # Windows shortcuts 21 | *.lnk 22 | 23 | 24 | ### OSX ### 25 | .DS_Store 26 | .AppleDouble 27 | .LSOverride 28 | 29 | # Icon must end with two \r 30 | Icon 31 | 32 | 33 | # Thumbnails 34 | ._* 35 | 36 | # Files that might appear in the root of a volume 37 | .DocumentRevisions-V100 38 | .fseventsd 39 | .Spotlight-V100 40 | .TemporaryItems 41 | .Trashes 42 | .VolumeIcon.icns 43 | 44 | # Directories potentially created on remote AFP share 45 | .AppleDB 46 | .AppleDesktop 47 | Network Trash Folder 48 | Temporary Items 49 | .apdisk 50 | 51 | 52 | ### Intellij ### 53 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm 54 | 55 | *.iml 56 | 57 | ## Directory-based project format: 58 | .idea/ 59 | # if you remove the above rule, at least ignore the following: 60 | 61 | # User-specific stuff: 62 | # .idea/workspace.xml 63 | # .idea/tasks.xml 64 | # .idea/dictionaries 65 | 66 | # Sensitive or high-churn files: 67 | # .idea/dataSources.ids 68 | # .idea/dataSources.xml 69 | # .idea/sqlDataSources.xml 70 | # .idea/dynamic.xml 71 | # .idea/uiDesigner.xml 72 | 73 | # Gradle: 74 | # .idea/gradle.xml 75 | # .idea/libraries 76 | 77 | # Mongo Explorer plugin: 78 | # .idea/mongoSettings.xml 79 | 80 | ## File-based project format: 81 | *.ipr 82 | *.iws 83 | 84 | ## Plugin-specific files: 85 | 86 | # IntelliJ 87 | /out/ 88 | 89 | # mpeltonen/sbt-idea plugin 90 | .idea_modules/ 91 | 92 | # JIRA plugin 93 | atlassian-ide-plugin.xml 94 | 95 | # Crashlytics plugin (for Android Studio and IntelliJ) 96 | com_crashlytics_export_strings.xml 97 | crashlytics.properties 98 | crashlytics-build.properties 99 | 100 | 101 | ### Java ### 102 | *.class 103 | 104 | # Mobile Tools for Java (J2ME) 105 | .mtj.tmp/ 106 | 107 | # Package Files # 108 | *.jar 109 | *.war 110 | *.ear 111 | 112 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 113 | hs_err_pid* 114 | target 115 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2015 David Åse 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spark-websocket 2 | The source code for the WebSocket chat application at sparktutorials.github.io: [https://sparktutorials.github.io/2015/11/08/spark-websocket-chat.html](https://sparktutorials.github.io/2015/11/08/spark-websocket-chat.html) 3 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | sparksocket 8 | sparksocket 9 | 1.0-SNAPSHOT 10 | 11 | 12 | 13 | 14 | org.apache.maven.plugins 15 | maven-compiler-plugin 16 | 17 | 1.8 18 | 1.8 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | com.sparkjava 27 | spark-core 28 | 2.6.0 29 | 30 | 31 | com.j2html 32 | j2html 33 | 1.2.0 34 | 35 | 36 | org.json 37 | json 38 | 20160810 39 | 40 | 41 | org.slf4j 42 | slf4j-simple 43 | 1.7.21 44 | 45 | 46 | 47 | 48 | -------------------------------------------------------------------------------- /src/main/java/Chat.java: -------------------------------------------------------------------------------- 1 | import java.text.SimpleDateFormat; 2 | import java.util.Date; 3 | import java.util.Map; 4 | import java.util.concurrent.ConcurrentHashMap; 5 | 6 | import org.eclipse.jetty.websocket.api.Session; 7 | import org.json.JSONObject; 8 | 9 | import static j2html.TagCreator.*; 10 | import static spark.Spark.*; 11 | 12 | public class Chat { 13 | 14 | // this map is shared between sessions and threads, so it needs to be thread-safe (http://stackoverflow.com/a/2688817) 15 | static Map userUsernameMap = new ConcurrentHashMap<>(); 16 | static int nextUserNumber = 1; //Assign to username for next connecting user 17 | 18 | public static void main(String[] args) { 19 | staticFiles.location("/public"); //index.html is served at localhost:4567 (default port) 20 | staticFiles.expireTime(600); 21 | webSocket("/chat", ChatWebSocketHandler.class); 22 | init(); 23 | } 24 | 25 | //Sends a message from one user to all users, along with a list of current usernames 26 | public static void broadcastMessage(String sender, String message) { 27 | userUsernameMap.keySet().stream().filter(Session::isOpen).forEach(session -> { 28 | try { 29 | session.getRemote().sendString(String.valueOf(new JSONObject() 30 | .put("userMessage", createHtmlMessageFromSender(sender, message)) 31 | .put("userlist", userUsernameMap.values()) 32 | )); 33 | } catch (Exception e) { 34 | e.printStackTrace(); 35 | } 36 | }); 37 | } 38 | 39 | //Builds a HTML element with a sender-name, a message, and a timestamp, 40 | private static String createHtmlMessageFromSender(String sender, String message) { 41 | return article( 42 | b(sender + " says:"), 43 | span(attrs(".timestamp"), new SimpleDateFormat("HH:mm:ss").format(new Date())), 44 | p(message) 45 | ).render(); 46 | } 47 | 48 | } 49 | -------------------------------------------------------------------------------- /src/main/java/ChatWebSocketHandler.java: -------------------------------------------------------------------------------- 1 | import org.eclipse.jetty.websocket.api.*; 2 | import org.eclipse.jetty.websocket.api.annotations.*; 3 | 4 | @WebSocket 5 | public class ChatWebSocketHandler { 6 | 7 | private String sender, msg; 8 | 9 | @OnWebSocketConnect 10 | public void onConnect(Session user) throws Exception { 11 | String username = "User" + Chat.nextUserNumber++; 12 | Chat.userUsernameMap.put(user, username); 13 | Chat.broadcastMessage(sender = "Server", msg = (username + " joined the chat")); 14 | } 15 | 16 | @OnWebSocketClose 17 | public void onClose(Session user, int statusCode, String reason) { 18 | String username = Chat.userUsernameMap.get(user); 19 | Chat.userUsernameMap.remove(user); 20 | Chat.broadcastMessage(sender = "Server", msg = (username + " left the chat")); 21 | } 22 | 23 | @OnWebSocketMessage 24 | public void onMessage(Session user, String message) { 25 | Chat.broadcastMessage(sender = Chat.userUsernameMap.get(user), msg = message); 26 | } 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/main/resources/public/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | WebsSockets 6 | 7 | 8 | 9 |
10 | 11 | 12 |
13 | 14 |
15 | 16 | 17 | 18 | -------------------------------------------------------------------------------- /src/main/resources/public/style.css: -------------------------------------------------------------------------------- 1 | * { 2 | box-sizing: border-box; 3 | } 4 | 5 | html { 6 | overflow-y: scroll; 7 | } 8 | 9 | body { 10 | font-family: monospace; 11 | font-size: 14px; 12 | max-width: 480px; 13 | margin: 0 auto; 14 | padding: 20px 15 | } 16 | 17 | input { 18 | width: 100%; 19 | padding: 5px; 20 | margin: 5px 0; 21 | } 22 | 23 | button { 24 | float: right; 25 | } 26 | 27 | li { 28 | margin: 5px 0; 29 | } 30 | 31 | #chatControls { 32 | overflow: auto; 33 | margin: 0 0 5px 0 34 | } 35 | 36 | #userlist { 37 | position: fixed; 38 | left: 50%; 39 | list-style: none; 40 | margin-left: 250px; 41 | background: #f0f0f9; 42 | padding: 5px 10px; 43 | width: 150px; 44 | top: 11px; 45 | } 46 | 47 | #chat p { 48 | margin: 5px 0; 49 | font-weight: 300 50 | } 51 | 52 | #chat .timestamp { 53 | position: absolute; 54 | top: 10px; 55 | right: 10px; 56 | font-size: 12px; 57 | } 58 | 59 | #chat article { 60 | background: #f1f1f1; 61 | padding: 10px; 62 | margin: 10px 0; 63 | border-left: 5px solid #aaa; 64 | position: relative; 65 | word-wrap: break-word; 66 | } 67 | 68 | #chat article:first-of-type { 69 | background: #c9edc3; 70 | border-left-color: #74a377; 71 | animation: enter .2s 1; 72 | } 73 | 74 | @keyframes enter { 75 | from { transform: none; } 76 | 50% { transform: scale(1.05); } 77 | to { transform: none; } 78 | } 79 | -------------------------------------------------------------------------------- /src/main/resources/public/websocketDemo.js: -------------------------------------------------------------------------------- 1 | //Establish the WebSocket connection and set up event handlers 2 | var webSocket = new WebSocket("ws://" + location.hostname + ":" + location.port + "/chat"); 3 | webSocket.onmessage = function (msg) { updateChat(msg); }; 4 | webSocket.onclose = function () { alert("WebSocket connection closed") }; 5 | 6 | //Send message if "Send" is clicked 7 | id("send").addEventListener("click", function () { 8 | sendMessage(id("message").value); 9 | }); 10 | 11 | //Send message if enter is pressed in the input field 12 | id("message").addEventListener("keypress", function (e) { 13 | if (e.keyCode === 13) { sendMessage(e.target.value); } 14 | }); 15 | 16 | //Send a message if it's not empty, then clear the input field 17 | function sendMessage(message) { 18 | if (message !== "") { 19 | webSocket.send(message); 20 | id("message").value = ""; 21 | } 22 | } 23 | 24 | //Update the chat-panel, and the list of connected users 25 | function updateChat(msg) { 26 | var data = JSON.parse(msg.data); 27 | insert("chat", data.userMessage); 28 | id("userlist").innerHTML = ""; 29 | data.userlist.forEach(function (user) { 30 | insert("userlist", "
  • " + user + "
    • "); 31 | }); 32 | } 33 | 34 | //Helper function for inserting HTML as the first child of an element 35 | function insert(targetId, message) { 36 | id(targetId).insertAdjacentHTML("afterbegin", message); 37 | } 38 | 39 | //Helper function for selecting element by id 40 | function id(id) { 41 | return document.getElementById(id); 42 | } 43 | --------------------------------------------------------------------------------