Starten und Steuern Ihrer Anwendung (Windows)

Unter Windows ist es möglich, eine Java-Anwendung entweder als eine Desktop-Anwendung oder als einen Windows-Dienst im Hintergrund laufen zu lassen. Im Falle eines Dienstes muß der Wrapper imstande sein, installiert, entfernt, gestartet, angehalten oder seinen Status abgefragt bekommen zu werden. Abhängig davon, ob die Anwendung eine GUI besitzt oder beabsichtigt wird, diese in einem Befehlszeilenfenster auszuführen, entscheidet auch darüber, wie sie ausgeführt wird.

  • Festzugeordnete Batch-Dateien:

    Stellt eine Reihe von spezialisierten Batch-Dateien zur Verfügung, die einem User ermöglichen, diese doppelzuklicken, um individuelle Aktionen, wie z.B. als Dienst installieren, starten, etc. zu unternehmen.

  • Befehlsbasierte Batch-Datei:

    stellt eine einfache Batch-Datei zur Verfügung, die ein Befehl als ein Parameter übernimmt. Dies ist sehr ähnlich zu dem Skript, welches unter UNIX-Plattformen zur Verfügung gestellt wird, und für User nützlich ist, die bevorzugen, die Befehlszeile zu nutzen.

  • Direktes Starten der Programmdatei

    Es ist auch möglich, die Wrapper-Programmdatei direkt auszuführen. In den meisten Fällen wird dies von einer Befehlszeile aus getan, indem zusätzliche Parameter zur Verfügung gestellt werden. Es ist auch möglich eine Standardkonfigurationsdatei zu nutzen oder die Programmdatei so individuell kundenspezifisch anzupassen, um diese Anforderung zu umgehen.

Festzugeordnete Batch-Dateien

Auf Windows-Systemen ist der übliche Weg, den Wrapper zu starten, von festzugeordneten Batch-Dateien Gebrauch zu machen, die jede Aktion ausführen, um den Wrapper zu steuern. Dies ermöglicht es für den Enduser auf die Batch-Datei-Icons doppelzuklicken oder Links in den Menüs einzurichten.

Konfiguration der Batch-Dateien

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.

Batch-Dateien anpassen

NOTE

(Abhängig davon, wie Ihr Datei-Explorer auf Ihrem System konfiguriert ist, kann es sein, dass Sie Dateiendungen nicht sehen.)

Für jede benötigte Datei kopieren Sie diese bitte einfach in den bin-Ordner Ihrer Anwendung. Indem Sie dies tun, benennen Sie den Dateinamen um, indem Sie die Umbenennug der App mit dem Namen der Anwendung durchführen und am Ende .in entfernen.

Beispiel für den Ersatz von Dateinamen: 
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

Der Beginn aller Dateinamen enthält einen Abschnitt, der individuell an die Dateinamenbenennung und die Verzeichnisstruktur Ihrer Anwendung angepasst werden kann.

HelloWorldServer.java (Change) 
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 :

    Regelt, wo sich die Wrapper-Programmdatei relativ zum Speicherpfad der Batch-Datei befindet. In den meisten Fälllen wird es empfohlen, es im gleichen Speicherort zu speichern. Wenn Sie entscheiden, es an einem anderen Speicherort zu speichern, seien Sie sich bitte bewusst, dass standardmäßig alle relative Pfade der Wrapper-Konfigurationsdatei relativ zum Speicherort der Wrapper-Programmdatei, und nicht der Batch-Datei, sind.

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

  • _WRAPPER_CONF_DEFAULT :

    Regelt den Speicherort und den Namen der standardmäßigen Wrapper-Konfigurationsdatei. Dieser relative Pfad ist stets relativ zum Speicherort der Wrapper-Programmdatei, nicht zum Speicherort der Batch-Datei.

  • _PASS_THROUGH (Seit Ver. 3.5.5) :

    Steuert, ob Parameter, die an die Batch-Datei weitergegeben wurden, auch an die 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.

    Der erste Parameter für die Batch-Datei wird stets der Name einer Ersatzkonfigurationsdatei sein. Wenn _PASS_THROUGH festgelegt wurde, dann werden alle zusätzlichen Parameter an die JVM weitergegeben.

    NOTE

    Bis zur Wrapper Ver. 3.5.14 aufwärts war der erste Parameter stets eine Ersatzkonfigurationsdatei. Zukünftige Versionen ermöglichen es, zu steuern, ber mit älteren Skriptversionen. Die Fähigkeit, die Konfigurationsdatei zu ändern, kann deaktiviert werden, indem man man einfach die folgenden 5 Zeilen von jeder der Skripts entfernt. Dies sorgt dafür, dass alle Parameter an die JVM weitergegeben werden.

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

