v0.8.8

Author: fvarrui

README.md

@@ -103,17 +103,29 @@ And by default it will generate next artifacts in `target ` folder:
 
 ### Plugin assets
 
-Some assets, such as application icons, could be located in `assets` folder organized by platform, and so it would not be necessary to specify the `iconFile` property:
+Some assets, such as application icons and Velocity templates, could be located in `assets` folder organized by platform.
 
 ```
-<project>
-└── assets
-	├── linux
+<project>/
+└── assets/
+	├── linux/
+	├── macosx/
+	└── windows/
+```
+
+#### Icons
+
+If icons are located in `assets` folders, it would not be necessary to specify the `iconFile` property:
+
+```
+<project>/
+└── assets/
+	├── linux/
 	│   └── projectname.png		# on GNU/Linux it has to be a png image
-	├── macosx
+	├── macosx/
 	│   └── projectname.icns	# on Mac OS X it has to be a icns file
-	└── windows
-	    └── projectname.ico		# on Windows it has to be an ico file
+	└── windows/
+	    └── projectname.ico		# on Windows it has to be a ico file
 ```
 
 > **projectname** corresponds to `name` property in `pom.xml`.
@@ -122,6 +134,48 @@ Some assets, such as application icons, could be located in `assets` folder orga
 >
 > ![Default icon](https://raw.githubusercontent.com/fvarrui/JavaPackager/master/src/main/resources/linux/default-icon.png)
 
+#### Velocity templates
+
+Velocity templates (.vtl files) are used to generate some artifacts which have to be bundled with the app.
+
+It is possible to use our own customized templates. We only have to put all or some of the next templates in the `assets` folder organized by platform, and the plugin will use these templates instead of default ones:
+
+```
+<project>/
+└── assets/
+	├── linux/
+	|   ├── control.vtl	        # DEB control template
+	|   ├── desktop.vtl	        # Desktop template
+	│   └── startup.sh.vtl		# Startup script template
+	├── macosx/
+	|   ├── Info.plist.vtl	    # Info.plist template
+	│   └── startup.vtl	        # Startup script template
+	└── windows/
+	    ├── exe.manifest.vtl	# exe.manifest template
+	    └── iss.vtl				# Inno Setup Script template
+```
+
+You can use the [default templates](https://github.com/fvarrui/JavaPackager/tree/master/src/main/resources) as an example.
+
+A map called `info` is given to all templates when they are rendered, which contains next properties:
+
+| Property                        | Type    | Description                                      |
+| ------------------------------- | ------- | ------------------------------------------------ |
+| `${info.name}`                  | String  | Same as `name` plugin property.                  |
+| `${displayName}`                | String  | Same as `displayName` plugin property.           |
+| `${info.version}`               | String  | Same as `version` plugin property.               |
+| `${info.description}`           | String  | Same as `description` plugin property.           |
+| `${info.url}`                   | String  | Same as `url` plugin property.                   |
+| `${info.organizationName}`      | String  | Same as `organizationName` plugin property.      |
+| `${info.organizationUrl}`       | String  | Same as `organizationUrl` plugin property.       |
+| `${info.organizationEmail}`     | String  | Same as `organizationEmail` plugin property.     |
+| `${info.administratorRequired}` | Boolean | Same as `administratorRequired` plugin property. |
+| `${info.bundleJre}`             | Boolean | Same as `bundleJre` plugin property.             |
+| `${info.jarFile}`               | String  | Full path to runnable JAR file.                  |
+| `${info.license}`               | String  | Full path to license file.                       |
+| `${info.envPath}`               | String  | Same as `envPath` plugin property.               |
+| `${info.vmArgs}`                | String  | Same as `vmArgs` plugin property.                |
+
 ## How to build and install the plugin
 
 Execute next commands in BASH (GNU/Linux or macOS) or CMD (Windows):

releases/fvarrui/maven/javapackager/0.8.8/_remote.repositories

@@ -1,4 +1,4 @@
 #NOTE: This is a Maven Resolver internal implementation file, its format can be changed without prior notice.
-#Thu Jan 16 12:38:57 WET 2020
+#Thu Jan 16 14:22:12 WET 2020
 javapackager-0.8.8.jar>=
 javapackager-0.8.8.pom>=

releases/fvarrui/maven/javapackager/0.8.8/javapackager-0.8.8.jar

@@ -19,6 +19,6 @@
       <version>0.8.7</version>
       <version>0.8.8</version>
     </versions>
-    <lastUpdated>20200116123857</lastUpdated>
+    <lastUpdated>20200116142212</lastUpdated>
   </versioning>
 </metadata>

releases/fvarrui/maven/javapackager/maven-metadata-local.xml

@@ -35,6 +35,7 @@
 import org.twdata.maven.mojoexecutor.MojoExecutor.ExecutionEnvironment;
 
 import fvarrui.maven.plugin.javapackager.utils.FileUtils;
+import fvarrui.maven.plugin.javapackager.utils.IconUtils;
 import fvarrui.maven.plugin.javapackager.utils.JavaUtils;
 import fvarrui.maven.plugin.javapackager.utils.Logger;
 import fvarrui.maven.plugin.javapackager.utils.CommandUtils;
@@ -207,6 +208,9 @@ public void execute() throws MojoExecutionException {
 
 		// locates license file
 		resolveLicense();
+		
+		// locates icon file
+		resolveIcon();
 
 		// creates a runnable jar file
         if (runnableJar == null || runnableJar.isBlank()) {
@@ -260,12 +264,10 @@ private void resolveLicense() {
 	 * Locates assets or default icon file if the specified one doesn't exist or
 	 * isn't specified
 	 * 
-	 * @param platform      Target platform
-	 * @param iconExtension Icon file extension (.ico for Windows, .png for
-	 *                      GNU/Linux, .icns for MacOS)
 	 * @throws MojoExecutionException
 	 */
-	private void resolveIcon(Platform platform, String iconExtension) throws MojoExecutionException {
+	private void resolveIcon() throws MojoExecutionException {
+		String iconExtension = IconUtils.getIconFileExtensionByPlatform(platform);
 		if (iconFile == null) {
 			iconFile = new File("assets/" + platform + "/", mavenProject.getName() + iconExtension);
 		}
@@ -424,7 +426,6 @@ private void createMacApp() throws MojoExecutionException {
 
 		// determines icon file location and copies it to resources folder
 		getLog().info("Copying icon file to Resources folder");
-		resolveIcon(Platform.mac, ".icns");
 		FileUtils.copyFileToFolder(iconFile.getAbsoluteFile(), resourcesFolder);
 
 		// creates and write the Info.plist file
@@ -452,7 +453,6 @@ private void createLinuxApp() throws MojoExecutionException {
 		getLog().info("Creating GNU/Linux app bundle...");
 
 		// determines icon file location and copies it to app folder
-		resolveIcon(Platform.linux, ".png");
 		FileUtils.copyFileToFolder(iconFile, appFolder);
 
 		// copies all dependencies
@@ -489,9 +489,6 @@ private void createLinuxApp() throws MojoExecutionException {
 	private void createWindowsApp() throws MojoExecutionException {
 		getLog().info("Creating Windows app bundle...");
 
-		// determines icon file location
-		resolveIcon(Platform.windows, ".ico");
-
 		// generates manifest file to require administrator privileges from velocity template
 		File manifestFile = new File(assetsFolder, name + ".exe.manifest");
 		VelocityUtils.render("windows/exe.manifest.vtl", manifestFile, info);

src/main/java/fvarrui/maven/plugin/javapackager/PackageMojo.java

@@ -0,0 +1,16 @@
+package fvarrui.maven.plugin.javapackager.utils;
+
+import fvarrui.maven.plugin.javapackager.Platform;
+
+public class IconUtils {
+
+	public static String getIconFileExtensionByPlatform(Platform platform) {
+		switch (platform) {
+		case linux: 	return ".png";
+		case mac: 		return ".icns";
+		case windows: 	return ".ico";
+		default:		return null;
+		}
+	}
+	
+}

src/main/java/fvarrui/maven/plugin/javapackager/utils/IconUtils.java

@@ -11,21 +11,31 @@
 import org.apache.velocity.app.VelocityEngine;
 import org.apache.velocity.runtime.RuntimeConstants;
 import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
+import org.apache.velocity.runtime.resource.loader.FileResourceLoader;
 
 public class VelocityUtils {
 
 	private static VelocityEngine velocityEngine;
 
 	static {
 		velocityEngine = new VelocityEngine();
-		velocityEngine.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
-		velocityEngine.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
+		
+		// specify resource loaders to use
+		velocityEngine.setProperty(RuntimeConstants.RESOURCE_LOADER, "file,class");
+		
+		// for the loader 'file', set the FileResourceLoader as the class to use and use 'assets' directory for templates
+		velocityEngine.setProperty("file.resource.loader.class", FileResourceLoader.class.getName());
+		velocityEngine.setProperty("file.resource.loader.path", "assets");
+		
+		// for the loader 'class', set the ClasspathResourceLoader as the class to use
+		velocityEngine.setProperty("class.resource.loader.class", ClasspathResourceLoader.class.getName());
+		
 		velocityEngine.init();
 	}
 
 	public static void render(String templatePath, File output, Map<String, Object> info) throws MojoExecutionException {
 		try {
-
+			
 			VelocityContext context = new VelocityContext();
 			context.put("info", info);