4

I have been working on a project where I need to install a Java service running as a spring boot application from a Wix installer for Windows. It should autodetect if there is already a JRE instance installed globally on the system, and if so, use it, otherwise, install a private JRE for this application. After looking for complete solutions, and working through many different problems, I have come up with a configuration that works. It manually installs the service via Wix and sets all the registry keys that the procrun program needs instead of using procrun to install the service.

I am new to the site (as a submitter), but I will post the Wix XML that I created as an answer. It isn't perfectly polished, but hopefully will help others get through the hurdles that I had to jump through to make this work.

Erik Brandsberg
  • 191
  • 7

1 Answers1

6

Here is a (summarized) Wix xml, with the important pieces in place. I had to summarize due to response size limit. Thanks for many Stack overflow answers to help get to this point.

<?xml version="1.0" encoding="utf-8"?>
<!--
# This comment is generated by WixEdit, the specific commandline
# arguments for the WiX Toolset are stored here.

candleArgs: 
lightArgs: "heimdalldemo.wixobj" -out "heimdalldemo.msi" -ext WixUtilExtension -ext WixUIExtension
-->
<!-- installation script for the Heimdall Data Access Platform, www.heimdalldata.com -->
<Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
<Product Id="*" Name="Heimdall Data Access Platform" Language="1033" Version="0.9.0.1" Manufacturer="Heimdall Data" UpgradeCode="98CE97B6-8E91-42F5-8C32-8F0F078433EC">
    <Package Description="Heimdall Data Server and Driver Installer" Comments="Heimdall Installer" InstallPrivileges="elevated" InstallScope="perMachine" InstallerVersion="200" Compressed="yes" Platform="x64" />
    <Media Id="1" Cabinet="simple.cab" EmbedCab="yes" />
    <?define ProductName = "Heimdall Data Access Platform" ?>
    <?define PlatformProgramFilesFolder = "ProgramFiles64Folder" ?>
    <!-- Check some requirements ONLY on "install", but not on modify or uninstall. -->
    <Property Id="JAVA_CURRENT_VERSION64">
        <RegistrySearch Id="JRE_CURRENT_VERSION_REGSEARCH64" Root="HKLM" Key="SOFTWARE\JavaSoft\Java Runtime Environment" Name="CurrentVersion" Type="raw" Win64="yes" />
    </Property>
    <Directory Id="TARGETDIR" Name="SourceDir">
        <Directory Id="$(var.PlatformProgramFilesFolder)">
            <Directory Id="DRIVERDIR" Name="Heimdall">
                <!-- driver components -->
            </Directory>
            <Directory Id="TRAFFICDIR" Name="Heimdall">
       <!-- traffic generator components -->
            </Directory>
            <Directory Id="SERVERDIR" Name="Heimdall">
                <Component Id="REGISTRY_A" DiskId="1" Guid="*">
                    <RegistryKey Root="HKLM" Key="SOFTWARE\Apache Software Foundation\Procrun 2.0\Heimdall\Parameters\Java" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="Classpath" Value="[SERVERDIR]heimdallserver.jar" KeyPath="yes" />
                        <RegistryValue Type="string" Name="Jvm"     Value="auto" />
                        <RegistryValue Type="multiString" Action="append" Name="Options">
                           <MultiStringValue Type="multiString" Name="Options" Action="append">-Duser.dir=[SERVERDIR]</MultiStringValue>
                           <MultiStringValue Type="multiString" Name="Options" Action="append">-XX:+UseConcMarkSweepGC</MultiStringValue>
                           <MultiStringValue Type="multiString" Name="Options" Action="append">-XX:+CMSIncrementalPacing</MultiStringValue>
                           <MultiStringValue Type="multiString" Name="Options" Action="append">-XX:ParallelGCThreads=2</MultiStringValue>
                           <MultiStringValue Type="multiString" Name="Options" Action="append">-XX:+AggressiveOpts</MultiStringValue>
                        </RegistryValue>
                        <RegistryValue Type="integer" Name="JvmMs" Value="128" />
                        <RegistryValue Type="integer" Name="JvmMx" Value="512" />
                        <RegistryValue Type="integer" Name="JvmSs" Value="4000" />
                    </RegistryKey>
                    <RegistryKey Root="HKLM" Key="SOFTWARE\Apache Software Foundation\Procrun 2.0\Heimdall\Parameters\Log" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="Path" Value="[SERVERDIR]log" />
                        <RegistryValue Type="string" Name="Level" Value="Error" />
                        <RegistryValue Type="string" Name="Prefix" Value="procrun.log" />
                        <RegistryValue Type="string" Name="StdError" Value="auto" />
                        <RegistryValue Type="string" Name="StdOutput" Value="auto" />
                    </RegistryKey>
                    <RegistryKey Root="HKLM" Key="SOFTWARE\Apache Software Foundation\Procrun 2.0\Heimdall\Parameters\Start" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="Mode" Value="jvm" />
                        <RegistryValue Type="string" Name="Class" Value="com.heimdalldata.server.Bootstrap" />
            <RegistryValue Type="string" Name="WorkingPath" Value="[SERVERDIR]" />
                        <RegistryValue Type="string" Name="Method" Value="start" />
                        <RegistryValue Type="string" Name="Params" Value="start" />
                        <RegistryValue Type="string" Name="StdOutput" Value="auto" />
                    </RegistryKey>
                    <RegistryKey Root="HKLM" Key="SOFTWARE\Apache Software Foundation\Procrun 2.0\Heimdall\Parameters\Stop" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="Mode" Value="jvm" />
                        <RegistryValue Type="string" Name="Class" Value="com.heimdalldata.server.Bootstrap" />
                        <RegistryValue Type="string" Name="Method" Value="stop" />
                        <RegistryValue Type="string" Name="Params" Value="stop" />
                        <RegistryValue Type="string" Name="StdOutput" Value="auto" />
                    </RegistryKey>
                    <RegistryKey Root="HKLM" Key="SYSTEM\CurrentControlSet\Services\Heimdall" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="Description" Value="Heimdall Management and Logging Server" />
                        <RegistryValue Type="string" Name="DisplayName" Value="Heimdall" />
                        <RegistryValue Type="string" Name="ImagePath" Value="[SERVERDIR]heimdallserver.exe //RS//Heimdall" />
                        <RegistryValue Type="string" Name="DependsOnService" Value="Tcpip Afd" />
                        <RegistryValue Type="string" Name="ObjectName" Value="LocalSystem" />
                        <RegistryValue Type="integer" Name="ErrorControl" Value="1" />
                        <RegistryValue Type="integer" Name="Start" Value="2" />
                        <RegistryValue Type="integer" Name="Type" Value="16" />
                    </RegistryKey>
                    <RegistryKey Root="HKLM" Key="SYSTEM\CurrentControlSet\Services\Heimdall\Parameters" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="Test" Value="Pass" />
                    </RegistryKey>
                </Component>
                <Component Id="REGISTRY_B" DiskId="1" Guid="*">
                    <RegistryKey Root="HKLM" Key="SOFTWARE\Apache Software Foundation\Procrun 2.0\Heimdall\Parameters\Java" Action="createAndRemoveOnUninstall">
                        <RegistryValue Type="string" Name="JavaHome" Value="[SERVERDIR]jre6" />
            <RegistryValue Type="string" Name="Jvm"     Value="[SERVERDIR]jre6\bin\server\jvm.dll" />
                    </RegistryKey>
                </Component>

                <Component Id="HEIMDALLSERVER64.EXE" DiskId="1" Guid="*"> <!-- this is the renamed procrun 64 bit executable -->
                    <File Id="HEIMDALLSERVER64.exe" Name="heimdallserver.exe" Source="c:\heimdall\heimdallserver64.exe" />
                    <ServiceInstall Id="HEIMDALLSERVER64" Type="ownProcess" Name="Heimdall" DisplayName="Heimdall" Description="Heimdall Management and Logging Server" Start="auto" Account="[SERVICEACCOUNT]" Password="[SERVICEPASSWORD]" ErrorControl="normal" Arguments=" //RS//Heimdall" />
                    <ServiceControl Id="StartService64" Start="install" Stop="both" Remove="uninstall" Name="Heimdall" Wait="no" />
                </Component>
            </Directory>
        </Directory>
    </Directory>
    <Feature Id="Server" Title="Heimdall Server" Level="1" ConfigurableDirectory="SERVERDIR">
        <ComponentRef Id="REGISTRY_A" />
        <!-- all server components -->
        <Feature Id="Configuration" Title="Example Configuration" Level="1" ConfigurableDirectory="CONFIG">
            <!-- all configuration components -->
        </Feature>
        <Feature Id="Drivers" Title="Driver Library" Level="1" ConfigurableDirectory="CONFIG">
       <!-- all driver feature components -->
        </Feature>
    </Feature>
    <Feature Id="Driver" Title="Heimdall Driver" Level="1" ConfigurableDirectory="DRIVERDIR">
        <!-- driver component -->
        <Feature Id="Libraries" Title="Grid API Libraries" Level="6" ConfigurableDirectory="LIBDIR">
            <!-- all library components -->
        </Feature>
    </Feature>

    <Feature Id="JRE" Title="Private JRE" Level="1" ConfigurableDirectory="SERVERDIR">
        <Condition Level="6">JAVA_CURRENT_VERSION64 &gt;= "1.6"</Condition>
    <ComponentRef Id="REGISTRY_B" />
    <!-- all JRE file components -->
    </Feature>
    <UI />
    <UIRef Id="WixUI_Mondo" />
    <!-- custom dialog (welcome and completion dialogs)  493x312 -->
    <WixVariable Id="WixUIDialogBmp" Value="C:\heimdall\banner.bmp" />
    <!-- custom logo (top bar)  493x58 -->
    <WixVariable Id="WixUIBannerBmp" Value="C:\heimdall\logo.bmp" />
    <!-- custom license agreement -->
    <!-- <WixVariable Id="WixUILicenseRtf" Value="c:\heimdall\license.rtf" /> -->
    <!-- call localhost:8087 on exit of installer when installing -->
    <Property Id="MyURL"><![CDATA[http://localhost:8087/]]></Property>
    <CustomAction Id="SetOpenURL" Property="WixShellExecTarget" Value="[MyURL]" />
    <CustomAction Id="OpenURL" BinaryKey="WixCA" DllEntry="WixShellExec" Impersonate="yes" Return="ignore" />
    <InstallExecuteSequence>
        <!-- Launch webpage during full uninstall, but not upgrade -->
        <Custom Action="SetOpenURL" After="InstallFinalize"><![CDATA[&Server=3 AND UILevel > 2 AND NOT Installed]]></Custom>
        <Custom Action="OpenURL" After="SetOpenURL"><![CDATA[&Server=3 AND UILevel > 2 AND NOT Installed]]></Custom>
    </InstallExecuteSequence>
</Product>
</Wix>
Erik Brandsberg
  • 191
  • 7
  • mate did you succeed in installing this? – AnOldSoul Apr 12 '16 at 08:51
  • Yes, it works, and we are using the config for our product installer. – Erik Brandsberg Apr 13 '16 at 15:41
  • Mate I also need to install a procrun service and I follwed your example. But I am getting this issue,http://stackoverflow.com/questions/36651392/wix-installer-registry-keys-not-getting-created-in-wow64-node Any ideas would be of great help :( – AnOldSoul Apr 15 '16 at 15:38
  • I had to put the Win64 to no in my code in that question. Still it doesn't install the service. Registry entries are there though :( I cannot see the service in local services list – AnOldSoul Apr 16 '16 at 15:17
  • 2
    As I can't post the full complete wxs config file, as it is too large, I have made it available for download at http://download.heimdalldata.com/downloads/heimdalldemo.wxs. The resulting install file for our product (30 day demo) is available at http://download.heimdalldata.com/downloads/heimdalldemo.msi so you can see how the install actually works, and verify the result works on your system. We assume that a customer will be on a 64 bit OS, as the functionality isn't likely to be that useful except on server systems, so that may be one issue. edit: typo – Erik Brandsberg Apr 16 '16 at 19:26
  • Thanks a lot mate! I had to change the system account to "LocalSystem" and run it as administrator. Now it works. – AnOldSoul Apr 17 '16 at 13:03
  • Can someone please post the wxs in a Github gist? The posted link [download.heimdalldata.com/downloads/heimdalldemo.wxs](http://download.heimdalldata.com/downloads/heimdalldemo.wxs) is no longer accessible – Vrushank Jan 09 '20 at 07:58