windows-service-installer:installer

Full name:

com.alexkasko.installer:maven-windows-service-installer-plugin:1.0.6:installer

Description:

Maven plugin, creates izPack installer

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
appDataDirs List - Application directories to be included into installer
User property is: installer.appDataDirs.
prunsrvDaemonLauncherClass String - Application class implementing com.alexkasko.installer.DaemonLauncher. Will be called by StandardLauncher (prunsrvStartClass) by default
User property is: installer.prunsrvDaemonLauncherClass.

Optional Parameters

Name Type Since Description
buildOutputFile File - Base directory of compilation process
Default value is: ${project.build.directory}/izpack/build.log.
User property is: installer.buildOutputFile.
buildUnixDist boolean - Whether to build unix tar.gz distribution
Default value is: false.
User property is: installer.buildUnixDist.
distDir File - Directory of distribution before for packaging
Default value is: ${project.build.directory}/izpack/dist.
User property is: installer.distDir.
distOutputFile File - Output file (distibution)
Default value is: ${project.build.directory}/${project.artifactId}-dist.tgz.
User property is: installer.distOutputFile.
installConfigFile File - IzPack config file
User property is: installer.installConfigFile.
installLauncher32Path String - Resource path to x86 installer launcher
Default value is: classpath:/launchers/x86/install.exe.
User property is: installer.installLauncher32Path.
installLauncher64Path String - Resource path to x64 installer launcher
Default value is: classpath:/launchers/x64/install.exe.
User property is: installer.uninstallLauncher32Path.
installerOutputFile File - Output file (installer)
Default value is: ${project.build.directory}/${project.artifactId}-${project.version}-installer.zip.
User property is: installer.installerOutputFile.
izpackAdditionalPacksPath String - Definition of additional installer packs
Default value is: classpath:/izpack/addpacks.xml.
User property is: installer.izpackAdditionalPacksPath.
izpackAdditionalResourcePaths List - Definition of additional resources
User property is: installer.izpackAdditionalResourcePaths.
izpackAppFilesPackDescription String - Application Files pack description
Default value is: Necessary application files.
User property is: installer.izpackAppFilesPackDescription.
izpackAppFilesPackName String - Application Files pack name
Default value is: Application Files.
User property is: installer.izpackAppFilesPackName.
izpackAppName String - Application name displayed in installer
Default value is: ${project.name}.
User property is: installer.izpackAppName.
izpackAppVersion String - Application version displayed in installer
Default value is: ${project.version}.
User property is: installer.izpackAppVersion.
izpackCompress String - Installer compress option, values are 'raw' (default), 'deflate' and 'bzip2'
Default value is: raw.
User property is: installer.izpackCompress.
izpackDefaultInstallDir String - Default installation directory
Default value is: $USER_HOME\${project.name}.
User property is: installer.izpackDefaultInstallDir.
izpackDir File - Base directory of compilation process
Default value is: ${project.build.directory}/izpack.
User property is: installer.baseDir.
izpackFrameIconPath String - Icon to be used on top of installer frame
Default value is: classpath:/izpack/install.png.
User property is: installer.izpackFrameIconPath.
izpackHelloIconPath String - Icon to be used on Hello screen
Default value is: classpath:/izpack/install.png.
User property is: installer.izpackHelloIconPath.
izpackJREPackDescription String - JRE pack description
Default value is: Java Runtime Environment.
User property is: installer.izpackJREPackName.
izpackJREPackName String - JRE pack name
Default value is: Java Runtime Environment.
User property is: installer.izpackJREPackName.
izpackLang String - Installer language, see http://izpack.org/documentation/installation-files.html#the-localization-element-locale
Default value is: xxx.
User property is: installer.izpackLang.
izpackWindowsServicePackDescription String - Windows Service pack description
Default value is: Application will be installed as Windows Service using prunsrv tool from Apache Commons Daemon project, see http://commons.apache.org/daemon.
User property is: installer.izpackWindowsServicePackDescription.
izpackWindowsServicePackName String - Windows Service pack name
Default value is: Windows Service Installer.
User property is: installer.izpackWindowsServicePackName.
jreDir File - Path to windows JRE
Default value is: ${java.home}.
User property is: installer.jreDir.
prunsrvDescription String - Windows service description
Default value is: ${project.name}.
User property is: installer.prunsrvDescription.
prunsrvDisplayName String - Windows service display name
Default value is: ${project.name}.
User property is: installer.prunsrvDisplayName.
prunsrvJvmMs int - JVM XMs option in MB
Default value is: 64.
User property is: installer.prunsrvJvmMs.
prunsrvJvmMx int - JVM XMx option in MB
Default value is: 1024.
User property is: installer.prunsrvJvmMx.
prunsrvJvmOptions String - JVM options, delimiter is ';', use separate maven options for XMs, XMx and XSs
User property is: installer.prunsrvJvmOptions.
prunsrvJvmSs int - JVM XSs option in KB
Default value is: 512.
User property is: installer.prunsrvJvmSs.
prunsrvLauncherJarFile String - Name of the launcher JAR file
Default value is: ${project.artifactId}.jar.
User property is: installer.prunsrvLauncherJarFile.
prunsrvLogLevel String - Prunsrv log level
Default value is: INFO.
User property is: installer.prunsrvLogLevel.
prunsrvLogPath String - Prunsrv log path, relative to APP_ROOT
Default value is: logs.
User property is: installer.prunsrvLogPath.
prunsrvLogPrefix String - Prunsrv log prefix
Default value is: daemon.
User property is: installer.prunsrvLogPrefix.
prunsrvScriptsEncoding String - For non-ASCII service display name and description non-ASCII characters must be encoded in .bat files in appropriate MS-DOS CpXXX encoding
Default value is: UTF-8.
User property is: installer.prunsrvScriptsEncoding.
prunsrvServiceName String - Windows service name
Default value is: ${project.artifactId}.
User property is: installer.prunsrvServiceName.
prunsrvStartClass String - Start class that will be used with prunsrv
Default value is: com.alexkasko.installer.StandardLauncher.
User property is: installer.prunsrvStartClass.
prunsrvStartOnInstrall boolean - Whether to start service immediately after installation
Default value is: true.
User property is: installer.prunsrvStartOnInstrall.
prunsrvStartParams String - Input params for prunsrvStartMethod Default value 'start;${installer.prunsrvDaemonLauncherClass}' will be substituted in getter
User property is: installer.prunsrvStartParams.
prunsrvStartupMode String - Name of the launcher JAR file
Default value is: auto.
User property is: installer.prunsrvStartupMode.
prunsrvStdError String - Std out file, relative to APP_ROOT
Default value is: logs\std_err.txt.
User property is: installer.prunsrvStdError.
prunsrvStdOutput String - Std out file, relative to APP_ROOT
Default value is: logs\std_out.txt.
User property is: installer.prunsrvStdOutput.
prunsrvStopClass String - Stop class that will be used with prunsrv Default value '${installer.prunsrvDaemonLauncherClass}' will be substituted in getter
Default value is: com.alexkasko.installer.StandardLauncher.
User property is: installer.prunsrvStopClass.
prunsrvStopParams String - Input params for prunsrvStopParams Default value 'stop;${installer.prunsrvDaemonLauncherClass}' will be substituted in getter
User property is: installer.prunsrvStopParams.
prunsrvStopTimeout int - Prunsrv service stop timeout in seconds
Default value is: 0.
User property is: installer.prunsrvStopTimeout.
uninstallLauncher32Path String - Resource path to x86 uninstaller launcher
Default value is: classpath:/launchers/x86/uninstall.exe.
User property is: installer.uninstallLauncher32Path.
uninstallLauncher64Path String - Resource path to x64 uninstaller launcher
Default value is: classpath:/launchers/x64/uninstall.exe.
User property is: installer.uninstallLauncher32Path.
use64BitJre boolean - Whether JRE is 64 bit
Default value is: false.
User property is: installer.use64BitJre.
useX86LaunchersForX64Installer boolean - Use x86 launcher binaries for x64 installers instead of default x64 ones
Default value is: false.
User property is: installer.useX86LaunchersForX64Installer.

Parameter Details

appDataDirs:

Application directories to be included into installer
  • Type: java.util.List
  • Required: Yes
  • User Property: installer.appDataDirs

buildOutputFile:

Base directory of compilation process
  • Type: java.io.File
  • Required: No
  • User Property: installer.buildOutputFile
  • Default: ${project.build.directory}/izpack/build.log

buildUnixDist:

Whether to build unix tar.gz distribution
  • Type: boolean
  • Required: No
  • User Property: installer.buildUnixDist
  • Default: false

distDir:

Directory of distribution before for packaging
  • Type: java.io.File
  • Required: No
  • User Property: installer.distDir
  • Default: ${project.build.directory}/izpack/dist

distOutputFile:

Output file (distibution)
  • Type: java.io.File
  • Required: No
  • User Property: installer.distOutputFile
  • Default: ${project.build.directory}/${project.artifactId}-dist.tgz

installConfigFile:

IzPack config file
  • Type: java.io.File
  • Required: No
  • User Property: installer.installConfigFile

installLauncher32Path:

Resource path to x86 installer launcher
  • Type: java.lang.String
  • Required: No
  • User Property: installer.installLauncher32Path
  • Default: classpath:/launchers/x86/install.exe

installLauncher64Path:

Resource path to x64 installer launcher
  • Type: java.lang.String
  • Required: No
  • User Property: installer.uninstallLauncher32Path
  • Default: classpath:/launchers/x64/install.exe

installerOutputFile:

Output file (installer)
  • Type: java.io.File
  • Required: No
  • User Property: installer.installerOutputFile
  • Default: ${project.build.directory}/${project.artifactId}-${project.version}-installer.zip

izpackAdditionalPacksPath:

Definition of additional installer packs
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackAdditionalPacksPath
  • Default: classpath:/izpack/addpacks.xml

izpackAdditionalResourcePaths:

Definition of additional resources
  • Type: java.util.List
  • Required: No
  • User Property: installer.izpackAdditionalResourcePaths

izpackAppFilesPackDescription:

Application Files pack description
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackAppFilesPackDescription
  • Default: Necessary application files

izpackAppFilesPackName:

Application Files pack name
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackAppFilesPackName
  • Default: Application Files

izpackAppName:

Application name displayed in installer
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackAppName
  • Default: ${project.name}

izpackAppVersion:

Application version displayed in installer
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackAppVersion
  • Default: ${project.version}

izpackCompress:

Installer compress option, values are 'raw' (default), 'deflate' and 'bzip2'
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackCompress
  • Default: raw

izpackDefaultInstallDir:

Default installation directory
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackDefaultInstallDir
  • Default: $USER_HOME\${project.name}

izpackDir:

Base directory of compilation process
  • Type: java.io.File
  • Required: No
  • User Property: installer.baseDir
  • Default: ${project.build.directory}/izpack

izpackFrameIconPath:

Icon to be used on top of installer frame
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackFrameIconPath
  • Default: classpath:/izpack/install.png

izpackHelloIconPath:

Icon to be used on Hello screen
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackHelloIconPath
  • Default: classpath:/izpack/install.png

izpackJREPackDescription:

JRE pack description
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackJREPackName
  • Default: Java Runtime Environment

izpackJREPackName:

JRE pack name
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackJREPackName
  • Default: Java Runtime Environment

izpackLang:

Installer language, see http://izpack.org/documentation/installation-files.html#the-localization-element-locale
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackLang
  • Default: xxx

izpackWindowsServicePackDescription:

Windows Service pack description
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackWindowsServicePackDescription
  • Default: Application will be installed as Windows Service using prunsrv tool from Apache Commons Daemon project, see http://commons.apache.org/daemon

izpackWindowsServicePackName:

Windows Service pack name
  • Type: java.lang.String
  • Required: No
  • User Property: installer.izpackWindowsServicePackName
  • Default: Windows Service Installer

jreDir:

Path to windows JRE
  • Type: java.io.File
  • Required: No
  • User Property: installer.jreDir
  • Default: ${java.home}

prunsrvDaemonLauncherClass:

Application class implementing com.alexkasko.installer.DaemonLauncher. Will be called by StandardLauncher (prunsrvStartClass) by default
  • Type: java.lang.String
  • Required: Yes
  • User Property: installer.prunsrvDaemonLauncherClass

prunsrvDescription:

Windows service description
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvDescription
  • Default: ${project.name}

prunsrvDisplayName:

Windows service display name
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvDisplayName
  • Default: ${project.name}

prunsrvJvmMs:

JVM XMs option in MB
  • Type: int
  • Required: No
  • User Property: installer.prunsrvJvmMs
  • Default: 64

prunsrvJvmMx:

JVM XMx option in MB
  • Type: int
  • Required: No
  • User Property: installer.prunsrvJvmMx
  • Default: 1024

prunsrvJvmOptions:

JVM options, delimiter is ';', use separate maven options for XMs, XMx and XSs
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvJvmOptions

prunsrvJvmSs:

JVM XSs option in KB
  • Type: int
  • Required: No
  • User Property: installer.prunsrvJvmSs
  • Default: 512

prunsrvLauncherJarFile:

Name of the launcher JAR file
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvLauncherJarFile
  • Default: ${project.artifactId}.jar

prunsrvLogLevel:

Prunsrv log level
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvLogLevel
  • Default: INFO

prunsrvLogPath:

Prunsrv log path, relative to APP_ROOT
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvLogPath
  • Default: logs

prunsrvLogPrefix:

Prunsrv log prefix
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvLogPrefix
  • Default: daemon

prunsrvScriptsEncoding:

For non-ASCII service display name and description non-ASCII characters must be encoded in .bat files in appropriate MS-DOS CpXXX encoding
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvScriptsEncoding
  • Default: UTF-8

prunsrvServiceName:

Windows service name
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvServiceName
  • Default: ${project.artifactId}

prunsrvStartClass:

Start class that will be used with prunsrv
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStartClass
  • Default: com.alexkasko.installer.StandardLauncher

prunsrvStartOnInstrall:

Whether to start service immediately after installation
  • Type: boolean
  • Required: No
  • User Property: installer.prunsrvStartOnInstrall
  • Default: true

prunsrvStartParams:

Input params for prunsrvStartMethod Default value 'start;${installer.prunsrvDaemonLauncherClass}' will be substituted in getter
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStartParams

prunsrvStartupMode:

Name of the launcher JAR file
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStartupMode
  • Default: auto

prunsrvStdError:

Std out file, relative to APP_ROOT
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStdError
  • Default: logs\std_err.txt

prunsrvStdOutput:

Std out file, relative to APP_ROOT
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStdOutput
  • Default: logs\std_out.txt

prunsrvStopClass:

Stop class that will be used with prunsrv Default value '${installer.prunsrvDaemonLauncherClass}' will be substituted in getter
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStopClass
  • Default: com.alexkasko.installer.StandardLauncher

prunsrvStopParams:

Input params for prunsrvStopParams Default value 'stop;${installer.prunsrvDaemonLauncherClass}' will be substituted in getter
  • Type: java.lang.String
  • Required: No
  • User Property: installer.prunsrvStopParams

prunsrvStopTimeout:

Prunsrv service stop timeout in seconds
  • Type: int
  • Required: No
  • User Property: installer.prunsrvStopTimeout
  • Default: 0

uninstallLauncher32Path:

Resource path to x86 uninstaller launcher
  • Type: java.lang.String
  • Required: No
  • User Property: installer.uninstallLauncher32Path
  • Default: classpath:/launchers/x86/uninstall.exe

uninstallLauncher64Path:

Resource path to x64 uninstaller launcher
  • Type: java.lang.String
  • Required: No
  • User Property: installer.uninstallLauncher32Path
  • Default: classpath:/launchers/x64/uninstall.exe

use64BitJre:

Whether JRE is 64 bit
  • Type: boolean
  • Required: No
  • User Property: installer.use64BitJre
  • Default: false

useX86LaunchersForX64Installer:

Use x86 launcher binaries for x64 installers instead of default x64 ones
  • Type: boolean
  • Required: No
  • User Property: installer.useX86LaunchersForX64Installer
  • Default: false