├── .gitignore
├── .mvn
└── wrapper
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── README.md
├── bin
├── .gitignore
├── .mvn
│ └── wrapper
│ │ ├── maven-wrapper.jar
│ │ └── maven-wrapper.properties
├── README.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
│ ├── main
│ ├── java
│ │ └── in
│ │ │ └── tusharprabhu
│ │ │ └── chatapp
│ │ │ ├── ChatAppApplication.class
│ │ │ ├── config
│ │ │ ├── WebSocketConfig.class
│ │ │ └── WebSocketEventListener.class
│ │ │ ├── controller
│ │ │ └── ChatController.class
│ │ │ └── model
│ │ │ └── ChatMessage.class
│ └── resources
│ │ ├── application.properties
│ │ └── static
│ │ ├── css
│ │ └── main.css
│ │ ├── images
│ │ └── space.jpg
│ │ ├── index.html
│ │ └── js
│ │ └── main.js
│ └── test
│ └── java
│ └── in
│ └── tusharprabhu
│ └── chatapp
│ └── ChatAppApplicationTests.class
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
├── java
│ └── in
│ │ └── tusharprabhu
│ │ └── chatapp
│ │ ├── ChatAppApplication.java
│ │ ├── config
│ │ ├── WebSocketConfig.java
│ │ └── WebSocketEventListener.java
│ │ ├── controller
│ │ └── ChatController.java
│ │ └── model
│ │ └── ChatMessage.java
└── resources
│ ├── application.properties
│ └── static
│ ├── css
│ └── main.css
│ ├── images
│ └── space.jpg
│ ├── index.html
│ └── js
│ └── main.js
└── test
└── java
└── in
└── tusharprabhu
└── chatapp
└── ChatAppApplicationTests.java
/.gitignore:
--------------------------------------------------------------------------------
1 | HELP.md
2 | target/
3 | !.mvn/wrapper/maven-wrapper.jar
4 | !**/src/main/**/target/
5 | !**/src/test/**/target/
6 |
7 | ### STS ###
8 | .apt_generated
9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 | .sts4-cache
15 |
16 | ### IntelliJ IDEA ###
17 | .idea
18 | *.iws
19 | *.iml
20 | *.ipr
21 |
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 | build/
29 | !**/src/main/**/build/
30 | !**/src/test/**/build/
31 |
32 | ### VS Code ###
33 | .vscode/
34 |
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tushar-prabhu/chat_app-springboot/6a9ada5509ded4f4c4f6ff921c74edfabeb4adce/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.2/apache-maven-3.9.2-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
3 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Realtime Chat Application using Spring Boot
2 | ===========================================================
3 |
4 | * * *
5 |
6 | ##### Introduction
7 |
8 | This project is a realtime chat application developed using Spring Boot and WebSocket. The application allows users to join, chat, and leave chat rooms in real-time. Spring Boot provides a robust and scalable architecture for the application, while WebSocket enables real-time communication between the server and clients. The application has features such as joining chat rooms, sending messages, and leaving chat rooms, providing a seamless and interactive chatting experience for its users.
9 |
10 | * * *
11 |
12 | ##### Websocket
13 |
14 | WebSocket is a computer communications protocol, providing full-duplex communication channels over a single TCP connection. WebSocket is distinct from HTTP.
15 |
16 | The protocol enables interaction between a web browser (or other client application) and a web server with lower overhead than half-duplex alternatives such as HTTP polling, facilitating real-time data transfer from and to the server.
17 |
18 | Once a websocket connection is established between a client and a server, both can exchange information until the connection is closed by any of the parties.
19 |
20 | This is the main reason why WebSocket is preferred over the HTTP protocol when building a chat-like communication service that operates at high frequencies with low latency.
21 |
22 | * * *
23 |
24 | ##### Stomp JS
25 |
26 | Simple (or Streaming) Text Oriented Message Protocol (STOMP), formerly known as TTMP, is a simple text-based protocol, designed for working with message-oriented middleware (MOM). It provides an interoperable wire format that allows STOMP clients to talk with any message broker supporting the protocol.
27 |
28 | Since websocket is just a communication protocol, it doesn't know how to send a message to a particular user. STOMP is basically a messaging protocol which is useful for these functionalities.
29 |
30 | * * *
31 |
32 | ##### Sock JS
33 |
34 | SockJS is used to enable fallback options for browsers that don't support WebSocket. The goal of SockJS is to let applications use a WebSocket API but fall back to non-WebSocket alternatives when necessary at runtime, i.e. without the need to change application code.
35 |
36 | Under the hood, SockJS tries to use native WebSockets first. If that fails, it can use a variety of browser-specific transport protocols and presents them through WebSocket-like abstractions.
37 |
38 | * * *
39 |
40 | ##### Codes
41 |
42 | ##### Websocket configuration
43 |
44 | Path: config>WebSocketConfig.java
45 |
46 | ```
47 | @Configuration
48 | @EnableWebSocketMessageBroker
49 | public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
50 |
51 | @Override
52 | public void registerStompEndpoints(StompEndpointRegistry registry) {
53 | registry.addEndpoint("/websocket").withSockJS();
54 | }
55 |
56 | @Override
57 | public void configureMessageBroker(MessageBrokerRegistry registry) {
58 | registry.enableSimpleBroker("/topic");
59 | registry.setApplicationDestinationPrefixes("/app");
60 | }
61 | }
62 | ```
63 |
64 | This code is a Spring Framework configuration class that configures WebSocket communication for a chat application. It implements the `WebSocketMessageBrokerConfigurer` interface to customize the WebSocket configuration.
65 |
66 | ##### Dependencies
67 |
68 | This code relies on the following Spring Framework imports:
69 |
70 | * `org.springframework.context.annotation.Configuration`: Indicates that this class is a configuration class.
71 | * `org.springframework.messaging.simp.config.MessageBrokerRegistry`: Allows configuration of the message broker for WebSocket communication.
72 | * `org.springframework.web.socket.config.annotation.*`: Provides annotations and interfaces for configuring WebSocket endpoints.
73 |
74 | ##### Class Declaration
75 |
76 | * `@Configuration`: Annotation indicating that this class is a configuration class.
77 |
78 | * `@EnableWebSocketMessageBroker`: Annotation enabling WebSocket message handling with a message broker.
79 |
80 |
81 | ##### Methods
82 |
83 | #### `registerStompEndpoints`
84 |
85 | This method is overridden from the `WebSocketMessageBrokerConfigurer` interface. It configures the WebSocket endpoints that clients can connect to.
86 |
87 | * `StompEndpointRegistry`: A registry for registering Stomp endpoints.
88 |
89 | In this code, it registers the "/websocket" endpoint and enables SockJS fallback options.
90 |
91 | #### `configureMessageBroker`
92 |
93 | This method is overridden from the `WebSocketMessageBrokerConfigurer` interface. It configures the message broker used for routing messages between clients and the server.
94 |
95 | * `MessageBrokerRegistry`: A registry for configuring the message broker.
96 |
97 | In this code, it enables a simple in-memory message broker with the "/topic" destination prefix for broadcasting messages to subscribed clients. It also sets the application destination prefix to "/app" for routing messages that are sent from clients to server-side message handling methods.
98 |
99 | This configuration class sets up the necessary configurations for WebSocket communication in the chat application. It enables the use of a message broker for handling message routing and sets up the endpoints that clients can connect to. The `registerStompEndpoints` method configures the endpoints, and the `configureMessageBroker` method configures the message broker.
100 |
101 | * * *
102 |
103 | ##### Websocket Event Listener
104 |
105 | Path: config>WebSocketEventListener.java
106 | ```
107 | @Component
108 | @Slf4j
109 | @RequiredArgsConstructor
110 | public class WebSocketEventListener {
111 |
112 | private final SimpMessageSendingOperations messagingTemplate;
113 |
114 | @EventListener
115 | public void handleWebSocketDisconnectListener(SessionDisconnectEvent event) {
116 | StompHeaderAccessor headerAccessor = StompHeaderAccessor.wrap(event.getMessage());
117 | String username = (String) headerAccessor.getSessionAttributes().get("username");
118 | if (username != null) {
119 | log.info("user disconnected: {}", username);
120 | var chatMessage = ChatMessage.builder()
121 | .type(ChatMessage.MessageType.LEAVE)
122 | .sender(username)
123 | .build();
124 | messagingTemplate.convertAndSend("/topic/public", chatMessage);
125 | }
126 | }
127 |
128 | }
129 | ```
130 |
131 | This code is a Spring Framework component class that listens for WebSocket disconnect events and handles the disconnection by sending a leave message to the chat room. It is responsible for notifying other clients when a user disconnects from the chat.
132 |
133 | ##### Dependencies
134 |
135 | This code relies on the following Spring Framework imports:
136 |
137 | * `org.springframework.stereotype.Component`: Marks the class as a Spring component.
138 | * `lombok.*`: Lombok library annotations for generating boilerplate code.
139 | * `org.springframework.messaging.simp.SimpMessageSendingOperations`: Provides operations for sending messages to WebSocket subscribers.
140 | * `org.springframework.context.event.EventListener`: Annotation for handling application events.
141 |
142 | ##### Class Declaration
143 |
144 | * `@Component`: Annotation indicating that this class is a Spring component.
145 | * `@Slf4j`: Annotation for generating a logger field using Lombok.
146 | * `@RequiredArgsConstructor`: Annotation for generating a constructor with required dependencies.
147 |
148 | ##### Constructor
149 |
150 | * `WebSocketEventListener(SimpMessageSendingOperations messagingTemplate)`: Constructor that injects an instance of `SimpMessageSendingOperations` (used for sending messages to WebSocket subscribers) as a dependency.
151 |
152 | ##### Methods
153 |
154 | #### `handleWebSocketDisconnectListener`
155 |
156 | This method is annotated with `@EventListener` and is invoked when a `SessionDisconnectEvent` occurs, indicating that a WebSocket session has been disconnected. It retrieves the username from the session attributes, constructs a leave message using the `ChatMessage` class, and sends it to the "/topic/public" destination using the `messagingTemplate`.
157 |
158 | * `SessionDisconnectEvent`: The event representing a WebSocket session disconnection.
159 | * `StompHeaderAccessor`: A wrapper for the message headers.
160 | * `SimpMessageSendingOperations`: Operations for sending messages to WebSocket subscribers.
161 |
162 | This component class is responsible for handling WebSocket disconnect events. When a user disconnects from the chat, the `handleWebSocketDisconnectListener` method is triggered. It retrieves the username from the session attributes and constructs a leave message using the `ChatMessage` class. The leave message is then sent to the "/topic/public" destination using the `messagingTemplate`, notifying other clients about the user's disconnection. The `@Component` annotation ensures that this class is automatically detected and registered as a Spring bean.
163 |
164 | * * *
165 |
166 | #### Chat Model
167 |
168 | Chat model is the message payload which will be exchanged between the client side and server side of the application.
169 |
170 | Path: model>ChatMessage.java
171 | ```
172 | import lombok.*;
173 | import java.nio.file.FileStore;
174 | @Getter
175 | @Setter
176 | @AllArgsConstructor
177 | @NoArgsConstructor
178 | @Builder
179 | public class ChatMessage {
180 | private String content;
181 | private String sender;
182 | private MessageType type;
183 |
184 | public enum MessageType {
185 | CHAT, LEAVE, JOIN
186 | }
187 |
188 | public String getContent() {
189 | return content;
190 | }
191 |
192 | public void setContent(String content) {
193 | this.content = content;
194 | }
195 |
196 | public String getSender() {
197 | return sender;
198 | }
199 |
200 | public void setSender(String sender) {
201 | this.sender = sender;
202 | }
203 |
204 | public MessageType getType() {
205 | return type;
206 | }
207 |
208 | public void setType(MessageType type) {
209 | this.type = type;
210 | }
211 | }
212 | ```
213 |
214 | This code defines a `ChatMessage` class representing a message in a chat application. It utilizes the Lombok library to automatically generate getters, setters, constructors, and builder methods.
215 |
216 | ##### Dependencies
217 |
218 | This code relies on the following imports:
219 |
220 | * `import lombok.*`: Lombok library annotations for generating boilerplate code.
221 |
222 | ##### Class Declaration
223 |
224 | * `@Getter`: Annotation indicating that Lombok should generate getter methods for all fields.
225 | * `@Setter`: Annotation indicating that Lombok should generate setter methods for all fields.
226 | * `@AllArgsConstructor`: Annotation indicating that Lombok should generate a constructor with all fields as arguments.
227 | * `@NoArgsConstructor`: Annotation indicating that Lombok should generate a default constructor with no arguments.
228 | * `@Builder`: Annotation indicating that Lombok should generate a builder method for the class.
229 |
230 | ##### Fields
231 |
232 | * `content`: Represents the content of the chat message.
233 | * `sender`: Represents the sender of the chat message.
234 | * `type`: Represents the type of the chat message, which is defined as an enum called `MessageType`.
235 |
236 | ##### Enum: `MessageType`
237 |
238 | This enum defines the possible types of chat messages: CHAT, LEAVE, and JOIN.
239 |
240 | ##### Methods
241 |
242 | The class also includes getter and setter methods for each field to access and modify their values.
243 |
244 | * `getContent()`: Returns the content of the chat message.
245 | * `setContent(String content)`: Sets the content of the chat message.
246 | * `getSender()`: Returns the sender of the chat message.
247 | * `setSender(String sender)`: Sets the sender of the chat message.
248 | * `getType()`: Returns the type of the chat message.
249 | * `setType(MessageType type)`: Sets the type of the chat message.
250 |
251 | This class serves as a model for chat messages in the application. It encapsulates the content, sender, and type of a chat message. The Lombok annotations eliminate the need to write repetitive boilerplate code for getters, setters, constructors, and builders, making the class concise and easier to work with.
252 |
253 | * * *
254 |
255 | ##### Chat Controller
256 |
257 | Path: controller>ChatController.java
258 | ```
259 | import org.springframework.messaging.handler.annotation.*;
260 | import org.springframework.messaging.simp.SimpMessageHeaderAccessor;
261 | import org.springframework.stereotype.Controller;
262 |
263 | @Controller
264 | public class ChatController {
265 |
266 | @MessageMapping("/chat.register")
267 | @SendTo("/topic/public")
268 | public ChatMessage register(@Payload ChatMessage chatMessage, SimpMessageHeaderAccessor headerAccessor) {
269 | headerAccessor.getSessionAttributes().put("username", chatMessage.getSender());
270 | return chatMessage;
271 | }
272 |
273 | @MessageMapping("/chat.send")
274 | @SendTo("/topic/public")
275 | public ChatMessage sendMessage(@Payload ChatMessage chatMessage) {
276 | return chatMessage;
277 | }
278 | }
279 | ```
280 |
281 | This code is a Spring Framework controller class that handles WebSocket messages for a chat application. It contains two message handling methods: `register` and `sendMessage`.
282 |
283 | ##### Dependencies
284 |
285 | This code relies on the following Spring Framework imports:
286 |
287 | * `org.springframework.messaging.handler.annotation.*`: Provides annotations for handling WebSocket messages.
288 | * `org.springframework.messaging.simp.SimpMessageHeaderAccessor`: Allows access to message headers and session attributes.
289 | * `org.springframework.stereotype.Controller`: Marks the class as a controller component.
290 |
291 | ##### Class Declaration
292 |
293 | * `@Controller`: Annotation indicating that this class is a controller component.
294 |
295 | ##### Methods
296 |
297 | #### `register`
298 |
299 | This method is annotated with `@MessageMapping("/chat.register")` and is invoked when a client sends a message to the "/app/chat.register" destination. It receives a `ChatMessage` object as a payload and a `SimpMessageHeaderAccessor` object to access message headers.
300 |
301 | The method sets the sender's username from the received `ChatMessage` object as a session attribute using the `headerAccessor`. It returns the same `ChatMessage` object, which will be broadcasted to all subscribers of the "/topic/public" channel.
302 |
303 | * `@Payload`: Annotation indicating that the method parameter should be bound to the payload of the received message.
304 |
305 | * `@SendTo("/topic/public")`: Annotation specifying that the return value of the method should be sent as a message to the "/topic/public" destination.
306 |
307 | * Return: The `ChatMessage` object received as the payload.
308 |
309 |
310 | #### `sendMessage`
311 |
312 | This method is annotated with `@MessageMapping("/chat.send")` and is invoked when a client sends a message to the "/app/chat.send" destination. It receives a `ChatMessage` object as a payload.
313 |
314 | The method simply returns the received `ChatMessage` object, which will be broadcasted to all subscribers of the "/topic/public" channel.
315 |
316 | * `@Payload`: Annotation indicating that the method parameter should be bound to the payload of the received message.
317 |
318 | * `@SendTo("/topic/public")`: Annotation specifying that the return value of the method should be sent as a message to the "/topic/public" destination.
319 |
320 | * Return: The `ChatMessage` object received as the payload.
321 |
322 |
323 | This controller class is responsible for handling incoming WebSocket messages related to user registration and sending chat messages. The `register` method is used to register a user by storing their username in the session attributes, while the `sendMessage` method is used to broadcast chat messages to all connected clients. These methods are annotated to specify the destination paths for the messages and the return destinations for broadcasting.
324 |
325 | * * *
326 |
327 | ##### UI
328 |
329 | Path: `resources` directory
330 |
331 | Basic HTML, CSS code and;
332 |
333 | JavaScript code
334 | Path: resources>js>main.js
335 | ```
336 | "use strict";
337 |
338 | var usernamePage = document.querySelector("#username-page");
339 | var chatPage = document.querySelector("#chat-page");
340 | var usernameForm = document.querySelector("#usernameForm");
341 | var messageForm = document.querySelector("#messageForm");
342 | var messageInput = document.querySelector("#message");
343 | var messageArea = document.querySelector("#messageArea");
344 | var connectingElement = document.querySelector(".connecting");
345 |
346 | var stompClient = null;
347 | var username = null;
348 | //mycode
349 | var password = null;
350 |
351 | var colors = \[
352 | "#2196F3",
353 | "#32c787",
354 | "#00BCD4",
355 | "#ff5652",
356 | "#ffc107",
357 | "#ff85af",
358 | "#FF9800",
359 | "#39bbb0",
360 | "#fcba03",
361 | "#fc0303",
362 | "#de5454",
363 | "#b9de54",
364 | "#54ded7",
365 | "#54ded7",
366 | "#1358d6",
367 | "#d611c6",
368 | \];
369 |
370 | function connect(event) {
371 | username = document.querySelector("#name").value.trim();
372 | password = document.querySelector("#password").value;
373 | if (username) {
374 | // Please create a password
375 | if (password == "YOUR PASSWORD") {
376 | usernamePage.classList.add("hidden");
377 | chatPage.classList.remove("hidden");
378 |
379 | var socket = new SockJS("/websocket");
380 | stompClient = Stomp.over(socket);
381 |
382 | stompClient.connect({}, onConnected, onError);
383 | } else {
384 | let mes = document.getElementById("mes");
385 | mes.innerText = "Wrong password";
386 | }
387 | }
388 | event.preventDefault();
389 | }
390 |
391 | function onConnected() {
392 | // Subscribe to the Public Topic
393 | stompClient.subscribe("/topic/public", onMessageReceived);
394 |
395 | // Tell your username to the server
396 | stompClient.send(
397 | "/app/chat.register",
398 | {},
399 | JSON.stringify({ sender: username, type: "JOIN" })
400 | );
401 |
402 | connectingElement.classList.add("hidden");
403 | }
404 |
405 | function onError(error) {
406 | connectingElement.textContent =
407 | "Could not connect to WebSocket! Please refresh the page and try again or contact your administrator.";
408 | connectingElement.style.color = "red";
409 | }
410 |
411 | function send(event) {
412 | var messageContent = messageInput.value.trim();
413 |
414 | if (messageContent && stompClient) {
415 | var chatMessage = {
416 | sender: username,
417 | content: messageInput.value,
418 | type: "CHAT",
419 | };
420 |
421 | stompClient.send("/app/chat.send", {}, JSON.stringify(chatMessage));
422 | messageInput.value = "";
423 | }
424 | event.preventDefault();
425 | }
426 |
427 | function onMessageReceived(payload) {
428 | var message = JSON.parse(payload.body);
429 |
430 | var messageElement = document.createElement("li");
431 |
432 | if (message.type === "JOIN") {
433 | messageElement.classList.add("event-message");
434 | message.content = message.sender + " joined!";
435 | } else if (message.type === "LEAVE") {
436 | messageElement.classList.add("event-message");
437 | message.content = message.sender + " left!";
438 | } else {
439 | messageElement.classList.add("chat-message");
440 |
441 | var avatarElement = document.createElement("i");
442 | var avatarText = document.createTextNode(message.sender\[0\]);
443 | avatarElement.appendChild(avatarText);
444 | avatarElement.style\["background-color"\] = getAvatarColor(message.sender);
445 |
446 | messageElement.appendChild(avatarElement);
447 |
448 | var usernameElement = document.createElement("span");
449 | var usernameText = document.createTextNode(message.sender);
450 | usernameElement.appendChild(usernameText);
451 | messageElement.appendChild(usernameElement);
452 | // \* update
453 | usernameElement.style\["color"\] = getAvatarColor(message.sender);
454 | //\* update end
455 | }
456 |
457 | var textElement = document.createElement("p");
458 | var messageText = document.createTextNode(message.content);
459 | textElement.appendChild(messageText);
460 |
461 | messageElement.appendChild(textElement);
462 | // \* update
463 | if (message.sender === username) {
464 | // Add a class to float the message to the right
465 | messageElement.classList.add("own-message");
466 | } // \* update end
467 | messageArea.appendChild(messageElement);
468 | messageArea.scrollTop = messageArea.scrollHeight;
469 | }
470 |
471 | function getAvatarColor(messageSender) {
472 | var hash = 0;
473 | for (var i = 0; i < messageSender.length; i++) {
474 | hash = 31 \* hash + messageSender.charCodeAt(i);
475 | }
476 |
477 | var index = Math.abs(hash % colors.length);
478 | return colors\[index\];
479 | }
480 |
481 | usernameForm.addEventListener("submit", connect, true);
482 | messageForm.addEventListener("submit", send, true);
483 | ```
484 |
485 | This code is a client-side JavaScript code that enables a user to connect to a chat application using a username and password. It utilizes the Stomp protocol to establish a WebSocket connection and exchange messages with a server.
486 |
487 | ##### Variables
488 |
489 | * `usernamePage`: Represents the element on the page that contains the username input form.
490 | * `chatPage`: Represents the element on the page that displays the chat interface.
491 | * `usernameForm`: Represents the form element for submitting the username.
492 | * `messageForm`: Represents the form element for submitting chat messages.
493 | * `messageInput`: Represents the input field where the user enters chat messages.
494 | * `messageArea`: Represents the area where chat messages are displayed.
495 | * `connectingElement`: Represents the element that indicates the connection status.
496 |
497 | * `stompClient`: Holds the Stomp client instance used for WebSocket communication.
498 |
499 | * `username`: Stores the username entered by the user.
500 | * `password`: Stores the password entered by the user.
501 |
502 | * `colors`: An array of colors used for generating avatar colors.
503 |
504 |
505 | ##### Functions
506 |
507 | #### `connect(event)`
508 |
509 | This function is called when the username form is submitted. It retrieves the username and password entered by the user, checks if the password is correct, and if so, establishes a WebSocket connection to the server. It hides the username page and displays the chat page.
510 |
511 | * `event`: The event object representing the form submission event.
512 |
513 | #### `onConnected()`
514 |
515 | This function is called when the WebSocket connection is successfully established. It subscribes to the "/topic/public" channel to receive messages from the server. It also sends a JOIN message to the server to notify the user's username.
516 |
517 | #### `onError(error)`
518 |
519 | This function is called when an error occurs during the WebSocket connection. It updates the connecting element to display an error message.
520 |
521 | * `error`: The error object representing the connection error.
522 |
523 | #### `send(event)`
524 |
525 | This function is called when the chat message form is submitted. It retrieves the message content, sends the message to the server using the Stomp client, and clears the message input field.
526 |
527 | * `event`: The event object representing the form submission event.
528 |
529 | #### `onMessageReceived(payload)`
530 |
531 | This function is called when a message is received from the server. It parses the message payload, creates the necessary DOM elements to display the message, and appends them to the message area.
532 |
533 | * `payload`: The message payload received from the server.
534 |
535 | #### `getAvatarColor(messageSender)`
536 |
537 | This function generates an avatar color based on the message sender's username. It calculates a hash value based on the characters of the username and maps it to an index in the `colors` array to select a color.
538 |
539 | * `messageSender`: The username of the message sender.
540 |
541 | ##### Event Listeners
542 |
543 | * `usernameForm.addEventListener("submit", connect, true)`: Listens for the submission of the username form and calls the `connect` function.
544 | * `messageForm.addEventListener("submit", send, true)`: Listens for the submission of the chat message form and calls the `send` function.
545 |
--------------------------------------------------------------------------------
/bin/.gitignore:
--------------------------------------------------------------------------------
1 | HELP.md
2 | target/
3 | !.mvn/wrapper/maven-wrapper.jar
4 | !**/src/main/**/target/
5 | !**/src/test/**/target/
6 |
7 | ### STS ###
8 | .apt_generated
9 | .classpath
10 | .factorypath
11 | .project
12 | .settings
13 | .springBeans
14 | .sts4-cache
15 |
16 | ### IntelliJ IDEA ###
17 | .idea
18 | *.iws
19 | *.iml
20 | *.ipr
21 |
22 | ### NetBeans ###
23 | /nbproject/private/
24 | /nbbuild/
25 | /dist/
26 | /nbdist/
27 | /.nb-gradle/
28 | build/
29 | !**/src/main/**/build/
30 | !**/src/test/**/build/
31 |
32 | ### VS Code ###
33 | .vscode/
34 |
--------------------------------------------------------------------------------
/bin/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/tushar-prabhu/chat_app-springboot/6a9ada5509ded4f4c4f6ff921c74edfabeb4adce/bin/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/bin/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.2/apache-maven-3.9.2-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
3 |
--------------------------------------------------------------------------------
/bin/README.md:
--------------------------------------------------------------------------------
1 | Realtime Chat Application using Spring Boot
2 | ===========================================================
3 |
4 | * * *
5 |
6 | ##### Introduction
7 |
8 | This project is a realtime chat application developed using Spring Boot and WebSocket. The application allows users to join, chat, and leave chat rooms in real-time. Spring Boot provides a robust and scalable architecture for the application, while WebSocket enables real-time communication between the server and clients. The application has features such as joining chat rooms, sending messages, and leaving chat rooms, providing a seamless and interactive chatting experience for its users.
9 |
10 | * * *
11 |
12 | ##### Websocket
13 |
14 | WebSocket is a computer communications protocol, providing full-duplex communication channels over a single TCP connection. WebSocket is distinct from HTTP.
15 |
16 | The protocol enables interaction between a web browser (or other client application) and a web server with lower overhead than half-duplex alternatives such as HTTP polling, facilitating real-time data transfer from and to the server.
17 |
18 | Once a websocket connection is established between a client and a server, both can exchange information until the connection is closed by any of the parties.
19 |
20 | This is the main reason why WebSocket is preferred over the HTTP protocol when building a chat-like communication service that operates at high frequencies with low latency.
21 |
22 | * * *
23 |
24 | ##### Stomp JS
25 |
26 | Simple (or Streaming) Text Oriented Message Protocol (STOMP), formerly known as TTMP, is a simple text-based protocol, designed for working with message-oriented middleware (MOM). It provides an interoperable wire format that allows STOMP clients to talk with any message broker supporting the protocol.
27 |
28 | Since websocket is just a communication protocol, it doesn't know how to send a message to a particular user. STOMP is basically a messaging protocol which is useful for these functionalities.
29 |
30 | * * *
31 |
32 | ##### Sock JS
33 |
34 | SockJS is used to enable fallback options for browsers that don't support WebSocket. The goal of SockJS is to let applications use a WebSocket API but fall back to non-WebSocket alternatives when necessary at runtime, i.e. without the need to change application code.
35 |
36 | Under the hood, SockJS tries to use native WebSockets first. If that fails, it can use a variety of browser-specific transport protocols and presents them through WebSocket-like abstractions.
37 |
38 | * * *
39 |
40 | ##### Codes
41 |
42 | ##### Websocket configuration
43 |
44 | Path: config>WebSocketConfig.java
45 |
46 | ```
47 | @Configuration
48 | @EnableWebSocketMessageBroker
49 | public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
50 |
51 | @Override
52 | public void registerStompEndpoints(StompEndpointRegistry registry) {
53 | registry.addEndpoint("/websocket").withSockJS();
54 | }
55 |
56 | @Override
57 | public void configureMessageBroker(MessageBrokerRegistry registry) {
58 | registry.enableSimpleBroker("/topic");
59 | registry.setApplicationDestinationPrefixes("/app");
60 | }
61 | }
62 | ```
63 |
64 | This code is a Spring Framework configuration class that configures WebSocket communication for a chat application. It implements the `WebSocketMessageBrokerConfigurer` interface to customize the WebSocket configuration.
65 |
66 | ##### Dependencies
67 |
68 | This code relies on the following Spring Framework imports:
69 |
70 | * `org.springframework.context.annotation.Configuration`: Indicates that this class is a configuration class.
71 | * `org.springframework.messaging.simp.config.MessageBrokerRegistry`: Allows configuration of the message broker for WebSocket communication.
72 | * `org.springframework.web.socket.config.annotation.*`: Provides annotations and interfaces for configuring WebSocket endpoints.
73 |
74 | ##### Class Declaration
75 |
76 | * `@Configuration`: Annotation indicating that this class is a configuration class.
77 |
78 | * `@EnableWebSocketMessageBroker`: Annotation enabling WebSocket message handling with a message broker.
79 |
80 |
81 | ##### Methods
82 |
83 | #### `registerStompEndpoints`
84 |
85 | This method is overridden from the `WebSocketMessageBrokerConfigurer` interface. It configures the WebSocket endpoints that clients can connect to.
86 |
87 | * `StompEndpointRegistry`: A registry for registering Stomp endpoints.
88 |
89 | In this code, it registers the "/websocket" endpoint and enables SockJS fallback options.
90 |
91 | #### `configureMessageBroker`
92 |
93 | This method is overridden from the `WebSocketMessageBrokerConfigurer` interface. It configures the message broker used for routing messages between clients and the server.
94 |
95 | * `MessageBrokerRegistry`: A registry for configuring the message broker.
96 |
97 | In this code, it enables a simple in-memory message broker with the "/topic" destination prefix for broadcasting messages to subscribed clients. It also sets the application destination prefix to "/app" for routing messages that are sent from clients to server-side message handling methods.
98 |
99 | This configuration class sets up the necessary configurations for WebSocket communication in the chat application. It enables the use of a message broker for handling message routing and sets up the endpoints that clients can connect to. The `registerStompEndpoints` method configures the endpoints, and the `configureMessageBroker` method configures the message broker.
100 |
101 | * * *
102 |
103 | ##### Websocket Event Listener
104 |
105 | Path: config>WebSocketEventListener.java
106 | ```
107 | @Component
108 | @Slf4j
109 | @RequiredArgsConstructor
110 | public class WebSocketEventListener {
111 |
112 | private final SimpMessageSendingOperations messagingTemplate;
113 |
114 | @EventListener
115 | public void handleWebSocketDisconnectListener(SessionDisconnectEvent event) {
116 | StompHeaderAccessor headerAccessor = StompHeaderAccessor.wrap(event.getMessage());
117 | String username = (String) headerAccessor.getSessionAttributes().get("username");
118 | if (username != null) {
119 | log.info("user disconnected: {}", username);
120 | var chatMessage = ChatMessage.builder()
121 | .type(ChatMessage.MessageType.LEAVE)
122 | .sender(username)
123 | .build();
124 | messagingTemplate.convertAndSend("/topic/public", chatMessage);
125 | }
126 | }
127 |
128 | }
129 | ```
130 |
131 | This code is a Spring Framework component class that listens for WebSocket disconnect events and handles the disconnection by sending a leave message to the chat room. It is responsible for notifying other clients when a user disconnects from the chat.
132 |
133 | ##### Dependencies
134 |
135 | This code relies on the following Spring Framework imports:
136 |
137 | * `org.springframework.stereotype.Component`: Marks the class as a Spring component.
138 | * `lombok.*`: Lombok library annotations for generating boilerplate code.
139 | * `org.springframework.messaging.simp.SimpMessageSendingOperations`: Provides operations for sending messages to WebSocket subscribers.
140 | * `org.springframework.context.event.EventListener`: Annotation for handling application events.
141 |
142 | ##### Class Declaration
143 |
144 | * `@Component`: Annotation indicating that this class is a Spring component.
145 | * `@Slf4j`: Annotation for generating a logger field using Lombok.
146 | * `@RequiredArgsConstructor`: Annotation for generating a constructor with required dependencies.
147 |
148 | ##### Constructor
149 |
150 | * `WebSocketEventListener(SimpMessageSendingOperations messagingTemplate)`: Constructor that injects an instance of `SimpMessageSendingOperations` (used for sending messages to WebSocket subscribers) as a dependency.
151 |
152 | ##### Methods
153 |
154 | #### `handleWebSocketDisconnectListener`
155 |
156 | This method is annotated with `@EventListener` and is invoked when a `SessionDisconnectEvent` occurs, indicating that a WebSocket session has been disconnected. It retrieves the username from the session attributes, constructs a leave message using the `ChatMessage` class, and sends it to the "/topic/public" destination using the `messagingTemplate`.
157 |
158 | * `SessionDisconnectEvent`: The event representing a WebSocket session disconnection.
159 | * `StompHeaderAccessor`: A wrapper for the message headers.
160 | * `SimpMessageSendingOperations`: Operations for sending messages to WebSocket subscribers.
161 |
162 | This component class is responsible for handling WebSocket disconnect events. When a user disconnects from the chat, the `handleWebSocketDisconnectListener` method is triggered. It retrieves the username from the session attributes and constructs a leave message using the `ChatMessage` class. The leave message is then sent to the "/topic/public" destination using the `messagingTemplate`, notifying other clients about the user's disconnection. The `@Component` annotation ensures that this class is automatically detected and registered as a Spring bean.
163 |
164 | * * *
165 |
166 | #### Chat Model
167 |
168 | Chat model is the message payload which will be exchanged between the client side and server side of the application.
169 |
170 | Path: model>ChatMessage.java
171 | ```
172 | import lombok.*;
173 | import java.nio.file.FileStore;
174 | @Getter
175 | @Setter
176 | @AllArgsConstructor
177 | @NoArgsConstructor
178 | @Builder
179 | public class ChatMessage {
180 | private String content;
181 | private String sender;
182 | private MessageType type;
183 |
184 | public enum MessageType {
185 | CHAT, LEAVE, JOIN
186 | }
187 |
188 | public String getContent() {
189 | return content;
190 | }
191 |
192 | public void setContent(String content) {
193 | this.content = content;
194 | }
195 |
196 | public String getSender() {
197 | return sender;
198 | }
199 |
200 | public void setSender(String sender) {
201 | this.sender = sender;
202 | }
203 |
204 | public MessageType getType() {
205 | return type;
206 | }
207 |
208 | public void setType(MessageType type) {
209 | this.type = type;
210 | }
211 | }
212 | ```
213 |
214 | This code defines a `ChatMessage` class representing a message in a chat application. It utilizes the Lombok library to automatically generate getters, setters, constructors, and builder methods.
215 |
216 | ##### Dependencies
217 |
218 | This code relies on the following imports:
219 |
220 | * `import lombok.*`: Lombok library annotations for generating boilerplate code.
221 |
222 | ##### Class Declaration
223 |
224 | * `@Getter`: Annotation indicating that Lombok should generate getter methods for all fields.
225 | * `@Setter`: Annotation indicating that Lombok should generate setter methods for all fields.
226 | * `@AllArgsConstructor`: Annotation indicating that Lombok should generate a constructor with all fields as arguments.
227 | * `@NoArgsConstructor`: Annotation indicating that Lombok should generate a default constructor with no arguments.
228 | * `@Builder`: Annotation indicating that Lombok should generate a builder method for the class.
229 |
230 | ##### Fields
231 |
232 | * `content`: Represents the content of the chat message.
233 | * `sender`: Represents the sender of the chat message.
234 | * `type`: Represents the type of the chat message, which is defined as an enum called `MessageType`.
235 |
236 | ##### Enum: `MessageType`
237 |
238 | This enum defines the possible types of chat messages: CHAT, LEAVE, and JOIN.
239 |
240 | ##### Methods
241 |
242 | The class also includes getter and setter methods for each field to access and modify their values.
243 |
244 | * `getContent()`: Returns the content of the chat message.
245 | * `setContent(String content)`: Sets the content of the chat message.
246 | * `getSender()`: Returns the sender of the chat message.
247 | * `setSender(String sender)`: Sets the sender of the chat message.
248 | * `getType()`: Returns the type of the chat message.
249 | * `setType(MessageType type)`: Sets the type of the chat message.
250 |
251 | This class serves as a model for chat messages in the application. It encapsulates the content, sender, and type of a chat message. The Lombok annotations eliminate the need to write repetitive boilerplate code for getters, setters, constructors, and builders, making the class concise and easier to work with.
252 |
253 | * * *
254 |
255 | ##### Chat Controller
256 |
257 | Path: controller>ChatController.java
258 | ```
259 | import org.springframework.messaging.handler.annotation.*;
260 | import org.springframework.messaging.simp.SimpMessageHeaderAccessor;
261 | import org.springframework.stereotype.Controller;
262 |
263 | @Controller
264 | public class ChatController {
265 |
266 | @MessageMapping("/chat.register")
267 | @SendTo("/topic/public")
268 | public ChatMessage register(@Payload ChatMessage chatMessage, SimpMessageHeaderAccessor headerAccessor) {
269 | headerAccessor.getSessionAttributes().put("username", chatMessage.getSender());
270 | return chatMessage;
271 | }
272 |
273 | @MessageMapping("/chat.send")
274 | @SendTo("/topic/public")
275 | public ChatMessage sendMessage(@Payload ChatMessage chatMessage) {
276 | return chatMessage;
277 | }
278 | }
279 | ```
280 |
281 | This code is a Spring Framework controller class that handles WebSocket messages for a chat application. It contains two message handling methods: `register` and `sendMessage`.
282 |
283 | ##### Dependencies
284 |
285 | This code relies on the following Spring Framework imports:
286 |
287 | * `org.springframework.messaging.handler.annotation.*`: Provides annotations for handling WebSocket messages.
288 | * `org.springframework.messaging.simp.SimpMessageHeaderAccessor`: Allows access to message headers and session attributes.
289 | * `org.springframework.stereotype.Controller`: Marks the class as a controller component.
290 |
291 | ##### Class Declaration
292 |
293 | * `@Controller`: Annotation indicating that this class is a controller component.
294 |
295 | ##### Methods
296 |
297 | #### `register`
298 |
299 | This method is annotated with `@MessageMapping("/chat.register")` and is invoked when a client sends a message to the "/app/chat.register" destination. It receives a `ChatMessage` object as a payload and a `SimpMessageHeaderAccessor` object to access message headers.
300 |
301 | The method sets the sender's username from the received `ChatMessage` object as a session attribute using the `headerAccessor`. It returns the same `ChatMessage` object, which will be broadcasted to all subscribers of the "/topic/public" channel.
302 |
303 | * `@Payload`: Annotation indicating that the method parameter should be bound to the payload of the received message.
304 |
305 | * `@SendTo("/topic/public")`: Annotation specifying that the return value of the method should be sent as a message to the "/topic/public" destination.
306 |
307 | * Return: The `ChatMessage` object received as the payload.
308 |
309 |
310 | #### `sendMessage`
311 |
312 | This method is annotated with `@MessageMapping("/chat.send")` and is invoked when a client sends a message to the "/app/chat.send" destination. It receives a `ChatMessage` object as a payload.
313 |
314 | The method simply returns the received `ChatMessage` object, which will be broadcasted to all subscribers of the "/topic/public" channel.
315 |
316 | * `@Payload`: Annotation indicating that the method parameter should be bound to the payload of the received message.
317 |
318 | * `@SendTo("/topic/public")`: Annotation specifying that the return value of the method should be sent as a message to the "/topic/public" destination.
319 |
320 | * Return: The `ChatMessage` object received as the payload.
321 |
322 |
323 | This controller class is responsible for handling incoming WebSocket messages related to user registration and sending chat messages. The `register` method is used to register a user by storing their username in the session attributes, while the `sendMessage` method is used to broadcast chat messages to all connected clients. These methods are annotated to specify the destination paths for the messages and the return destinations for broadcasting.
324 |
325 | * * *
326 |
327 | ##### UI
328 |
329 | Path: `resources` directory
330 |
331 | Basic HTML, CSS code and;
332 |
333 | JavaScript code
334 | Path: resources>js>main.js
335 | ```
336 | "use strict";
337 |
338 | var usernamePage = document.querySelector("#username-page");
339 | var chatPage = document.querySelector("#chat-page");
340 | var usernameForm = document.querySelector("#usernameForm");
341 | var messageForm = document.querySelector("#messageForm");
342 | var messageInput = document.querySelector("#message");
343 | var messageArea = document.querySelector("#messageArea");
344 | var connectingElement = document.querySelector(".connecting");
345 |
346 | var stompClient = null;
347 | var username = null;
348 | //mycode
349 | var password = null;
350 |
351 | var colors = \[
352 | "#2196F3",
353 | "#32c787",
354 | "#00BCD4",
355 | "#ff5652",
356 | "#ffc107",
357 | "#ff85af",
358 | "#FF9800",
359 | "#39bbb0",
360 | "#fcba03",
361 | "#fc0303",
362 | "#de5454",
363 | "#b9de54",
364 | "#54ded7",
365 | "#54ded7",
366 | "#1358d6",
367 | "#d611c6",
368 | \];
369 |
370 | function connect(event) {
371 | username = document.querySelector("#name").value.trim();
372 | password = document.querySelector("#password").value;
373 | if (username) {
374 | // Please create a password
375 | if (password == "YOUR PASSWORD") {
376 | usernamePage.classList.add("hidden");
377 | chatPage.classList.remove("hidden");
378 |
379 | var socket = new SockJS("/websocket");
380 | stompClient = Stomp.over(socket);
381 |
382 | stompClient.connect({}, onConnected, onError);
383 | } else {
384 | let mes = document.getElementById("mes");
385 | mes.innerText = "Wrong password";
386 | }
387 | }
388 | event.preventDefault();
389 | }
390 |
391 | function onConnected() {
392 | // Subscribe to the Public Topic
393 | stompClient.subscribe("/topic/public", onMessageReceived);
394 |
395 | // Tell your username to the server
396 | stompClient.send(
397 | "/app/chat.register",
398 | {},
399 | JSON.stringify({ sender: username, type: "JOIN" })
400 | );
401 |
402 | connectingElement.classList.add("hidden");
403 | }
404 |
405 | function onError(error) {
406 | connectingElement.textContent =
407 | "Could not connect to WebSocket! Please refresh the page and try again or contact your administrator.";
408 | connectingElement.style.color = "red";
409 | }
410 |
411 | function send(event) {
412 | var messageContent = messageInput.value.trim();
413 |
414 | if (messageContent && stompClient) {
415 | var chatMessage = {
416 | sender: username,
417 | content: messageInput.value,
418 | type: "CHAT",
419 | };
420 |
421 | stompClient.send("/app/chat.send", {}, JSON.stringify(chatMessage));
422 | messageInput.value = "";
423 | }
424 | event.preventDefault();
425 | }
426 |
427 | function onMessageReceived(payload) {
428 | var message = JSON.parse(payload.body);
429 |
430 | var messageElement = document.createElement("li");
431 |
432 | if (message.type === "JOIN") {
433 | messageElement.classList.add("event-message");
434 | message.content = message.sender + " joined!";
435 | } else if (message.type === "LEAVE") {
436 | messageElement.classList.add("event-message");
437 | message.content = message.sender + " left!";
438 | } else {
439 | messageElement.classList.add("chat-message");
440 |
441 | var avatarElement = document.createElement("i");
442 | var avatarText = document.createTextNode(message.sender\[0\]);
443 | avatarElement.appendChild(avatarText);
444 | avatarElement.style\["background-color"\] = getAvatarColor(message.sender);
445 |
446 | messageElement.appendChild(avatarElement);
447 |
448 | var usernameElement = document.createElement("span");
449 | var usernameText = document.createTextNode(message.sender);
450 | usernameElement.appendChild(usernameText);
451 | messageElement.appendChild(usernameElement);
452 | // \* update
453 | usernameElement.style\["color"\] = getAvatarColor(message.sender);
454 | //\* update end
455 | }
456 |
457 | var textElement = document.createElement("p");
458 | var messageText = document.createTextNode(message.content);
459 | textElement.appendChild(messageText);
460 |
461 | messageElement.appendChild(textElement);
462 | // \* update
463 | if (message.sender === username) {
464 | // Add a class to float the message to the right
465 | messageElement.classList.add("own-message");
466 | } // \* update end
467 | messageArea.appendChild(messageElement);
468 | messageArea.scrollTop = messageArea.scrollHeight;
469 | }
470 |
471 | function getAvatarColor(messageSender) {
472 | var hash = 0;
473 | for (var i = 0; i < messageSender.length; i++) {
474 | hash = 31 \* hash + messageSender.charCodeAt(i);
475 | }
476 |
477 | var index = Math.abs(hash % colors.length);
478 | return colors\[index\];
479 | }
480 |
481 | usernameForm.addEventListener("submit", connect, true);
482 | messageForm.addEventListener("submit", send, true);
483 | ```
484 |
485 | This code is a client-side JavaScript code that enables a user to connect to a chat application using a username and password. It utilizes the Stomp protocol to establish a WebSocket connection and exchange messages with a server.
486 |
487 | ##### Variables
488 |
489 | * `usernamePage`: Represents the element on the page that contains the username input form.
490 | * `chatPage`: Represents the element on the page that displays the chat interface.
491 | * `usernameForm`: Represents the form element for submitting the username.
492 | * `messageForm`: Represents the form element for submitting chat messages.
493 | * `messageInput`: Represents the input field where the user enters chat messages.
494 | * `messageArea`: Represents the area where chat messages are displayed.
495 | * `connectingElement`: Represents the element that indicates the connection status.
496 |
497 | * `stompClient`: Holds the Stomp client instance used for WebSocket communication.
498 |
499 | * `username`: Stores the username entered by the user.
500 | * `password`: Stores the password entered by the user.
501 |
502 | * `colors`: An array of colors used for generating avatar colors.
503 |
504 |
505 | ##### Functions
506 |
507 | #### `connect(event)`
508 |
509 | This function is called when the username form is submitted. It retrieves the username and password entered by the user, checks if the password is correct, and if so, establishes a WebSocket connection to the server. It hides the username page and displays the chat page.
510 |
511 | * `event`: The event object representing the form submission event.
512 |
513 | #### `onConnected()`
514 |
515 | This function is called when the WebSocket connection is successfully established. It subscribes to the "/topic/public" channel to receive messages from the server. It also sends a JOIN message to the server to notify the user's username.
516 |
517 | #### `onError(error)`
518 |
519 | This function is called when an error occurs during the WebSocket connection. It updates the connecting element to display an error message.
520 |
521 | * `error`: The error object representing the connection error.
522 |
523 | #### `send(event)`
524 |
525 | This function is called when the chat message form is submitted. It retrieves the message content, sends the message to the server using the Stomp client, and clears the message input field.
526 |
527 | * `event`: The event object representing the form submission event.
528 |
529 | #### `onMessageReceived(payload)`
530 |
531 | This function is called when a message is received from the server. It parses the message payload, creates the necessary DOM elements to display the message, and appends them to the message area.
532 |
533 | * `payload`: The message payload received from the server.
534 |
535 | #### `getAvatarColor(messageSender)`
536 |
537 | This function generates an avatar color based on the message sender's username. It calculates a hash value based on the characters of the username and maps it to an index in the `colors` array to select a color.
538 |
539 | * `messageSender`: The username of the message sender.
540 |
541 | ##### Event Listeners
542 |
543 | * `usernameForm.addEventListener("submit", connect, true)`: Listens for the submission of the username form and calls the `connect` function.
544 | * `messageForm.addEventListener("submit", send, true)`: Listens for the submission of the chat message form and calls the `send` function.
545 |
--------------------------------------------------------------------------------
/bin/mvnw:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | # ----------------------------------------------------------------------------
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # https://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | # ----------------------------------------------------------------------------
20 |
21 | # ----------------------------------------------------------------------------
22 | # Apache Maven Wrapper startup batch script, version 3.2.0
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | # e.g. to debug Maven itself, use
32 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | # ----------------------------------------------------------------------------
35 |
36 | if [ -z "$MAVEN_SKIP_RC" ] ; then
37 |
38 | if [ -f /usr/local/etc/mavenrc ] ; then
39 | . /usr/local/etc/mavenrc
40 | fi
41 |
42 | if [ -f /etc/mavenrc ] ; then
43 | . /etc/mavenrc
44 | fi
45 |
46 | if [ -f "$HOME/.mavenrc" ] ; then
47 | . "$HOME/.mavenrc"
48 | fi
49 |
50 | fi
51 |
52 | # OS specific support. $var _must_ be set to either true or false.
53 | cygwin=false;
54 | darwin=false;
55 | mingw=false
56 | case "$(uname)" in
57 | CYGWIN*) cygwin=true ;;
58 | MINGW*) mingw=true;;
59 | Darwin*) darwin=true
60 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
61 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
62 | if [ -z "$JAVA_HOME" ]; then
63 | if [ -x "/usr/libexec/java_home" ]; then
64 | JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME
65 | else
66 | JAVA_HOME="/Library/Java/Home"; export JAVA_HOME
67 | fi
68 | fi
69 | ;;
70 | esac
71 |
72 | if [ -z "$JAVA_HOME" ] ; then
73 | if [ -r /etc/gentoo-release ] ; then
74 | JAVA_HOME=$(java-config --jre-home)
75 | fi
76 | fi
77 |
78 | # For Cygwin, ensure paths are in UNIX format before anything is touched
79 | if $cygwin ; then
80 | [ -n "$JAVA_HOME" ] &&
81 | JAVA_HOME=$(cygpath --unix "$JAVA_HOME")
82 | [ -n "$CLASSPATH" ] &&
83 | CLASSPATH=$(cygpath --path --unix "$CLASSPATH")
84 | fi
85 |
86 | # For Mingw, ensure paths are in UNIX format before anything is touched
87 | if $mingw ; then
88 | [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] &&
89 | JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)"
90 | fi
91 |
92 | if [ -z "$JAVA_HOME" ]; then
93 | javaExecutable="$(which javac)"
94 | if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then
95 | # readlink(1) is not available as standard on Solaris 10.
96 | readLink=$(which readlink)
97 | if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then
98 | if $darwin ; then
99 | javaHome="$(dirname "\"$javaExecutable\"")"
100 | javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac"
101 | else
102 | javaExecutable="$(readlink -f "\"$javaExecutable\"")"
103 | fi
104 | javaHome="$(dirname "\"$javaExecutable\"")"
105 | javaHome=$(expr "$javaHome" : '\(.*\)/bin')
106 | JAVA_HOME="$javaHome"
107 | export JAVA_HOME
108 | fi
109 | fi
110 | fi
111 |
112 | if [ -z "$JAVACMD" ] ; then
113 | if [ -n "$JAVA_HOME" ] ; then
114 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
115 | # IBM's JDK on AIX uses strange locations for the executables
116 | JAVACMD="$JAVA_HOME/jre/sh/java"
117 | else
118 | JAVACMD="$JAVA_HOME/bin/java"
119 | fi
120 | else
121 | JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)"
122 | fi
123 | fi
124 |
125 | if [ ! -x "$JAVACMD" ] ; then
126 | echo "Error: JAVA_HOME is not defined correctly." >&2
127 | echo " We cannot execute $JAVACMD" >&2
128 | exit 1
129 | fi
130 |
131 | if [ -z "$JAVA_HOME" ] ; then
132 | echo "Warning: JAVA_HOME environment variable is not set."
133 | fi
134 |
135 | # traverses directory structure from process work directory to filesystem root
136 | # first directory with .mvn subdirectory is considered project base directory
137 | find_maven_basedir() {
138 | if [ -z "$1" ]
139 | then
140 | echo "Path not specified to find_maven_basedir"
141 | return 1
142 | fi
143 |
144 | basedir="$1"
145 | wdir="$1"
146 | while [ "$wdir" != '/' ] ; do
147 | if [ -d "$wdir"/.mvn ] ; then
148 | basedir=$wdir
149 | break
150 | fi
151 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
152 | if [ -d "${wdir}" ]; then
153 | wdir=$(cd "$wdir/.." || exit 1; pwd)
154 | fi
155 | # end of workaround
156 | done
157 | printf '%s' "$(cd "$basedir" || exit 1; pwd)"
158 | }
159 |
160 | # concatenates all lines of a file
161 | concat_lines() {
162 | if [ -f "$1" ]; then
163 | # Remove \r in case we run on Windows within Git Bash
164 | # and check out the repository with auto CRLF management
165 | # enabled. Otherwise, we may read lines that are delimited with
166 | # \r\n and produce $'-Xarg\r' rather than -Xarg due to word
167 | # splitting rules.
168 | tr -s '\r\n' ' ' < "$1"
169 | fi
170 | }
171 |
172 | log() {
173 | if [ "$MVNW_VERBOSE" = true ]; then
174 | printf '%s\n' "$1"
175 | fi
176 | }
177 |
178 | BASE_DIR=$(find_maven_basedir "$(dirname "$0")")
179 | if [ -z "$BASE_DIR" ]; then
180 | exit 1;
181 | fi
182 |
183 | MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR
184 | log "$MAVEN_PROJECTBASEDIR"
185 |
186 | ##########################################################################################
187 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
188 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
189 | ##########################################################################################
190 | wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar"
191 | if [ -r "$wrapperJarPath" ]; then
192 | log "Found $wrapperJarPath"
193 | else
194 | log "Couldn't find $wrapperJarPath, downloading it ..."
195 |
196 | if [ -n "$MVNW_REPOURL" ]; then
197 | wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar"
198 | else
199 | wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar"
200 | fi
201 | while IFS="=" read -r key value; do
202 | # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' )
203 | safeValue=$(echo "$value" | tr -d '\r')
204 | case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;;
205 | esac
206 | done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
207 | log "Downloading from: $wrapperUrl"
208 |
209 | if $cygwin; then
210 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath")
211 | fi
212 |
213 | if command -v wget > /dev/null; then
214 | log "Found wget ... using wget"
215 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet"
216 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
217 | wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
218 | else
219 | wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath"
220 | fi
221 | elif command -v curl > /dev/null; then
222 | log "Found curl ... using curl"
223 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent"
224 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
225 | curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
226 | else
227 | curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath"
228 | fi
229 | else
230 | log "Falling back to using Java to download"
231 | javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java"
232 | javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class"
233 | # For Cygwin, switch paths to Windows format before running javac
234 | if $cygwin; then
235 | javaSource=$(cygpath --path --windows "$javaSource")
236 | javaClass=$(cygpath --path --windows "$javaClass")
237 | fi
238 | if [ -e "$javaSource" ]; then
239 | if [ ! -e "$javaClass" ]; then
240 | log " - Compiling MavenWrapperDownloader.java ..."
241 | ("$JAVA_HOME/bin/javac" "$javaSource")
242 | fi
243 | if [ -e "$javaClass" ]; then
244 | log " - Running MavenWrapperDownloader.java ..."
245 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath"
246 | fi
247 | fi
248 | fi
249 | fi
250 | ##########################################################################################
251 | # End of extension
252 | ##########################################################################################
253 |
254 | # If specified, validate the SHA-256 sum of the Maven wrapper jar file
255 | wrapperSha256Sum=""
256 | while IFS="=" read -r key value; do
257 | case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;;
258 | esac
259 | done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties"
260 | if [ -n "$wrapperSha256Sum" ]; then
261 | wrapperSha256Result=false
262 | if command -v sha256sum > /dev/null; then
263 | if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then
264 | wrapperSha256Result=true
265 | fi
266 | elif command -v shasum > /dev/null; then
267 | if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then
268 | wrapperSha256Result=true
269 | fi
270 | else
271 | echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available."
272 | echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties."
273 | exit 1
274 | fi
275 | if [ $wrapperSha256Result = false ]; then
276 | echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2
277 | echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2
278 | echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2
279 | exit 1
280 | fi
281 | fi
282 |
283 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
284 |
285 | # For Cygwin, switch paths to Windows format before running java
286 | if $cygwin; then
287 | [ -n "$JAVA_HOME" ] &&
288 | JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME")
289 | [ -n "$CLASSPATH" ] &&
290 | CLASSPATH=$(cygpath --path --windows "$CLASSPATH")
291 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
292 | MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR")
293 | fi
294 |
295 | # Provide a "standardized" way to retrieve the CLI args that will
296 | # work with both Windows and non-Windows executions.
297 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*"
298 | export MAVEN_CMD_LINE_ARGS
299 |
300 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
301 |
302 | # shellcheck disable=SC2086 # safe args
303 | exec "$JAVACMD" \
304 | $MAVEN_OPTS \
305 | $MAVEN_DEBUG_OPTS \
306 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
307 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
308 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
309 |
--------------------------------------------------------------------------------
/bin/mvnw.cmd:
--------------------------------------------------------------------------------
1 | @REM ----------------------------------------------------------------------------
2 | @REM Licensed to the Apache Software Foundation (ASF) under one
3 | @REM or more contributor license agreements. See the NOTICE file
4 | @REM distributed with this work for additional information
5 | @REM regarding copyright ownership. The ASF licenses this file
6 | @REM to you under the Apache License, Version 2.0 (the
7 | @REM "License"); you may not use this file except in compliance
8 | @REM with the License. You may obtain a copy of the License at
9 | @REM
10 | @REM https://www.apache.org/licenses/LICENSE-2.0
11 | @REM
12 | @REM Unless required by applicable law or agreed to in writing,
13 | @REM software distributed under the License is distributed on an
14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | @REM KIND, either express or implied. See the License for the
16 | @REM specific language governing permissions and limitations
17 | @REM under the License.
18 | @REM ----------------------------------------------------------------------------
19 |
20 | @REM ----------------------------------------------------------------------------
21 | @REM Apache Maven Wrapper startup batch script, version 3.2.0
22 | @REM
23 | @REM Required ENV vars:
24 | @REM JAVA_HOME - location of a JDK home dir
25 | @REM
26 | @REM Optional ENV vars
27 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
28 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
29 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
30 | @REM e.g. to debug Maven itself, use
31 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
32 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
33 | @REM ----------------------------------------------------------------------------
34 |
35 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
36 | @echo off
37 | @REM set title of command window
38 | title %0
39 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
40 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
41 |
42 | @REM set %HOME% to equivalent of $HOME
43 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
44 |
45 | @REM Execute a user defined script before this one
46 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
47 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
48 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %*
49 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %*
50 | :skipRcPre
51 |
52 | @setlocal
53 |
54 | set ERROR_CODE=0
55 |
56 | @REM To isolate internal variables from possible post scripts, we use another setlocal
57 | @setlocal
58 |
59 | @REM ==== START VALIDATION ====
60 | if not "%JAVA_HOME%" == "" goto OkJHome
61 |
62 | echo.
63 | echo Error: JAVA_HOME not found in your environment. >&2
64 | echo Please set the JAVA_HOME variable in your environment to match the >&2
65 | echo location of your Java installation. >&2
66 | echo.
67 | goto error
68 |
69 | :OkJHome
70 | if exist "%JAVA_HOME%\bin\java.exe" goto init
71 |
72 | echo.
73 | echo Error: JAVA_HOME is set to an invalid directory. >&2
74 | echo JAVA_HOME = "%JAVA_HOME%" >&2
75 | echo Please set the JAVA_HOME variable in your environment to match the >&2
76 | echo location of your Java installation. >&2
77 | echo.
78 | goto error
79 |
80 | @REM ==== END VALIDATION ====
81 |
82 | :init
83 |
84 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
85 | @REM Fallback to current working directory if not found.
86 |
87 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
88 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
89 |
90 | set EXEC_DIR=%CD%
91 | set WDIR=%EXEC_DIR%
92 | :findBaseDir
93 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
94 | cd ..
95 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
96 | set WDIR=%CD%
97 | goto findBaseDir
98 |
99 | :baseDirFound
100 | set MAVEN_PROJECTBASEDIR=%WDIR%
101 | cd "%EXEC_DIR%"
102 | goto endDetectBaseDir
103 |
104 | :baseDirNotFound
105 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
106 | cd "%EXEC_DIR%"
107 |
108 | :endDetectBaseDir
109 |
110 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
111 |
112 | @setlocal EnableExtensions EnableDelayedExpansion
113 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
114 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
115 |
116 | :endReadAdditionalConfig
117 |
118 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
121 |
122 | set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar"
123 |
124 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
125 | IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B
126 | )
127 |
128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
130 | if exist %WRAPPER_JAR% (
131 | if "%MVNW_VERBOSE%" == "true" (
132 | echo Found %WRAPPER_JAR%
133 | )
134 | ) else (
135 | if not "%MVNW_REPOURL%" == "" (
136 | SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar"
137 | )
138 | if "%MVNW_VERBOSE%" == "true" (
139 | echo Couldn't find %WRAPPER_JAR%, downloading it ...
140 | echo Downloading from: %WRAPPER_URL%
141 | )
142 |
143 | powershell -Command "&{"^
144 | "$webclient = new-object System.Net.WebClient;"^
145 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
146 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
147 | "}"^
148 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^
149 | "}"
150 | if "%MVNW_VERBOSE%" == "true" (
151 | echo Finished downloading %WRAPPER_JAR%
152 | )
153 | )
154 | @REM End of extension
155 |
156 | @REM If specified, validate the SHA-256 sum of the Maven wrapper jar file
157 | SET WRAPPER_SHA_256_SUM=""
158 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
159 | IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B
160 | )
161 | IF NOT %WRAPPER_SHA_256_SUM%=="" (
162 | powershell -Command "&{"^
163 | "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^
164 | "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^
165 | " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^
166 | " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^
167 | " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^
168 | " exit 1;"^
169 | "}"^
170 | "}"
171 | if ERRORLEVEL 1 goto error
172 | )
173 |
174 | @REM Provide a "standardized" way to retrieve the CLI args that will
175 | @REM work with both Windows and non-Windows executions.
176 | set MAVEN_CMD_LINE_ARGS=%*
177 |
178 | %MAVEN_JAVA_EXE% ^
179 | %JVM_CONFIG_MAVEN_PROPS% ^
180 | %MAVEN_OPTS% ^
181 | %MAVEN_DEBUG_OPTS% ^
182 | -classpath %WRAPPER_JAR% ^
183 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^
184 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
185 | if ERRORLEVEL 1 goto error
186 | goto end
187 |
188 | :error
189 | set ERROR_CODE=1
190 |
191 | :end
192 | @endlocal & set ERROR_CODE=%ERROR_CODE%
193 |
194 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost
195 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
196 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat"
197 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd"
198 | :skipRcPost
199 |
200 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
201 | if "%MAVEN_BATCH_PAUSE%"=="on" pause
202 |
203 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE%
204 |
205 | cmd /C exit /B %ERROR_CODE%
206 |
--------------------------------------------------------------------------------
/bin/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |