Gradle Application Plugin – APP_HOME in applicationDefaultJvmArgs

By mkyong | Updated: March 6, 2015

Viewed: 500 (+3 pv/w)

Tags: distzip gradle

In Gardle, the application plugin, you can pass the system properties via applicationDefaultJvmArgs :

	apply plugin:'application'
	mainClassName = "com.mkyong.analyzer.engine.hydra.entryPointForJar"
	applicationName = 'analyzer'

	distZip {
		archiveName 'analyzer-' + version + '.zip'
	}

	applicationDefaultJvmArgs = ["-Dlogback.configurationFile=logback.xml"]

The problem is how to get the APP_HOME for logback.xml?

	applicationDefaultJvmArgs = ["-Dlogback.configurationFile=APP_HOME/logback.xml"]

You can hard code the APP_HOME, but this will only work for one platform (Windows or *nix).

1. Solution

To fix it, create a custom “MY_APP_HOME” variable, and replace it with doLast

	applicationDefaultJvmArgs = ["-Dlogback.configurationFile=MY_APP_HOME/logback.xml"]
	
	startScripts {
		doLast {
			unixScript.text = unixScript.text.replace('MY_APP_HOME', '\$APP_HOME') 
			windowsScript.text = windowsScript.text.replace('MY_APP_HOME', '%~dp0..')
		}
	}

Build it.

gradle distZip

Output

#!/usr/bin/env bash

##############################################################################
##
##  analyzer start up script for UN*X
##
##############################################################################

DEFAULT_JVM_OPTS='"-Dlogback.configurationFile=$APP_HOME/logback.xml"

@if "%DEBUG%" == "" @echo off
@rem ##########################################################################
@rem
@rem  analyzer startup script for Windows
@rem
@rem ##########################################################################

set DEFAULT_JVM_OPTS="-Dlogback.configurationFile=%~dp0../logback.xml"

2. Solution – Custom Startup Script

This is for the custom startup script:

  task abcStartScripts(type: CreateStartScripts) {
	mainClassName = "com.mkyong.analyzer.engine.hydra.entryPointForJar"
	classpath = startScripts.classpath
	outputDir = startScripts.outputDir
	applicationName = 'analyzer'
	defaultJvmOpts = ["-Dlogback.configurationFile=MY_APP_HOME/logback.xml"]
		
	abcStartScripts {
		doLast {
			unixScript.text = unixScript.text.replace('MY_APP_HOME', '\$APP_HOME') 
			windowsScript.text = windowsScript.text.replace('MY_APP_HOME', '%~dp0..')
		}
	}
		
  }
	
  applicationDistribution.into("bin") {
        from(hostingStatStartScripts)
        fileMode = 0755
  }

References

1. Gradle – The Application Plugin
2. Gradle DSL reference – CreateStartScripts
3. Gradle DSL Reference – The Application plugin