Skip to content

Commit cacfd9f

Browse files
Adam-Booth-NCLAdam-Booth-NCL
committed
Add quickstart project
0 parents  commit cacfd9f

32 files changed

+2840
-0
lines changed

‎.dockerignore

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

‎.gitignore

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

‎.mvn/wrapper/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
maven-wrapper.jar

‎.mvn/wrapper/MavenWrapperDownloader.java

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
/*
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
import java.net.*;
21+
import java.io.*;
22+
import java.nio.channels.*;
23+
import java.util.Properties;
24+
25+
public class MavenWrapperDownloader
26+
{
27+
private static final String WRAPPER_VERSION = "3.1.1";
28+
29+
/**
30+
* Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided.
31+
*/
32+
private static final String DEFAULT_DOWNLOAD_URL =
33+
"https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/" + WRAPPER_VERSION
34+
+ "/maven-wrapper-" + WRAPPER_VERSION + ".jar";
35+
36+
/**
37+
* Path to the maven-wrapper.properties file, which might contain a downloadUrl property to use instead of the
38+
* default one.
39+
*/
40+
private static final String MAVEN_WRAPPER_PROPERTIES_PATH = ".mvn/wrapper/maven-wrapper.properties";
41+
42+
/**
43+
* Path where the maven-wrapper.jar will be saved to.
44+
*/
45+
private static final String MAVEN_WRAPPER_JAR_PATH = ".mvn/wrapper/maven-wrapper.jar";
46+
47+
/**
48+
* Name of the property which should be used to override the default download url for the wrapper.
49+
*/
50+
private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl";
51+
52+
public static void main( String args[] )
53+
{
54+
System.out.println( "- Downloader started" );
55+
File baseDirectory = new File( args[0] );
56+
System.out.println( "- Using base directory: " + baseDirectory.getAbsolutePath() );
57+
58+
// If the maven-wrapper.properties exists, read it and check if it contains a custom
59+
// wrapperUrl parameter.
60+
File mavenWrapperPropertyFile = new File( baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH );
61+
String url = DEFAULT_DOWNLOAD_URL;
62+
if ( mavenWrapperPropertyFile.exists() )
63+
{
64+
FileInputStream mavenWrapperPropertyFileInputStream = null;
65+
try
66+
{
67+
mavenWrapperPropertyFileInputStream = new FileInputStream( mavenWrapperPropertyFile );
68+
Properties mavenWrapperProperties = new Properties();
69+
mavenWrapperProperties.load( mavenWrapperPropertyFileInputStream );
70+
url = mavenWrapperProperties.getProperty( PROPERTY_NAME_WRAPPER_URL, url );
71+
}
72+
catch ( IOException e )
73+
{
74+
System.out.println( "- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'" );
75+
}
76+
finally
77+
{
78+
try
79+
{
80+
if ( mavenWrapperPropertyFileInputStream != null )
81+
{
82+
mavenWrapperPropertyFileInputStream.close();
83+
}
84+
}
85+
catch ( IOException e )
86+
{
87+
// Ignore ...
88+
}
89+
}
90+
}
91+
System.out.println( "- Downloading from: " + url );
92+
93+
File outputFile = new File( baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH );
94+
if ( !outputFile.getParentFile().exists() )
95+
{
96+
if ( !outputFile.getParentFile().mkdirs() )
97+
{
98+
System.out.println( "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath()
99+
+ "'" );
100+
}
101+
}
102+
System.out.println( "- Downloading to: " + outputFile.getAbsolutePath() );
103+
try
104+
{
105+
downloadFileFromURL( url, outputFile );
106+
System.out.println( "Done" );
107+
System.exit( 0 );
108+
}
109+
catch ( Throwable e )
110+
{
111+
System.out.println( "- Error downloading" );
112+
e.printStackTrace();
113+
System.exit( 1 );
114+
}
115+
}
116+
117+
private static void downloadFileFromURL( String urlString, File destination )
118+
throws Exception
119+
{
120+
if ( System.getenv( "MVNW_USERNAME" ) != null && System.getenv( "MVNW_PASSWORD" ) != null )
121+
{
122+
String username = System.getenv( "MVNW_USERNAME" );
123+
char[] password = System.getenv( "MVNW_PASSWORD" ).toCharArray();
124+
Authenticator.setDefault( new Authenticator()
125+
{
126+
@Override
127+
protected PasswordAuthentication getPasswordAuthentication()
128+
{
129+
return new PasswordAuthentication( username, password );
130+
}
131+
} );
132+
}
133+
URL website = new URL( urlString );
134+
ReadableByteChannel rbc;
135+
rbc = Channels.newChannel( website.openStream() );
136+
FileOutputStream fos = new FileOutputStream( destination );
137+
fos.getChannel().transferFrom( rbc, 0, Long.MAX_VALUE );
138+
fos.close();
139+
rbc.close();
140+
}
141+
142+
}

‎.mvn/wrapper/maven-wrapper.properties

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
18+
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

‎.s2i/environment

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
MAVEN_S2I_ARTIFACT_DIRS=target/quarkus-app
2+
S2I_SOURCE_DEPLOYMENTS_FILTER=app lib quarkus quarkus-run.jar
3+
JAVA_OPTIONS=-Dquarkus.http.host=0.0.0.0
4+
AB_JOLOKIA_OFF=true
5+
JAVA_APP_JAR=/deployments/quarkus-run.jar

‎README.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# CSC8104 Quickstart Project
2+
3+
This quickstart project is provided for students on the CSC8104 Enterprise Middleware module and provides a foundation for starting their coursework. Students are expected to download and build their solution within the provided project and should not aim to create a new project from scratch.
4+
5+
Within the project there is an example REST service for creating and storing contacts which can be accessed via the Swagger UI endpoint (http://localhost:8080/q/swagger-ui). It is encouraged that students spend spend time reading through this code to gain a strong understanding of how the project works. Not only this, but students are also encouraged to follow a similar packaging structure.
6+
7+
Students are not required to remove the contact service and can leave this functionality in their submission.
8+
9+
Throughout the coursework specification there are many links to various guides to help you complete the coursework. It is strongly encouraged that you spend time working through these guides before attempting to implement the specification requirements.
10+
11+
## Running the application in dev mode
12+
13+
You can run your application in dev mode that enables live coding using:
14+
```shell script
15+
./mvnw compile quarkus:dev
16+
```
17+
18+
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

0 commit comments

Comments
 (0)