Wenn Sie in das Verzeichnis %WRAPPER_HOME%\src\bin der Wrapper-Distribution sehen, werden Sie eine Anzahl von Batch-Vorlagendateien sehen, die jede für sich für einen spezifischen Task genutzt werden. (Es gibt andere Dateien in dem Verzeichnis, die an anderer Stelle auf dieser Seite beschrieben werden.)

• App.bat.in:

  Wird genutzt, um die Anwendung als eine konsolenbasierte Anwendung auf den aktuellen Desktop des Users auszuführen. Dies kann auch nützlich sein, um eine Konfiguration zu testen, bevor diese als ein Windows Dienst ausgeführt wird.

• SetupApp.bat.in:

  ? Please check the English version for a more recent version of this text.

  Wird genutzt, um die Anwendung einzurichten. Diese Option wurde der Wrapper-Version 3.5.28 hinzugefügt, um Komponenten zu installieren, die administrative Benutzerberechtigungen auf den neuesten Windows-Versionen benötigen. Ab Version 3.5.28 wird der Wrapper einfach die Anwendung im Windows Ereignislogsystem registrieren.

• TeardownApp.bat.in:

  ? Please check the English version for a more recent version of this text.

  Wird genutzt, um eine Anwendung "abzumelden". Diese Option wurde der Wrapper Version 3.5.28 hinzugefügt, um Änderungen, die mit der SetupApp.bat gemacht wurden, rückgängig zu machen. Ab der Version 3.5.28 wird der Wrapper die Anwendung vom Windows Ereignislogsystem löschen.

• StartApp-NT.bat.in:

  Wird genutzt, um einen installierten Windows Dienst zu starten.

• PauseApp-NT.bat.in:

  Wird genutzt, um einen laufenden Windows Dienst anzuhalten. Sehen Sie die wrapper.pausable-Eigenschaften für mehr Details.

• ResumeApp-NT.bat.in:

  Wird genutzt, um einen zuvor angehaltenen Dienst fortzusetzen. Sehen Sie bitte die wrapper.pausable-Eigenschaft für mehr Information dazu.

• StopApp-NT.bat.in:

  Wird genutzt, um einen laufenden Windows Dienst zu beenden.

  Dies wird nur einen Dienst beenden. Wenn die Anwendung in einer Konsole läuft, dann werden Sie einen Fehler erhalten, dass der Dienst nicht läuft. Bitte sehen Sie auf der Seite bezüglich, wie Sie eine Konsolenanwendung beenden können.

• InstallApp-NT.bat.in:

  Wird genutzt, um die Anwendung als einen Windows Dienst zu installieren.

• UninstallApp-NT.bat.in :

  Wird genutzt, um die Anwendung als einen Windows Dienst zu deinstallieren (entfernen). Wenn der Dienst aktuell gestartet ist, dann wird dieser beendet.

• QueryApp-NT.bat.in:

  Wird benutzt, den Status eines Windows Dienstes abzufragen. Dies informiert Sie darüber, ob der Dienst installiert ist oder ob er ausgeführt, beendet, angehalten etc. ist.

Beim Einrichten des Wrappers mit einer spezifischen Anwendung können Sie wählen, welcher der oben genannten Batch-Dateien für die Anwendung am sinnvollsten ist. Z.B., wenn eine Anwendung die Funktion, angehalten zu werden, nicht unterstützt, werden die Dateien PauseApp-NT.bat.in und ResumeApp-NT.bat.in nicht benötigt.

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

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 -----------------------------------------------------------------------------

Wenn Sie in den Ordner der Wrapper-Distribution %WRAPPER_HOME%\src\bin sehen, sehen Sie eine Vorlagen-Befehlsbatchdatei, AppCommand.bat.in.

Kopieren Sie einfach diese Datei in den bin-Ordner Ihrer Anwendung. Wenn Sie dies so tun, nennen Sie bitte die Datei um, ersetzen SieApp mit dem Namen Ihrer Anwendung und entfernen Sie das .in am Ende.

MyServerCommand.bat.in             -> MyServerCommand.bat
MyServer.bat.in   -> MyServer.bat

Der Start aller Dateien enthält einen Abschnitt, welcher angepasst werden kann, um den Dateibenennungs- und Verzeichnisstrukturen Ihrer Anwendung zu entsprechen.

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 :

  Steuert, wo sich die Wrapper-Programmdatei relativ zum Speicherort der Batch-Datei befindet. In den meisten Fällen wird empfohlen, diese in den gleichen Speicherort zu speichern. Wenn Sie bestimmen, diese in einen anderen Speicherort zu verschieben, seien Sie sich bitte bewusst, dass standardmäßig alle relativen Pfadangaben in der Wrapper-Konfigurationsdatei relativ zum Speicherort der Wrapper-Programmdatei und nicht zur Batch-Datei sein werden.

  Es ist auch möglich, die Wrapper-Programmdatei auf etwas Anderes als myapp.exe umzubenennen, so dass dies anstatt wrapper.exe im Task-Manager angezeigt wird.

• _WRAPPER_CONF :

  Steuert den Speicherort und den Namen der Wrapper-Konfigurationsdatei. Dieser relative Pfad ist stets relativ zum Speicherort der Wrapper-Programmdatei, nicht zum Speicherort der Batch-Datei.

• _FIXED_COMMAND (Seit Ver. 3.5.5) :

  Informiert das Skript darüber, einen hart-codierten Befehl zu nutzen statt zu erwarten, dass der erste Parameter der Befehlszeile ein Befehl sein muß. Standardmäßig erwartet das Skript, dass der erste Parameter ein Befehl ist. Dies wird oft genutzt, wenn mehrere Dateien erstellt werden, was ähnlich wie die oben genannten dedizierten Batch-Dateien funktioniert.

• _PASS_THROUGH (Seit Ver. 3.5.5):

  Steuert welche Parameter, die der Batch-Datei übergeben wurden, zu der Java-Anwendung weitergegeben werden. Für mehr Informationen besuchen Sie bitte die Seite "How can I pass command line parameters to my Java Application?". Diese Variable existiert nur in App.bat.in und InstallApp-NT.bat.in.

Die befehlsbasierte Batch-Datei ist selbstdokumentierend, wenn der User versucht, diese ohne Parameter auszuführen und das Skript zeigt die Nutzung an.

Usage: TestWrapperCommand [ console {JavaAppArgs} : start : stop : restart : pause : resume : status : permissions : privileges : install {JavaAppArgs} : installstart {JavaAppArgs} : update {JavaAppArgs} : remove : setup : teardown ]

Commands:
  console      Launch in the current console.
  start        Start the Service.
  stop         Stop the Service.
  restart      Stop the Service if running and then start.
  pause        Pause the Service if running.
  resume       Resume the Service if paused.
  status       Query the current status of the Service.
  permissions  Query the current permissions of the Service.
  privileges   Query the current privileges of the Service.
  install      Install the Service.
  installstart Install the Service and then start running it.
  update       Update an installed Service.
  remove       Uninstall the Service.
  setup        Setup the Wrapper (for registration to the Windows Event Log).
  teardown     Teardown the Wrapper (unregister from the Windows Event Log).

JavaAppArgs:
  Optional arguments which will be passed to the Java application.

Usage: TestWrapperCommand [ console : start : stop : restart : pause : resume : status : permissions : privileges : install : installstart : update : remove : setup : teardown ]

...

Es gibt ein paar Unterschiede zwischen dieser Batch-Datei für Windows und dem UNIX-Skript. Das UNIX-Skript kann genutzt werden, um den in einer Konsole ausgeführten Wrapper zu beenden; jedoch ist es nicht möglich, dies mit der Batch-Datei für Windows zu tun. Zusätzlich fehlt der dump-Befehl in der Batch-Datei unter Windows.

Wie Sie sehen können, bietet die befehlsbasierte Batch-Datei eine breite Reihe von Fähigkeiten an:

