When you look in the Wrapper distribution's %WRAPPER_HOME%\src\bin directory, you will see a number of template batch files which each are used for a specific task. (There are other files in the directory which are described elsewhere in this page.)

• App.bat.in :

  Used to run the application as a regular console based application in the current user desktop. This can also be useful to test a configuration before running as a service.

• InstallApp-NT.bat.in :

  Used to install the application as a Windows Service.

• PauseApp-NT.bat.in :

  Used to pause a running Windows Service. See the wrapper.pausable property for more information.

• QueryApp-NT.bat.in :

  Used to query the status of a Windows Service. This will tell you whether the service is installed or not, whether it is running, stopped, paused, etc.

• ResumeApp-NT.bat.in :

  Used to resume a previously paused Windows Service. See the wrapper.pausable property for more information.

• StartApp-NT.bat.in :

  Used to start an installed Windows Service.

• StopApp-NT.bat.in :

  Used to stop a running Windows Service.

  This will only stop a service. If the application is running in a console then you will get an error that the service was not running. Please see the page on how to stop a console application.

• UninstallApp-NT.bat.in :

  Used to uninstall (remove) the application as a Windows Service. If the service is currently started, it will be stopped.

When setting up the Wrapper to run with a particular application, you can pick and choose which of the above batch files make sense for the application. For example, if an application does not support being paused then the PauseApp-NT.bat.in and ResumeApp-NT.bat.in files are not required.

For each required file, simply copy it over to the bin directory of your application. When you do so, rename the file by replacing App with the name of your application, and remove the .in from the end.

App.bat.in             -> MyApp.bat
InstallApp-NT.bat.in   -> InstallMyApp-NT.bat
StartApp-NT.bat.in     -> StartMyApp-NT.bat
StopApp-NT.bat.in      -> StopMyApp-NT.bat
UninstallApp-NT.bat.in -> UninstallMyApp-NT.bat

The beginning of all of the files contain a section which can be customized to fit the file naming and directory structure of your application.

rem -----------------------------------------------------------------------------
rem These settings can be modified to fit the needs of your application
rem Optimized for use with version @wrapper.version@ of the Wrapper.

rem The base name for the Wrapper binary.
set _WRAPPER_BASE=wrapper

rem The name and location of the Wrapper configuration file.   This will be used
rem  if the user does not specify a configuration file as the first parameter to
rem  this script.  It will not be possible to specify a configuration file on the
rem  command line if _PASS_THROUGH is set.
set _WRAPPER_CONF_DEFAULT=../conf/wrapper.conf

rem _PASS_THROUGH tells the script to pass all parameters through to the JVM as
rem  is.
rem set _PASS_THROUGH=true

rem Do not modify anything beyond this point
rem -----------------------------------------------------------------------------

• _WRAPPER_BASE :

  Controls where the Wrapper binary is relative to the location of the batch file. In most cases it is recommended that it be in the same location. If you choose to move it to another location, please be aware that by default all relative paths in the Wrapper configuration file will be relative to the location of the Wrapper binary, and not of the batch file. It is also possible to rename the Wrapper binary to something else like myapp.exe so that shows up in the task manager rather than the wrapper.exe.

• _WRAPPER_CONF_DEFAULT :

  Controls the location and name of the default Wrapper configuration file. This relative path is always relative to the location of the Wrapper binary, not the location of the batch file.

• _PASS_THROUGH (Since ver. 3.5.5) :

  Controls whether or not parameters passed to the batch file will be passed as is on to the Java application. Please see the "How can I pass command line parameters to my Java Application?" page for more information. This variable only exists in App.bat.in and InstallApp-NT.bat.in.

  The first parameter to the batch file will always be the name of an alternate configuration file. If _PASS_THROUGH is set then any additional parameters will be passed through to the JVM.

  NOTE

  Up through version 3.5.14, the first parameter was always an alternate configuration file. Future versions make it possible to control, but with older versions of the script, the ability to change the configuration file can be disabled by simply removing the following 5 lines from each of the scripts. This will be will let all parameters be passed through to the JVM.

  HelloWorldServer.java (Change)

  set _WRAPPER_CONF="%~f1" if not [%_WRAPPER_CONF%]==[""] ( shift goto :startup )

Before proceeding, please make sure you have configured all of the Windows Service related properties in the wrapper.conf file. You should also have verified that the application runs correctly in console mode.

C:\MyApp\bin>InstallMyApp-NT.bat
wrapper  | My Application service installed.

C:\MyApp\bin>StartMyApp-NT.bat
wrapper  | Starting the My Application service...
wrapper  | My Application started.

C:\MyApp\bin>StopMyApp-NT.bat
wrapper  | Stopping the My Application service...
wrapper  | My Application stopped.

C:\MyApp\bin>net start MyApp
The My Application service is starting....
The My Application service was started successfully.

C:\MyApp\bin>net stop MyApp
The My Application service is stopping..
The My Application service was stopped successfully.

C:\MyApp\bin>UninstallMyApp-NT.bat
wrapper  | Service is running.  Stopping it...
wrapper  | Waiting to stop...
wrapper  | My Application stopped.
wrapper  | My Application service removed.

When you look in the Wrapper distribution's %WRAPPER_HOME%\src\bin directory, you will see a template command batch file, AppCommand.bat.in. Simply copy this file over to the bin directory of your application. When you do so, rename the file by replacing App with the name of your application, and remove the .in from the end. For example: MyServerCommand.bat or MyServer.bat

The beginning of all of the files contain a section which can be customized to fit the file naming and directory structure of your application.

rem -----------------------------------------------------------------------------
rem These settings can be modified to fit the needs of your application
rem Optimized for use with version @wrapper.version@ of the Wrapper.

rem The base name for the Wrapper binary.
set _WRAPPER_BASE=wrapper

rem The name and location of the Wrapper configuration file.
rem  (Do not remove quotes.)
set _WRAPPER_CONF="../conf/wrapper.conf"

rem _FIXED_COMMAND tells the script to use a hard coded command rather than
rem  expecting the first parameter of the command line to be the command.
rem  By default the command will will be expected to be the first parameter.
rem set _FIXED_COMMAND=console

rem _PASS_THROUGH tells the script to pass all parameters through to the JVM
rem  as is.  If _FIXED_COMMAND is specified then all parameters will be passed.
rem  If not set then all parameters starting with the second will be passed.
set _PASS_THROUGH=true

rem Do not modify anything beyond this point
rem -----------------------------------------------------------------------------

• _WRAPPER_BASE :

  Controls where the Wrapper binary is relative to the location of the batch file. In most cases it is recommended to place it in the same location. If you choose to move it to another location, please be aware that by default all relative paths in the Wrapper configuration file are relative to the location of the Wrapper binary, and not of the batch file. It is also possible to rename the Wrapper binary to something else like myapp.exe so that shows up in the task manager rather than the wrapper.exe.

• _WRAPPER_CONF :

  Controls the location and name of the Wrapper configuration file. This relative path is always relative to the location of the Wrapper binary, not the location of the batch file.

• _FIXED_COMMAND (Since ver. 3.5.5) :

  Tells the script to use a hard coded command rather than expecting the first parameter of the command line to be a command. By default, the script expects the first parameter to be a command. This is often used when creating multiple files that work similar to the dedicated batch files described above.

• _PASS_THROUGH (Since ver. 3.5.5) :

  Controls whether or not parameters passed to the batch file will be passed as is on to the Java application. Please see the "How can I pass command line parameters to my Java Application?" page for more information. This variable only exists in App.bat.in and InstallApp-NT.bat.in.

The command based batch file is self documenting in that if the user tries running it without any parameters, the script will display usage.

Usage:  [ console : start : pause : resume : stop : restart : install : update : remove : status ]
Press any key to continue . . .

Usage:  [ console {JavaAppArgs} : start : pause : resume : stop : restart : install {JavaAppArgs} : update {JavaAppArgs} : remove : status ]
Press any key to continue . . .

There are a few differences between this batch file for Windows and the UNIX script. The UNIX script can be used to stop the Wrapper running in a console; however, it is not possible to do so with the batch file for Windows. In addition, the dump command is missing from the batch file for Windows.

As you can see, the command based batch file provides a wide range of capability:

• console :

  Used to run the application as a regular console based application in the current user desktop. This can also be useful to test a configuration before running as a service.

  If _PASS_THROUGH has been enabled then any additional parameters will be passed directly through to the JVM when it is launched.

• start :

  Used to start an installed Windows Service.

• pause :

  Used to pause a running Windows Service. See the wrapper.pausable property for more information.

• resume :

  Used to resume a previously paused Windows Service. See the wrapper.pausable property for more information.

• stop :

  Used to stop a running Windows Service.

  This will only stop a service. If the application is running in a console then you will get an error that the service was not running. Please see the page on how to stop a console application.

• restart :

  Used to restart an installed Windows Service. This works by first stopping, and then starting the service.

• install :

  Used to install the application as a Windows Service.

  If _PASS_THROUGH has been enabled then any additional parameters will be passed directly through to the JVM when it is eventually started or restarted.

• update :

  Used to update (reinstall) the application as a Windows Service. This is useful when some service related configuration values have been changed. It differs from removing and then installing the service in that things like account passwords will not need to be reentered.

  If _PASS_THROUGH has been enabled then any additional parameters will be passed directly through to the JVM when it is eventually started or restarted.

• remove :

  Used to uninstall (remove) the application as a Windows Service. If the service is currently started, it will be stopped.

• status :

  Queries the status of the service.

  Output when service is not installed:

  wrapper | The {myapp} Service is not installed.]

  Output when service is installed but stopped:

  wrapper | The {myapp} Service is installed. wrapper | Start Type: Automatic wrapper | Interactive: No wrapper | Running: No]

  Output when service is running:

  wrapper | The {myapp} Service is installed. wrapper | Start Type: Automatic wrapper | Interactive: No wrapper | Running: Yes]

As an example, the Wrapper can be started in a console using the following command:

C:\MyApp\bin>MyApp.bat console
wrapper  | --> Wrapper Started as Console
wrapper  | Java Service Wrapper Professional Edition 64-bit {version}
wrapper  |   Copyright (C) 1999-{year} Tanuki Software, Ltd. All Rights Reserved.
wrapper  |     http://wrapper.tanukisoftware.com
wrapper  |   Licensed to {licensee}
wrapper  |
wrapper  | Launching a JVM...
jvm 1    | WrapperManager: Initializing...

To execute other commands, simply replace console with the command you wish to have executed.

From a command line, if you run without any parameters or with a "-?" you will see the Wrapper's usage.

Java Service Wrapper Professional Edition 64-bit {version}
  Copyright (C) 1999-{year} Tanuki Software, Ltd. All Rights Reserved.
    http://wrapper.tanukisoftware.com

Usage:
  bin\wrapper <command> <configuration file> [configuration properties] [...]
  bin\wrapper <configuration file> [configuration properties] [...]
     (<command> implicitly '-c')
  bin\wrapper <command>
     (<configuration file> implicitly 'wrapper.conf')
  bin\wrapper
     (<command> implicitly '-c' and <configuration file> 'wrapper.conf')
  bin\wrapper --customize [customize arguments]

where <command> can be one of:
  -c  --console run as a Console application
  -t  --start   starT an NT service
  -a  --pause   pAuse a started NT service
  -e  --resume  rEsume a paused NT service
  -p  --stop    stoP a running NT service
  -i  --install Install as an NT service
  -it --installstart Install and sTart as an NT service
  -u  --update Update an installed NT service
  -r  --remove  Uninstall/Remove as an NT service
  -l=<code> --controlcode=<code> send a user controL Code to a running NT service
  -d  --dump    request a thread Dump
  -q  --query   Query the current status of the service
  -qs --querysilent Silently Query the current status of the service
  -h  --hostid  prints a list of HostIds which can be used to license this host.
  -v  --version print the wrapper's version information.
  -?  --help    print this help message
  -- <args>     mark the end of Wrapper arguments.  All arguments after the
                '--' will be passed through unmodified to the java application.

<configuration file> is the wrapper.conf to use.  Name must be absolute or relative
  to the location of bin\wrapper

[configuration properties] are configuration name-value pairs which override values
  in wrapper.conf.  For example:
  wrapper.debug=true

  --customize  This command will allow you to customize your Wrapper executable.
    The following [customize arguments] are available:
      --target <target file> Specifies the name and location of the customized
          Wrapper executable.  This property is mandatory as it is not possible
          or safe to guess a default file name.
      --icon <icon file> Specifies the custom icon for your Wrapper executable.
      --passthrough If set, the new Wrapper executable will precede the
                    whole command line to the wrapped application.
      --conf <conf file> Specifies the default location of the conf file
      --manufacturer <Manufacturer> Sets the Manufacturer for the binary

  Please note that any file references must be absolute or relative to the location
  of the Wrapper executable.]

To run the Wrapper as a console application, you would specify the -c command, followed by the wrapper.conf file. The location of the wrapper.conf file can be an absolute or relative location. If a relative path is used, the path is always relative to the location of the wrapper.exe file, not the current directory.

C:\MyApp\bin>wrapper.exe -c ..\conf\wrapper.conf

To install the application as a Windows Service, execute:

C:\MyApp\bin>wrapper.exe -i ..\conf\wrapper.conf

Once installed, the service can be started just like any other Windows Service. If the wrapper.ntservice.starttype was set to AUTO_START when installed, then the service will be started the next time the machine is rebooted. It is also possible to start the service from the services control panel or with one of the following commands:

C:\MyApp\bin>wrapper.exe -t ..\conf\wrapper.conf
C:\MyApp\bin>net start MyApp

The service can be stopped using the services control panel, or by executing either of the following commands:

C:\MyApp\bin>wrapper.exe -p ..\conf\wrapper.conf
C:\MyApp\bin>net stop MyApp

C:\MyApp\bin>wrapper.exe -r ..\conf\wrapper.conf

If the service is running at the time that it is uninstalled, the service will be cleanly stopped and then removed.

The Wrapper can be used to query the state of the service manually or from within a batch file. This can be useful for install scripts which need to know the current state of the service configuration.

C:\MyApp\bin>wrapper.exe -q ..\conf\wrapper.conf
wrapper  | The My Application Service is installed.
wrapper  |   Start Type: Automatic
wrapper  |   Interactive: Yes
wrapper  |   Running: No

If run with the "-q" command, the Wrapper will display the current status to the console, "-qs" will run silently. The Wrapper will then exit an exit code that is a combination of the following bits:

• 1 : Service is installed.

• 2 : Service is running.

• 4 : Service is interactive.

• 8 : Start type is automatic.

• 16 : Start type is manual.

• 32 : Start type is disabled.

An exit code of "15", for example, indicates that the service is installed, running, interactive and configured to start automatically when the system is booted. An exit code of "0" (zero) means that the service is not currently installed.