├── .gitignore
├── .mvn
└── wrapper
│ ├── MavenWrapperDownloader.java
│ ├── maven-wrapper.jar
│ └── maven-wrapper.properties
├── LICENSE
├── README.md
├── mvnw
├── mvnw.cmd
├── pom.xml
└── src
├── main
├── java
│ └── com
│ │ └── tupinamba
│ │ └── springbootwebsocket
│ │ ├── SpringBootWebsocketApplication.java
│ │ ├── config
│ │ └── WebSocketConfig.java
│ │ ├── controller
│ │ └── ChatController.java
│ │ └── model
│ │ └── ChatMessage.java
└── resources
│ ├── application.properties
│ └── static
│ ├── css
│ └── main.css
│ ├── index.html
│ ├── js
│ └── main.js
│ └── maxresdefault.jpg
└── test
└── java
└── com
└── tupinamba
└── springbootwebsocket
└── SpringBootWebsocketApplicationTests.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/MavenWrapperDownloader.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2007-present the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | import java.net.*;
18 | import java.io.*;
19 | import java.nio.channels.*;
20 | import java.util.Properties;
21 |
22 | public class MavenWrapperDownloader {
23 |
24 | private static final String WRAPPER_VERSION = "0.5.6";
25 | /**
26 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
27 | */
28 | private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
29 | + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
30 |
31 | /**
32 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
33 | * use instead of the default one.
34 | */
35 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
36 | ".mvn/wrapper/maven-wrapper.properties";
37 |
38 | /**
39 | * Path where the maven-wrapper.jar will be saved to.
40 | */
41 | private static final String MAVEN_WRAPPER_JAR_PATH =
42 | ".mvn/wrapper/maven-wrapper.jar";
43 |
44 | /**
45 | * Name of the property which should be used to override the default download url for the wrapper.
46 | */
47 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
48 |
49 | public static void main(String args[]) {
50 | System.out.println("- Downloader started");
51 | File baseDirectory = new File(args[0]);
52 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
53 |
54 | // If the maven-wrapper.properties exists, read it and check if it contains a custom
55 | // wrapperUrl parameter.
56 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
57 | String url = DEFAULT_DOWNLOAD_URL;
58 | if (mavenWrapperPropertyFile.exists()) {
59 | FileInputStream mavenWrapperPropertyFileInputStream = null;
60 | try {
61 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
62 | Properties mavenWrapperProperties = new Properties();
63 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
64 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
65 | } catch (IOException e) {
66 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
67 | } finally {
68 | try {
69 | if (mavenWrapperPropertyFileInputStream != null) {
70 | mavenWrapperPropertyFileInputStream.close();
71 | }
72 | } catch (IOException e) {
73 | // Ignore ...
74 | }
75 | }
76 | }
77 | System.out.println("- Downloading from: " + url);
78 |
79 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
80 | if (!outputFile.getParentFile().exists()) {
81 | if (!outputFile.getParentFile().mkdirs()) {
82 | System.out.println(
83 | "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
84 | }
85 | }
86 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
87 | try {
88 | downloadFileFromURL(url, outputFile);
89 | System.out.println("Done");
90 | System.exit(0);
91 | } catch (Throwable e) {
92 | System.out.println("- Error downloading");
93 | e.printStackTrace();
94 | System.exit(1);
95 | }
96 | }
97 |
98 | private static void downloadFileFromURL(String urlString, File destination) throws Exception {
99 | if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
100 | String username = System.getenv("MVNW_USERNAME");
101 | char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
102 | Authenticator.setDefault(new Authenticator() {
103 | @Override
104 | protected PasswordAuthentication getPasswordAuthentication() {
105 | return new PasswordAuthentication(username, password);
106 | }
107 | });
108 | }
109 | URL website = new URL(urlString);
110 | ReadableByteChannel rbc;
111 | rbc = Channels.newChannel(website.openStream());
112 | FileOutputStream fos = new FileOutputStream(destination);
113 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
114 | fos.close();
115 | rbc.close();
116 | }
117 |
118 | }
119 |
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/gabrielpulga/spring-boot-websocket/bd659c813d26b5f54bfc2467fc657848bebf04c2/.mvn/wrapper/maven-wrapper.jar
--------------------------------------------------------------------------------
/.mvn/wrapper/maven-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.3/apache-maven-3.6.3-bin.zip
2 | wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar
3 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 Gabriel Pulga
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | ## Building a Real Time Chat Application with Spring Boot and Websocket
3 |
4 | ## What is Websocket?
5 | > WebSocket is a computer communications protocol, providing full-duplex communication channels over a single TCP connection.
6 | > WebSocket is distinct from HTTP. 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.
7 |
8 | 
9 |
10 | 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.
11 |
12 | This is the main reasion which websocket is preferred over the HTTP protocol when building a chat-like communication service that operates at high frequencies with low latency.
13 |
14 | ## What is STOMP?
15 | > 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.
16 |
17 | 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.
18 |
19 | ## Setting up the application
20 |
21 | Our application will have the following configuration which can be set using [Spring Initializr](https://start.spring.io/) :
22 |
23 | * Java version : 11
24 |
25 | * Type : Maven Project
26 |
27 | * Dependencies : Websocket
28 |
29 | * Spring Boot version : 2.4.2
30 |
31 | 
32 |
33 | ## Project structure
34 |
35 | 
36 |
37 | ## Configuring WebSocket
38 |
39 | Configuring our websocket endpoint and message broker is fairly simple.
40 |
41 | @Configuration
42 | @EnableWebSocketMessageBroker
43 | public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {
44 |
45 | @Override
46 | public void registerStompEndpoints(StompEndpointRegistry registry) {
47 | registry.addEndpoint("/websocket").withSockJS();
48 | }
49 |
50 | @Override
51 | public void configureMessageBroker(MessageBrokerRegistry registry) {
52 | registry.enableSimpleBroker("/topic");
53 | registry.setApplicationDestinationPrefixes("/app");
54 | }
55 | }
56 |
57 | * @EnableWebSocketMessageBroker annotation is used to enable our WebSocket server.
58 |
59 | * WebSocketMessageBrokerConfigurer interface is used to provide implementation for some of its methods to configure the websocket connection.
60 |
61 | * registerStompEndpoints method is used to register a websocket endpoint that the clients will use to connect to the server.
62 |
63 | * configureMessageBroker method is used to configure our message broker which will be used to route messages from one client to another.
64 |
65 | SockJS is also being used to enable fallback options for browsers that don’t support websocket.
66 |
67 | ## Creating a Chat Model
68 |
69 | Our chat model is the message payload which will be exchanged between the client side and server side of the application.
70 |
71 | public class ChatMessage {
72 | private String content;
73 | private String sender;
74 | private MessageType type;
75 |
76 | public enum MessageType {
77 | *CHAT*, *LEAVE*, *JOIN
78 | *}
79 |
80 | public String getContent() {
81 | return content;
82 | }
83 |
84 | public void setContent(String content) {
85 | this.content = content;
86 | }
87 |
88 | public String getSender() {
89 | return sender;
90 | }
91 |
92 | public void setSender(String sender) {
93 | this.sender = sender;
94 | }
95 |
96 | public MessageType getType() {
97 | return type;
98 | }
99 |
100 | public void setType(MessageType type) {
101 | this.type = type;
102 | }
103 | }
104 |
105 | ## Creating our Chat Controller
106 |
107 | Our controller will be responsible for handling all message methods present in our chat application which will basically receive messages from one client and then broadcast it to others.
108 |
109 | @Controller
110 | public class ChatController {
111 |
112 | @MessageMapping("/chat.register")
113 | @SendTo("/topic/public")
114 | public ChatMessage register(@Payload ChatMessage chatMessage, SimpMessageHeaderAccessor headerAccessor) {
115 | headerAccessor.getSessionAttributes().put("username", chatMessage.getSender());
116 | return chatMessage;
117 | }
118 |
119 | @MessageMapping("/chat.send")
120 | @SendTo("/topic/public")
121 | public ChatMessage sendMessage(@Payload ChatMessage chatMessage) {
122 | return chatMessage;
123 | }
124 | }
125 |
126 | The use of /app as a destination point is because of our websocket configuration file which says that all messages will be routed to these handling methods annotated with @MessageMapping.
127 |
128 | ## Creating a front-end UI
129 |
130 | 
131 |
132 | Our UI is a simple cardbox built using HTML and CSS that runs some JS functions to send and receive messages.
133 |
134 | * index.html is a HTML file which contains some basic structure a S*ock.js* to enable fallback options to those that can’t run JS on their browsers and a *STOMP* library to serve as a message broker.
135 | * main.css is a CSS file that styles our HTML.
136 | * main.js is a Javascript file which connects the websocket endpoint to send and receive messages. It also displays and format the messages on the screen.
137 |
138 | ## End result
139 |
140 | 
141 |
142 | 
143 |
--------------------------------------------------------------------------------
/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 | # Maven Start Up Batch script
23 | #
24 | # Required ENV vars:
25 | # ------------------
26 | # JAVA_HOME - location of a JDK home dir
27 | #
28 | # Optional ENV vars
29 | # -----------------
30 | # M2_HOME - location of maven2's installed home dir
31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven
32 | # e.g. to debug Maven itself, use
33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files
35 | # ----------------------------------------------------------------------------
36 |
37 | if [ -z "$MAVEN_SKIP_RC" ]; then
38 |
39 | if [ -f /etc/mavenrc ]; then
40 | . /etc/mavenrc
41 | fi
42 |
43 | if [ -f "$HOME/.mavenrc" ]; then
44 | . "$HOME/.mavenrc"
45 | fi
46 |
47 | fi
48 |
49 | # OS specific support. $var _must_ be set to either true or false.
50 | cygwin=false
51 | darwin=false
52 | mingw=false
53 | case "$(uname)" in
54 | CYGWIN*) cygwin=true ;;
55 | MINGW*) mingw=true ;;
56 | Darwin*)
57 | darwin=true
58 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
59 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html
60 | if [ -z "$JAVA_HOME" ]; then
61 | if [ -x "/usr/libexec/java_home" ]; then
62 | export JAVA_HOME="$(/usr/libexec/java_home)"
63 | else
64 | export JAVA_HOME="/Library/Java/Home"
65 | fi
66 | fi
67 | ;;
68 | esac
69 |
70 | if [ -z "$JAVA_HOME" ]; then
71 | if [ -r /etc/gentoo-release ]; then
72 | JAVA_HOME=$(java-config --jre-home)
73 | fi
74 | fi
75 |
76 | if [ -z "$M2_HOME" ]; then
77 | ## resolve links - $0 may be a link to maven's home
78 | PRG="$0"
79 |
80 | # need this for relative symlinks
81 | while [ -h "$PRG" ]; do
82 | ls=$(ls -ld "$PRG")
83 | link=$(expr "$ls" : '.*-> \(.*\)$')
84 | if expr "$link" : '/.*' >/dev/null; then
85 | PRG="$link"
86 | else
87 | PRG="$(dirname "$PRG")/$link"
88 | fi
89 | done
90 |
91 | saveddir=$(pwd)
92 |
93 | M2_HOME=$(dirname "$PRG")/..
94 |
95 | # make it fully qualified
96 | M2_HOME=$(cd "$M2_HOME" && pwd)
97 |
98 | cd "$saveddir"
99 | # echo Using m2 at $M2_HOME
100 | fi
101 |
102 | # For Cygwin, ensure paths are in UNIX format before anything is touched
103 | if $cygwin; then
104 | [ -n "$M2_HOME" ] &&
105 | M2_HOME=$(cygpath --unix "$M2_HOME")
106 | [ -n "$JAVA_HOME" ] &&
107 | JAVA_HOME=$(cygpath --unix "$JAVA_HOME")
108 | [ -n "$CLASSPATH" ] &&
109 | CLASSPATH=$(cygpath --path --unix "$CLASSPATH")
110 | fi
111 |
112 | # For Mingw, ensure paths are in UNIX format before anything is touched
113 | if $mingw; then
114 | [ -n "$M2_HOME" ] &&
115 | M2_HOME="$( (
116 | cd "$M2_HOME"
117 | pwd
118 | ))"
119 | [ -n "$JAVA_HOME" ] &&
120 | JAVA_HOME="$( (
121 | cd "$JAVA_HOME"
122 | pwd
123 | ))"
124 | fi
125 |
126 | if [ -z "$JAVA_HOME" ]; then
127 | javaExecutable="$(which javac)"
128 | if [ -n "$javaExecutable" ] && ! [ "$(expr \"$javaExecutable\" : '\([^ ]*\)')" = "no" ]; then
129 | # readlink(1) is not available as standard on Solaris 10.
130 | readLink=$(which readlink)
131 | if [ ! $(expr "$readLink" : '\([^ ]*\)') = "no" ]; then
132 | if $darwin; then
133 | javaHome="$(dirname \"$javaExecutable\")"
134 | javaExecutable="$(cd \"$javaHome\" && pwd -P)/javac"
135 | else
136 | javaExecutable="$(readlink -f \"$javaExecutable\")"
137 | fi
138 | javaHome="$(dirname \"$javaExecutable\")"
139 | javaHome=$(expr "$javaHome" : '\(.*\)/bin')
140 | JAVA_HOME="$javaHome"
141 | export JAVA_HOME
142 | fi
143 | fi
144 | fi
145 |
146 | if [ -z "$JAVACMD" ]; then
147 | if [ -n "$JAVA_HOME" ]; then
148 | if [ -x "$JAVA_HOME/jre/sh/java" ]; then
149 | # IBM's JDK on AIX uses strange locations for the executables
150 | JAVACMD="$JAVA_HOME/jre/sh/java"
151 | else
152 | JAVACMD="$JAVA_HOME/bin/java"
153 | fi
154 | else
155 | JAVACMD="$(which java)"
156 | fi
157 | fi
158 |
159 | if [ ! -x "$JAVACMD" ]; then
160 | echo "Error: JAVA_HOME is not defined correctly." >&2
161 | echo " We cannot execute $JAVACMD" >&2
162 | exit 1
163 | fi
164 |
165 | if [ -z "$JAVA_HOME" ]; then
166 | echo "Warning: JAVA_HOME environment variable is not set."
167 | fi
168 |
169 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
170 |
171 | # traverses directory structure from process work directory to filesystem root
172 | # first directory with .mvn subdirectory is considered project base directory
173 | find_maven_basedir() {
174 |
175 | if [ -z "$1" ]; then
176 | echo "Path not specified to find_maven_basedir"
177 | return 1
178 | fi
179 |
180 | basedir="$1"
181 | wdir="$1"
182 | while [ "$wdir" != '/' ]; do
183 | if [ -d "$wdir"/.mvn ]; then
184 | basedir=$wdir
185 | break
186 | fi
187 | # workaround for JBEAP-8937 (on Solaris 10/Sparc)
188 | if [ -d "${wdir}" ]; then
189 | wdir=$(
190 | cd "$wdir/.."
191 | pwd
192 | )
193 | fi
194 | # end of workaround
195 | done
196 | echo "${basedir}"
197 | }
198 |
199 | # concatenates all lines of a file
200 | concat_lines() {
201 | if [ -f "$1" ]; then
202 | echo "$(tr -s '\n' ' ' <"$1")"
203 | fi
204 | }
205 |
206 | BASE_DIR=$(find_maven_basedir "$(pwd)")
207 | if [ -z "$BASE_DIR" ]; then
208 | exit 1
209 | fi
210 |
211 | ##########################################################################################
212 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
213 | # This allows using the maven wrapper in projects that prohibit checking in binary data.
214 | ##########################################################################################
215 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
216 | if [ "$MVNW_VERBOSE" = true ]; then
217 | echo "Found .mvn/wrapper/maven-wrapper.jar"
218 | fi
219 | else
220 | if [ "$MVNW_VERBOSE" = true ]; then
221 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
222 | fi
223 | if [ -n "$MVNW_REPOURL" ]; then
224 | jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
225 | else
226 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
227 | fi
228 | while IFS="=" read key value; do
229 | case "$key" in wrapperUrl)
230 | jarUrl="$value"
231 | break
232 | ;;
233 | esac
234 | done <"$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
235 | if [ "$MVNW_VERBOSE" = true ]; then
236 | echo "Downloading from: $jarUrl"
237 | fi
238 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
239 | if $cygwin; then
240 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath")
241 | fi
242 |
243 | if command -v wget >/dev/null; then
244 | if [ "$MVNW_VERBOSE" = true ]; then
245 | echo "Found wget ... using wget"
246 | fi
247 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
248 | wget "$jarUrl" -O "$wrapperJarPath"
249 | else
250 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath"
251 | fi
252 | elif command -v curl >/dev/null; then
253 | if [ "$MVNW_VERBOSE" = true ]; then
254 | echo "Found curl ... using curl"
255 | fi
256 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
257 | curl -o "$wrapperJarPath" "$jarUrl" -f
258 | else
259 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
260 | fi
261 |
262 | else
263 | if [ "$MVNW_VERBOSE" = true ]; then
264 | echo "Falling back to using Java to download"
265 | fi
266 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
267 | # For Cygwin, switch paths to Windows format before running javac
268 | if $cygwin; then
269 | javaClass=$(cygpath --path --windows "$javaClass")
270 | fi
271 | if [ -e "$javaClass" ]; then
272 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
273 | if [ "$MVNW_VERBOSE" = true ]; then
274 | echo " - Compiling MavenWrapperDownloader.java ..."
275 | fi
276 | # Compiling the Java class
277 | ("$JAVA_HOME/bin/javac" "$javaClass")
278 | fi
279 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
280 | # Running the downloader
281 | if [ "$MVNW_VERBOSE" = true ]; then
282 | echo " - Running MavenWrapperDownloader.java ..."
283 | fi
284 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
285 | fi
286 | fi
287 | fi
288 | fi
289 | ##########################################################################################
290 | # End of extension
291 | ##########################################################################################
292 |
293 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
294 | if [ "$MVNW_VERBOSE" = true ]; then
295 | echo $MAVEN_PROJECTBASEDIR
296 | fi
297 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
298 |
299 | # For Cygwin, switch paths to Windows format before running java
300 | if $cygwin; then
301 | [ -n "$M2_HOME" ] &&
302 | M2_HOME=$(cygpath --path --windows "$M2_HOME")
303 | [ -n "$JAVA_HOME" ] &&
304 | JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME")
305 | [ -n "$CLASSPATH" ] &&
306 | CLASSPATH=$(cygpath --path --windows "$CLASSPATH")
307 | [ -n "$MAVEN_PROJECTBASEDIR" ] &&
308 | MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR")
309 | fi
310 |
311 | # Provide a "standardized" way to retrieve the CLI args that will
312 | # work with both Windows and non-Windows executions.
313 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
314 | export MAVEN_CMD_LINE_ARGS
315 |
316 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
317 |
318 | exec "$JAVACMD" \
319 | $MAVEN_OPTS \
320 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
321 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
322 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
323 |
--------------------------------------------------------------------------------
/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 Maven Start Up Batch script
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 M2_HOME - location of maven2's installed home dir
28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
31 | @REM e.g. to debug Maven itself, use
32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
34 | @REM ----------------------------------------------------------------------------
35 |
36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
37 | @echo off
38 | @REM set title of command window
39 | title %0
40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
42 |
43 | @REM set %HOME% to equivalent of $HOME
44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
45 |
46 | @REM Execute a user defined script before this one
47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending
49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
51 | :skipRcPre
52 |
53 | @setlocal
54 |
55 | set ERROR_CODE=0
56 |
57 | @REM To isolate internal variables from possible post scripts, we use another setlocal
58 | @setlocal
59 |
60 | @REM ==== START VALIDATION ====
61 | if not "%JAVA_HOME%" == "" goto OkJHome
62 |
63 | echo.
64 | echo Error: JAVA_HOME not found in your environment. >&2
65 | echo Please set the JAVA_HOME variable in your environment to match the >&2
66 | echo location of your Java installation. >&2
67 | echo.
68 | goto error
69 |
70 | :OkJHome
71 | if exist "%JAVA_HOME%\bin\java.exe" goto init
72 |
73 | echo.
74 | echo Error: JAVA_HOME is set to an invalid directory. >&2
75 | echo JAVA_HOME = "%JAVA_HOME%" >&2
76 | echo Please set the JAVA_HOME variable in your environment to match the >&2
77 | echo location of your Java installation. >&2
78 | echo.
79 | goto error
80 |
81 | @REM ==== END VALIDATION ====
82 |
83 | :init
84 |
85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
86 | @REM Fallback to current working directory if not found.
87 |
88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
90 |
91 | set EXEC_DIR=%CD%
92 | set WDIR=%EXEC_DIR%
93 | :findBaseDir
94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound
95 | cd ..
96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound
97 | set WDIR=%CD%
98 | goto findBaseDir
99 |
100 | :baseDirFound
101 | set MAVEN_PROJECTBASEDIR=%WDIR%
102 | cd "%EXEC_DIR%"
103 | goto endDetectBaseDir
104 |
105 | :baseDirNotFound
106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
107 | cd "%EXEC_DIR%"
108 |
109 | :endDetectBaseDir
110 |
111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
112 |
113 | @setlocal EnableExtensions EnableDelayedExpansion
114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
116 |
117 | :endReadAdditionalConfig
118 |
119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
122 |
123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
124 |
125 | FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
127 | )
128 |
129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data.
131 | if exist %WRAPPER_JAR% (
132 | if "%MVNW_VERBOSE%" == "true" (
133 | echo Found %WRAPPER_JAR%
134 | )
135 | ) else (
136 | if not "%MVNW_REPOURL%" == "" (
137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
138 | )
139 | if "%MVNW_VERBOSE%" == "true" (
140 | echo Couldn't find %WRAPPER_JAR%, downloading it ...
141 | echo Downloading from: %DOWNLOAD_URL%
142 | )
143 |
144 | powershell -Command "&{"^
145 | "$webclient = new-object System.Net.WebClient;"^
146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
148 | "}"^
149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
150 | "}"
151 | if "%MVNW_VERBOSE%" == "true" (
152 | echo Finished downloading %WRAPPER_JAR%
153 | )
154 | )
155 | @REM End of extension
156 |
157 | @REM Provide a "standardized" way to retrieve the CLI args that will
158 | @REM work with both Windows and non-Windows executions.
159 | set MAVEN_CMD_LINE_ARGS=%*
160 |
161 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
162 | if ERRORLEVEL 1 goto error
163 | goto end
164 |
165 | :error
166 | set ERROR_CODE=1
167 |
168 | :end
169 | @endlocal & set ERROR_CODE=%ERROR_CODE%
170 |
171 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
172 | @REM check for post script, once with legacy .bat ending and once with .cmd ending
173 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
174 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
175 | :skipRcPost
176 |
177 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
178 | if "%MAVEN_BATCH_PAUSE%" == "on" pause
179 |
180 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
181 |
182 | exit /B %ERROR_CODE%
183 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |