Skip to content

Commit 7513e46

Browse files
cescoffiercescoffier
authored
Merge pull request quarkusio#540 from maxandersen/commandmode
initial command mode quickstart
2 parents c78925f + d2c7c0c commit 7513e46

File tree

14 files changed

+967
-0
lines changed

14 files changed

+967
-0
lines changed

‎getting-started-command-mode/.dockerignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
*
2+
!target/*-runner
3+
!target/*-runner.jar
4+
!target/lib/*

‎getting-started-command-mode/.gitignore

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Eclipse
2+
.project
3+
.classpath
4+
.settings/
5+
bin/
6+
7+
# IntelliJ
8+
.idea
9+
*.ipr
10+
*.iml
11+
*.iws
12+
13+
# NetBeans
14+
nb-configuration.xml
15+
16+
# Visual Studio Code
17+
.vscode
18+
19+
# OSX
20+
.DS_Store
21+
22+
# Vim
23+
*.swp
24+
*.swo
25+
26+
# patch
27+
*.orig
28+
*.rej
29+
30+
# Maven
31+
target/
32+
pom.xml.tag
33+
pom.xml.releaseBackup
34+
pom.xml.versionsBackup
35+
release.properties

‎getting-started-command-mode/.mvn/wrapper/MavenWrapperDownloader.java

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
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+
* http://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+
import java.net.*;
17+
import java.io.*;
18+
import java.nio.channels.*;
19+
import java.util.Properties;
20+
21+
public class MavenWrapperDownloader {
22+
23+
private static final String WRAPPER_VERSION = "0.5.5";
24+
/**
25+
* Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
26+
*/
27+
private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/"
28+
+ WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
29+
30+
/**
31+
* Path to the maven-wrapper.properties file, which might contain a downloadUrl property to
32+
* use instead of the default one.
33+
*/
34+
private static final String MAVEN_WRAPPER_PROPERTIES_PATH =
35+
".mvn/wrapper/maven-wrapper.properties";
36+
37+
/**
38+
* Path where the maven-wrapper.jar will be saved to.
39+
*/
40+
private static final String MAVEN_WRAPPER_JAR_PATH =
41+
".mvn/wrapper/maven-wrapper.jar";
42+
43+
/**
44+
* Name of the property which should be used to override the default download url for the wrapper.
45+
*/
46+
private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
47+
48+
public static void main(String args[]) {
49+
System.out.println("- Downloader started");
50+
File baseDirectory = new File(args[0]);
51+
System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath());
52+
53+
// If the maven-wrapper.properties exists, read it and check if it contains a custom
54+
// wrapperUrl parameter.
55+
File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH);
56+
String url = DEFAULT_DOWNLOAD_URL;
57+
if(mavenWrapperPropertyFile.exists()) {
58+
FileInputStream mavenWrapperPropertyFileInputStream = null;
59+
try {
60+
mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile);
61+
Properties mavenWrapperProperties = new Properties();
62+
mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream);
63+
url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url);
64+
} catch (IOException e) {
65+
System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'");
66+
} finally {
67+
try {
68+
if(mavenWrapperPropertyFileInputStream != null) {
69+
mavenWrapperPropertyFileInputStream.close();
70+
}
71+
} catch (IOException e) {
72+
// Ignore ...
73+
}
74+
}
75+
}
76+
System.out.println("- Downloading from: " + url);
77+
78+
File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH);
79+
if(!outputFile.getParentFile().exists()) {
80+
if(!outputFile.getParentFile().mkdirs()) {
81+
System.out.println(
82+
"- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'");
83+
}
84+
}
85+
System.out.println("- Downloading to: " + outputFile.getAbsolutePath());
86+
try {
87+
downloadFileFromURL(url, outputFile);
88+
System.out.println("Done");
89+
System.exit(0);
90+
} catch (Throwable e) {
91+
System.out.println("- Error downloading");
92+
e.printStackTrace();
93+
System.exit(1);
94+
}
95+
}
96+
97+
private static void downloadFileFromURL(String urlString, File destination) throws Exception {
98+
if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) {
99+
String username = System.getenv("MVNW_USERNAME");
100+
char[] password = System.getenv("MVNW_PASSWORD").toCharArray();
101+
Authenticator.setDefault(new Authenticator() {
102+
@Override
103+
protected PasswordAuthentication getPasswordAuthentication() {
104+
return new PasswordAuthentication(username, password);
105+
}
106+
});
107+
}
108+
URL website = new URL(urlString);
109+
ReadableByteChannel rbc;
110+
rbc = Channels.newChannel(website.openStream());
111+
FileOutputStream fos = new FileOutputStream(destination);
112+
fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE);
113+
fos.close();
114+
rbc.close();
115+
}
116+
117+
}

‎getting-started-command-mode/.mvn/wrapper/maven-wrapper.jar

49.5 KB
Binary file not shown.

‎getting-started-command-mode/.mvn/wrapper/maven-wrapper.properties

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.6.2/apache-maven-3.6.2-bin.zip
2+
wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.5/maven-wrapper-0.5.5.jar

‎getting-started-command-mode/README.md

+81
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
# Getting started with Quarkus command mode
2+
3+
This is a minimal command mode application that access Quarkus API's.
4+
5+
Under the hood, this demo uses:
6+
7+
- `@QuarkusMain` to enable a custom main class
8+
9+
## Requirements
10+
11+
To compile and run this demo you will need:
12+
13+
- JDK 1.8+
14+
- GraalVM
15+
16+
### Configuring GraalVM and JDK 1.8+
17+
18+
Make sure that both the `GRAALVM_HOME` and `JAVA_HOME` environment variables have
19+
been set, and that a JDK 1.8+ `java` command is on the path.
20+
21+
See the [Building a Native Executable guide](https://quarkus.io/guides/building-native-image-guide)
22+
for help setting up your environment.
23+
24+
## Building the application
25+
26+
Launch the Maven build on the checked out sources of this demo:
27+
28+
> ./mvnw install
29+
30+
### Live coding with Quarkus
31+
32+
The Maven Quarkus plugin provides a development mode that supports
33+
live coding. To try this out:
34+
35+
> ./mvnw quarkus:dev
36+
37+
or
38+
39+
> ./mvnw quarkus:dev -Dquarkus.args=<args>
40+
41+
if you want to pass arguments in.
42+
43+
This command will run the command mode application and if you press enter run it again.
44+
45+
1. Make a change in [src/main/java/org/acme/getting/started/commandmode/GreetingResource.java](src/main/java/org/acme/getting/started/commandmode/GreetingService.java). Replace `hello` with `hello there` in the `greeting()` method.
46+
- Press Enter in your terminal.
47+
You should now see `hello there`.
48+
- Undo the change, so the method returns `hello` again.
49+
- Press Enter again. You should now see `hello`.
50+
51+
### Run Quarkus in JVM mode
52+
53+
When you're done iterating in developer mode, you can run the application as a
54+
conventional jar file.
55+
56+
First compile it:
57+
58+
> ./mvnw install
59+
60+
Then run it:
61+
62+
> java -jar ./target/getting-started-command-mode-1.0-SNAPSHOT-runner.jar
63+
64+
Have a look at how fast it boots, or measure the total native memory consumption.
65+
66+
### Run Quarkus as a native executable
67+
68+
You can also create a native executable from this application without making any
69+
source code changes. A native executable removes the dependency on the JVM:
70+
everything needed to run the application on the target platform is included in
71+
the executable, allowing the application to run with minimal resource overhead.
72+
73+
Compiling a native executable takes a bit longer, as GraalVM performs additional
74+
steps to remove unnecessary codepaths. Use the `native` profile to compile a
75+
native executable:
76+
77+
> ./mvnw install -Dnative
78+
79+
After getting a cup of coffee, you'll be able to run this executable directly:
80+
81+
> ./target/getting-started-command-mode-1.0-SNAPSHOT-runner

0 commit comments

Comments
 (0)