• console:

  Genutzt, um mit run die Anwendung als eine normale konsolenbasierte Anwendung auf dem aktuellen User Desktop auszuführen. Dies kann auch nützlich sein, um eine Konfiguration zu testen, bevor sie als ein Dienst gestartet wird.

  Wenn _PASS_THROUGH aktiviert wurde, dann werden zusätzliche Parameter direkt an die JVM durchgegeben, wenn diese gestartet wird.

• start:

  Genutzt, um einen installierten Windows-Dienst zu starten.

• stop:

  Genutzt, um einen laufenden Windows Dienst zu beenden.

  Dies beendet nur einen Dienst. Wenn die Anwendung in einer Konsole läuft, dann erhalten Sie einen Fehler, dass der Dienst nicht läuft. Besuchen Sie bitte die Seite how to stop a console application.

• restart:

  Genutzt, um einen installierten Windows-Dienst neuzustarten. Dies funktioniert durch Beenden und dann Starten des Dienstes.

• pause:

  Wird genutzt, um einen zuvor angehaltenen Dienst anzuhalten. Sehen Sie bitte die wrapper.pausable-Eigenschaft für mehr Information dazu.

• resume:

  Genutzt, um einen zuvor angehaltenen Dienst fortzusetzen. Sehen Sie bitte die wrapper.pausable-Eigenschaft für mehr Information dazu.

• status:

  Frägt den Status des Dienstes ab.

  Ausgabe, wenn der Dienst nicht installiert wurde:

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

  Ausgabe, wenn der Dienst installiert, aber beendet wurde :

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

  Ausgabe, wenn der Dienst läuft:

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

• ? Please check the English version for a more recent version of this text.

  permissions (Professional Edition):

• ? Please check the English version for a more recent version of this text.

  privileges (Professional Edition):

• install:

  Wird genutzt, um die Anwendung als einen Windows Dienst zu installieren.

  Wenn _PASS_THROUGH aktiviert wurde, dann werden alle zusätzlichen Parameter direkt zur JVM hindurchgegeben, wenn sie tatsächlich gestartet oder neu gestartet wurde.

• installstart:

  Wird genutzt, um die Anwendung als einen Windows Dienst zu installieren und anschließend zu starten.

  Wenn _PASS_THROUGH aktiviert wurde, dann werden alle zusätzlichen Parameter direkt zur JVM hindurchgegeben, wenn sie tatsächlich gestartet oder neu gestartet wurde.

• update:

  Genutzt, um die Anwendung als ein Windows Dienst zu aktualisieren (neu zu installieren). Dies ist nützlich, wenn einige dienstbezogene Konfigurationswerte geändert wurden. Es unterscheidet sich vom Entfernen und Installieren des Dienstes in der Art, dass Dinge, wie Kontopasswörter nicht neu eingegeben werden müssen.

  Wenn _PASS_THROUGH aktiviert wurde, dann werden alle zusätzlichen Parameter direkt zur JVM hindurchgegeben, dann wenn sie tatsächlich gestartet oder neu gestartet werden.

• remove:

  Genutzt, um die Anwendung als einen Windows Dienst zu deinstallieren (entfernen). Wenn der Dienst aktuell gestartet ist, wird er beendet werden.

• setup:

  ? Please check the English version for a more recent version of this text.

  Genutzt, um die Anwendung einzurichten. Diese Option wurde in der Wrapper Version 3.5.28 hinzugefügt, um Komponenten auf neueren Windows-Versionen zu installieren, die administrative Berechtigungen benötigen. Ab der Version 3.5.28 wird der Wrapper einfach die Anwendung im Windows Eventlog-System registrieren.

• teardown:

  ? Please check the English version for a more recent version of this text.

  Genutzt, um eine Anwendung "abzumelden". Diese Option wurde der Wrapper Version 3.5.28 hinzugefügt, um Änderungen, die mit der '--setup'-Option gemacht wurden, rückgängig zu machen. Ab der Version 3.5.28 wird der Wrapper die Anwendung vom Windows-Ereignislogsystem löschen.

Als ein Beispiel kann der Wrapper in einer Konsole durch Nutzung des folgenden Befehls gestartet werden:

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  |     https://wrapper.tanukisoftware.com
wrapper  |   Licensed to {licensee}
wrapper  |
wrapper  | Launching a JVM...
jvm 1    | WrapperManager: Initializing...

Um andere Befehle auszuführen, ersetzen Sie bitte einfach den "console"- Befehl mit dem Befehl, welchen Sie auszuführen wünschen.

Wenn die wrapper-Programmdatei ohne irgendwelche Parameter oder mit einem "-?" gestartet wird, wird die folgende Nutzungsausgabe angezeigt werden.

Java Service Wrapper Professional Edition 64-bit {version}
  Copyright (C) 1999-{year} Tanuki Software, Ltd. All Rights Reserved.
    https://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
  -su --setup   SetUp the wrapper
  -td --teardown TearDown the wrapper
  -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.]

Um den Wrapper als eine Konsolenanwendung auszuführen, würden Sie den -c-Befehl spezifizieren, gefolgt von der wrapper.conf-Datei. Der Speicherort der wrapper.conf-Datei kann ein absoluter oder relativer Speicherpfad sein. Wenn ein relativer Pfad genutzt wird, ist der Pfad stets relativ zum Speicherort der wrapper.exe-Datei, nicht zum aktuellen Verzeichnis.

wrapper.exe -c ..\conf\wrapper.conf

Um die Anwendung als einen Windows Dienst zu installieren, führen Sie Folgendes aus:

wrapper.exe -i ..\conf\wrapper.conf

Sobald installiert, kann der Dienst wie jeder anderen Windows Dienst gestartet werden. Wenn wrapper.ntservice.starttype auf AUTO_START eingestellt wurde, sobald installiert, wird dann der Dienst das nächste Mal, wenn die Maschine neu gestartet wird, gestartet werden. Es ist auch möglich, den Dienst von Systemsteuerung aus zu starten ([Systemsteuerung] - [System und Sicherheit] - [Administrative Tools] - [Dienste]) unter Windows durch Auswahl des Dienstes und dann Auswählen des Dienstes und dann Klicken der "Dienst starten "-Schaltfläche oder via einer der folgenden Befehle:

wrapper.exe -t ..\conf\wrapper.conf

net start MyApp

Der Dienst kann durch Nutzung des Dienste-Tools von der Systemsteuerung ([Systemsteuerung] - [System und Sicherheit] - [Administrative Tools] - [Dienste]) und gefolgt vom Klicken auf die "Dienst starten"-Schaltfläche oder durch einer der folgenden Befehle beendet werden.

wrapper.exe -p ..\conf\wrapper.conf

net stop MyApp

Wenn Sie die Anwendung als ein Windows Dienst installieren möchten, führen Sie bitte den folgenden Befehl aus:

wrapper.exe -r ..\conf\wrapper.conf

Wenn der Dienst zu dem Zeitpunkt, wenn er deinstalliert wird, läuft, wird der Dienst korrekt beendet und dann entfernt.

Der Wrapper kann genutzt werden, um den Dienststatus manuell oder von innerhalb einer Batch-Datei abzufragen. Die kann nützlich für die Installation von Skripts sein, welche den aktuellen Status der Dienstkonfiguration kennen müssen.

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

Wenn mit dem "-q"-Befehl ausgeführt, wird der Wrapper den aktuellen Status auf der Konsole anzeigen, "-qs" Befehl läuft im Hintergrund ab. Der Wrapper wird dann einen Exit-Code ausgeben, welcher eine Kombination von den folgenden Bits ist:

• 1: Dienst ist installiert.

• 2: Dienst läuft.

• 4: Dienst ist interaktiv.

• 8: Starttyp ist automatisch.

• 16: Starttyp ist manuell.

• 32: Starttyp ist deaktiviert.

• 32768 (2^15): Angetroffener Fehler bei der Statusabfrage.

Ein Exit-Code von "15" (=1+2+4+8) z.B. zeigt an, dass der Dienst installiert ist, läuft, interaktiv und konfiguriert ist, automatisch zu starten, wenn das System gestartet wird. Ein Exit-Code von "0" (Null) bedeutet, dass der Dienst aktuell nicht installiert ist.