In einer Konsole ausführen

Starten der Anwendung

Das Ausführen der Anwendung in einer Konsole (Befehlszeilenfenster) kann getan werden, indem man innerhalb des Dateiexplorers auf die MyApp.bat-Batch-Datei klickt. Sie können es auch tun, indem Sie ein Befehlszeilenfenster öffnen und dann die Batch-Datei von der Befehlszeile aus ausführen. Aufgrund der Art, wie das Wrapper-Skript sein aktuelles Verzeichnis festlegt, ist es nicht notwendig, diese Batch-Datei von innerhalb des bin-Verzeichnisses auszuführen.

Ausgabebeispiel: 
MyApp.bat
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...

Beenden der Anwendung

Die Anwendung kann durch Drücken von STRG-C in der Konsole (Befehlsfenster) beendet werden. Dies sorgt dafür, dass der Wrapper die Anwendung korrekt beendet. Für weitere Optionen besuchen Sie bitte die Seite how to stop a console application.

Ausführen als ein Windows Dienst

NOTE

Bevor Sie fortfahren, stellen Sie bitte sicher, dass Sie alle Windows Dienst bezogenen Eigenschaften in der wrapper.conf-Datei konfiguriert haben. Sie sollten auch sicherstellen, dass die Anwendung korrekt im Konsolen-Modusausgeführt wird.

Installation als ein Windows Dienst

Die Anwendung kann durch Doppelklick auf die InstallMyApp-NT.bat-Batchdatei von innerhalb des Dateiexplorers als ein Dienst installiert werden. Dies kann auch durch Öffnen eines Befehlsfensters und anschliessendes Ausführen des installierten Skripts von der Befehlszeile aus getan werden. Wenn der Dienst erfolgreich installiert wurde, wird sich das Skript sofort beenden.

Wenn irgendwelche Probleme auftreten würden, dann gäbe es eine Fehlermeldung, die das angezeigte Problem beschreibt. Das Skript wartet dann bis der User eine Taste drückt, bevor es sich beendet.

Befehls- und Ausgabebeispiel: 
InstallMyApp-NT.bat
wrapper  | My Application service installed.

Starten und Beenden des Windows Dienstes

Der Dienst kann nun durch Nutzung der jeweiligen Batch-Dateien gestartet und angehalten werden.

Befehls- und Ausgabebeispiel: 
StartMyApp-NT.bat
wrapper  | Starting the My Application service...
wrapper  | My Application started.

StopMyApp-NT.bat
wrapper  | Stopping the My Application service...
wrapper  | My Application stopped.

Da der Dienst ein normaler Windows Dienst ist, können Sie ihn auch via Systemsteuerung-Dienste ([Systemsteuerung] - [System and Sicherheit] - [Administrative Tools] - [Dienste]) unter Windows als Dienst auswählen und dann auf die "Dienst starten"-Schaltfläche klicken.

Zusätzlich kann der Dienst durch Nutzung der net start MyApp und net stop MyApp-Befehle gesteuert werden.

Befehls- und Ausgabebeispiel: 
net start MyApp
The My Application service is starting....
The My Application service was started successfully.

net stop MyApp
The My Application service is stopping..
The My Application service was stopped successfully.

NOTE

Die net start x- und net stop x-Befehle haben Probleme mit Diensten, die eine etwas längere Zeit zum Starten oder Beenden brauchen. In den meisten Fällen funktionieren sie, aber wenn ein Dienst mehr als ein paar Sekunden braucht, um sich zu beenden, wird der net stop x-Befehl zurückmelden, dass der Dienst beendet wurde, auch wenn er sich noch im Beenden-Prozess befindet. Dies kann zu Problemen führen, wenn ein Skript warten muß bis ein Dienst tatsächlich beendet wurde, bevor es fortfährt. Durch Nutzung des Wrappers können Sie solche Probleme beim Starten, Beenden des Dienstes vermeiden.

Die Wrapper-Methode des Startens und Beendens des Dienstes ist auch in Skripts nützlich, da es nicht die Eingabe des tatsächlichen Namens, unter dem der Dienst installiert ist, benötigt und dieser überall, außer in der wrapper.conf-Datei, vorhanden ist. Dies erübrigt das manuelle Ändern von mehreren Dateien, wenn der Dienstname geändert wird.

Wenn die wrapper.ntservice.starttype-Eigenschaft auf AUTO_START festgelegt ist, dann wird der Dienst gestartet werden, wann immer die Maschine neu gestartet wird.

Deinstallation (Entfernen) als Windows Dienst

Der Dienst kann deinstalliert werden, indem die UninstallMyApp-NT.bat Batch-Datei ausgeführt wird. Wenn er aktuell läuft, wird er zuerst beendet werden.

Befehls- und Ausgabebeispiel: 
UninstallMyApp-NT.bat
wrapper  | Service is running.  Stopping it...
wrapper  | Waiting to stop...
wrapper  | My Application stopped.
wrapper  | My Application service removed.

Befehlsbasierte Batch-Datei

Einige Anwendungen, die von UNIX-basierten Betriebssystemen portiert wurden, mögen mit einem UNIX-Stil-Befehlsskript besser laufen, um den Dienst zu kontrollieren. Die befehlsbasierte Batch-Datei kombiniert die gesamte Funktionalität aller individuellen dedizierten Batch-Dateien zusammen in eine einzelne Datei, die einen Befehl als einen Parameter nimmt.

Einrichten von Batch-Dateien

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.

Beispiel für das Ersetzen von Dateinamen: 
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.

Skriptkonfigurationsbereich: 
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.

Ausführen des Skripts

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

Nutzung: 
Usage:  [ console : setup : teardown : start : pause : resume : stop : restart : install : installstart : update : remove : status ]
Press any key to continue . . .
Nutzung mit aktiviertem _PASS_THROUGH : 
Usage:  [ console {JavaAppArgs} : setup : teardown : start : pause : resume : stop : restart : install {JavaAppArgs} : installstart {JavaAppArgs} : update {JavaAppArgs} : remove : status ]
Press any key to continue . . .

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.

  • Einrichten:

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

  • start:

    Genutzt, um einen installierten Windows-Dienst zu starten.

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

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

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

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

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

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.

Standalone-Programmdatei

Der Java Service Wrapper kann auch direkt, ohne Nutzung einer Batch-Datei, ausgeführt werden.

Wrapper-Nutzung

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

Wrapper-Nutzung: 
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.]

Starten der Anwendung

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.

Befehlsbeispiel: 
wrapper.exe -c ..\conf\wrapper.conf

Installation der Anwendung als einen Dienst

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

Befehlsbeispiel: 
wrapper.exe -i ..\conf\wrapper.conf

Starten der Anwendung als ein Dienst

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:

Befehlsbeispiel: 
wrapper.exe -t ..\conf\wrapper.conf

net start MyApp

NOTE

Die net start x- und net stop x- Befehle haben Probleme mit Diensten, die beim Starten oder Beenden viel Zeit beanspruchen. In den meisten Fällen funktionieren sie, aber wenn ein Dienst mehr als ein paar Sekunden beansprucht, um sich zu beenden, wird der net stop x Befehl zurückgeben, dass der Dienst beendet wurde, auch dann, wenn dieser sich noch im Beenden-Prozess befindet. Dies kann zu Problemen führen, wenn ein Skript warten muß bis ein Dienst tatsächlich beendet wurde. Durch Einsatz des Wrappers, um den Dienst zu starten oder zu beenden, haben Sie die Sicherheit, dass solche Probleme nicht auftreten.

Die Wrapper-Methode des Startens und Beendens des Dienstes ist auch in Skripts nützlich, da es nicht die Eingabe des tatsächlichen Namens, unter dem der Dienst installiert ist, erfordert und dieser überall, außer in der wrapper.conf-Datei, vorhanden ist. Dies erübrigt das manuelle Ändern von mehreren Dateien, wenn der Dienstname geändert wird.

Beenden der Anwendung als ein Dienst

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.

Befehlsbeispiel: 
wrapper.exe -p ..\conf\wrapper.conf

net stop MyApp

Deinstallation der Anwendung als ein Dienst

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

Befehlsbeispiel: 
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.

Abfragen des Status der Anwendung

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.

Befehl-und Ausgabebeispiel: 
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.

Verweis: Starten Ihrer Anwendung mit dem Wrapper

[Windows]

[Linux/Unix]

[Windows & Linux/Unix betreffend]