Wrapper 配布物の「%WRAPPER_HOME%\src\bin」フォルダを覗くと、 それぞれ機能別のタスクに応じた、たくさんのバッチファイルテンプレートが見えます。 （このページで示す他のフォルダには、さらに他のファイルもあります。）

• [App.bat.in] ：

  このファイルは、 カレントユーザーのデスクトップにある通常のコンソールベースのアプリケーションとして アプリケーションを動かすために利用します。 また、Windows サービスとして実行する前に、コンフィギュレーション設定のテストにも便利に利用できます。

• [SetupApp.bat.in] ：

  このバッチファイルは、Windows の最新版で管理者権限が必要なコンポネントをインストールするため、Wrapper バージョン 3.5.28 に追加されました。

  実行アクション：
  ・バージョン 3.5.28 より：Windows イベントログしシステムへアプリケーションを登録します。
  ・バージョン 3.5.42 より：Wrapper プロセスや Java プロセスが終了する際のイベントログモニタリング（監視）を有効・無効にします。

• [TeardownApp.bat.in] ：

  このバッチファイルは、クリーンアップタスクを実行するためや「SetupApp.bat」で行われた変更を元に戻すために Wrapper バージョン 3.5.28 に追加されました。

  実行アクション：
  ・バージョン 3.5.28 より：Windows イベントログシステムからアプリケーションの登録を解除します。
  ・バージョン 3.5.42 より：Wrapper プロセスや Java プロセスが終了する際のイベントログモニタリング（監視）を無効にします。

• [StartApp-NT.bat.in] ：

  このファイルは、インストールされた Windows サービスを開始するために利用します。

• [PauseApp-NT.bat.in] ：

  このファイルは、動作中の Windows サービスをポーズ（一時停止）するために利用します。 さらに詳しくは［wrapper.pausable］プロパティをご覧ください。

• [ResumeApp-NT.bat.in] ：

  このファイルは、ポーズ（一時停止）中の Windows サービスをレジューム（再開）するために利用します。 さらに詳しくは［wrapper.pausable］プロパティをご覧ください。

• [StopApp-NT.bat.in] ：

  このファイルは、動作中の Windows サービスを停止するために利用します。

  これはサービスのみを停止します。 もしアプリケーションがコンソールで動作中の場合には「サービスが動作していなかった」としてエラーになります。 さらに詳しくは「コンソールアプリケーションを停止するには？」ページをご覧ください。

• [InstallApp-NT.bat.in] ：

  このファイルは、アプリケーションを Windows サービスとしてインストールするために利用します。

• [UninstallApp-NT.bat.in] ：

  Windows サービスとしてのアプリケーションをアンインストール（取り外し）するために利用します。 もし、現在サービスが開始されている場合、それを停止します。

• [QueryApp-NT.bat.in] ：

  このファイルは、Windows サービスのステータス（状況）のクエリー（問い合わせ）する際に利用します。 これで、サービスのインストール状況や、サービスの動作状況（動作中、停止中、一時停止）などが分かります。

特定のアプリケーションが動作するように Wrapper を設定する際に、 アプリケーションの仕様に合わせて、上記のバッチファイルのどれかを選ぶことができます。 例えば、もしアプリケーションが「ポーズ（一時停止）」に対応していない場合には、 「PauseApp-NT.bat.in」や「ResumeApp-NT.bat.in」は必要ありません。

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 directory where the Wrapper binary (.exe) file is located. It can be
rem  either an absolute or a relative path. If the path contains any special
rem  characters, please make sure to quote the variable.
set _WRAPPER_DIR=

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.
rem If a relative path is specified, please note that the location is based on the
rem location of the Wrapper executable.
set _WRAPPER_CONF_DEFAULT="../conf/%_WRAPPER_BASE%.conf"

rem Makes it possible to override the Wrapper configuration file by specifying it
rem  as the first parameter.
rem set _WRAPPER_CONF_OVERRIDE=true

rem _PASS_THROUGH controls how the script arguments should be passed to the
rem  Wrapper. Possible values are:
rem  - commented or 'false': the arguments will be ignored (not passed).
rem  - 'app_args' or 'true': the arguments will be passed through the Wrapper as
rem                          arguments for the Java Application.
rem  - 'both': both Wrapper properties and Application arguments can be passed to
rem            the Wrapper. The Wrapper properties come in first position. The
rem            user can optionally add a '--' separator followed by application
rem            arguments.
rem NOTE - If _WRAPPER_CONF_OVERRIDE is set to true the above applies to arguments
rem        starting with the second, otherwise it applies to all arguments.
rem set _PASS_THROUGH=app_args

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

Wrapper 配布物の「%WRAPPER_HOME%\src\bin 」フォルダを覗くと、 バッチファイルテンプレート「AppCommand.bat.in」が見えます。

アプリケーションの「bin」フォルダにバッチファイルを単純にコピーしてご利用ください。 ファイル名の「App」部分をアプリケーション名に変更して、 ファイル名の拡張子「.in」を削除してください。

MyServerCommand.bat.in             -> MyServerCommand.bat
MyServer.bat.in   -> MyServer.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.
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] ：

  Wrapper バイナリがバッチファイルの配置場所に相対参照であるかをコントロールします。 ほとんどの場合、同じ場所に配置することが推奨されます。 もし他の場所へ移動させたい場合、デフォルトで、 Wrapper コンフィギュレーションファイルの相対パスが全て、 そのバッチファイルではなく、Wrapper バイナリの配置場所に相対であることに注意してください。

  Wrapper バイナリ「wrapper.exe」のファイル名の変更も可能で、 変更したファイル名「myapp.exe」でタスクマネージャーに表示されます。

• [_WRAPPER_CONF] ：

  デフォルトの Wrapper コンフィギュレーションファイルの配置場所や名前をコントロールします。 この相対パスは、バッチファイルの配置場所ではなく、常に Wrapper バイナリの配置場所への相対位置です。

• [_FIXED_COMMAND] （ver. 3.5.5 より）：

  スクリプトで、コマンドラインの最初のパラメータをコマンドとして扱うのではなく、ハードコードのコマンドて取り扱うようにします。 デフォルトで、スクリプトは最初のパラメータをコマンドとして取り扱います。 これは、上記で解説した専用バッチファイルに類似した動作をする複数のファイルを作成するときに、しばしば利用されます。

• [_PASS_THROUGH] （ver. 3.5.5 より）：

  バッチファイルへ引き渡したパラメータが Java アプリケーションへ引き渡されるかをコントロールします。 さらに詳しくは「コマンドラインパラメータを Java アプリケーションに引き渡すには？」ページをご覧ください。 この変数は「App.bat.in」や「InstallApp-NT.bat.in」だけに存在します。

コマンドベースのバッチファイル自身に説明が含まれており、 ユーザーが何もパラメータを付けずに、スクリプトを動かしてみた場合、使い方が表示されます。

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 ]

...

Windows 用のバッチファイルには、UNIX スクリプトと少し違いがあります。 UNIX スクリプトは、コンソールで動作している Wrapper を停止するために使うことができますが、 Windows 用のバッチファイルでは不可能です。 さらに加えて、［dump］コマンドは、Windows 用のバッチファイルにはありません。

ご覧のとおり、コマンドベースのバッチファイルは、幅の広い能力を提供しています：

• [console] ：

  このコマンドは、カレントユーザーのデスクトップにある通常のコンソールベースのアプリケーションとして アプリケーションを動かすために利用します。 また、Windows サービスとして実行する前に、コンフィギュレーション設定のテストにも便利に利用できます。

  もし「_PASS_THROUGH」が有効な場合、起動時に追加パラメータが直接 JVM へ引き渡されます。

• [start] ：

  このコマンドは、インストールされた Windows サービスを開始するために利用します。

• [stop] ：

  このコマンドは、動作中の Windows サービスを停止するために利用します。

  これはサービスを停止するだけです。 もしアプリケーションがコンソールで動作中の場合には「サービスが動作していなかった」としてエラーになります。 さらに詳しくは「コンソールアプリケーションを停止するには？」ページをご覧ください。

• [restart] ：

  このコマンドは、インストールされた Windows サービスを再開するために利用します。 これは、サービスを一旦停止してからもう一度開始します。

• [pause] ：

  このコマンドは、動作している Windows サービスをポーズ（一時停止）するために利用します。 さらに詳しくは［wrapper.pausable］プロパティページをご覧ください。

• [resume] ：

  このコマンドは、ポーズ（一時停止）中の Windows サービスをレジューム（再開）するために利用します。 さらに詳しくは［wrapper.pausable］プロパティページをご覧ください。

• [status] ：

  このコマンドは、Windows サービスのステータス（状況）のクエリー（問い合わせ）する際に利用します。

  出力例：サービスがインストールされていない場合

  wrapper | {myapp} サービスはインストールされていません。]

  出力例：サービスがインストールされているが、停止している場合

  wrapper | {myapp} サービスがインストールされています。 wrapper | スタートタイプ: 自動 wrapper | 対話型: いいえ wrapper | 動作中: いいえ]

  出力例：サービスが動作している場合

  wrapper | {myapp} サービスがインストールされています。 wrapper | スタートタイプ: 自動 wrapper | 対話型: いいえ wrapper | 動作中: はい]

• [permissions] ：

  このコマンドは、現在インストールされているサービスの権限を照会するために Wrapper ver. 3.5.52 に追加されました。 さらに詳しくは「権限」ページをご覧ください。

• [privileges] ：

  このコマンドは、現在インストールされているサービスの特権を照会するために Wrapper ver. 3.5.58 に追加されました。 さらに詳しくは「特権」ページをご覧ください。

• [install] ：

  このコマンドは、アプリケーションを Windows サービスとしてインストールするために利用します。

  もし「_PASS_THROUGH」が有効な場合、起動した後や再起動した後に、追加パラメータが直接 JVM へ引き渡されます。

• [installstart] ：

  このコマンドは、アプリケーションを Windows サービスとしてインストールして、開始するために利用します。

  もし「_PASS_THROUGH」が有効な場合、起動した後や再起動した後に、追加パラメータが直接 JVM へ引き渡されます。

• [update] ：

  このコマンドは、Windows サービスとしてアプリケーションをアップデート（再インストール）するために利用します。 これは、コンフィギュレーション値に変更を加えた場合など、サービスを更新する際に便利です。 これは、サービスを一旦、削除してから再インストールするのとは異なり、 「アカウントパスワード」など再入力は不要です。

  もし「_PASS_THROUGH」が有効な場合、 起動した後や再起動した後に、追加パラメータが直接 JVM へ引き渡されます。

• [remove] ：

  このコマンドは、Windows サービスとしてのアプリケーションをアンインストール（取り外し）するために利用します。 もし、現在サービスが開始されている場合、それを停止します。

• [setup] ：

  このコマンドは、Windows の最新バージョンで管理者権限が必要なコンポーネントをインストールするために、 Wrapper バージョン 3.5.28 に追加されました。

  実行アクション：
  ・バージョン 3.5.28 より：Windows イベントログしシステムへアプリケーションを登録します。
  ・バージョン 3.5.42 より：Wrapper プロセス、或いは Java プロセスが終了するときのイベントログモニタリング（監視）を有効・無効にします。

• [teardown] ：

  アプリケーションを分解するために利用します。 このコマンドは、「--setup」で変更された点を元に戻すために、 Wrapper バージョン 3.5.28 に追加されました。

  実行アクション：
  ・バージョン 3.5.28 より：Windows イベントログしシステムへアプリケーションの登録を解除します。
  ・バージョン 3.5.42 より：Wrapper プロセス、或いは Java プロセスが終了するときのイベントログモニタリング（監視）を無効にします。

一例として、次のコマンドを利用して、コンソールで Wrapper を開始できます：

MyApp.bat console
wrapper  | --> Wrapper がコンソールとして開始しました
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  |   {licensee} へライセンスを割り当て
wrapper  |
wrapper  | JVM 起動中...
jvm 1    | WrapperManager: 初期化中...

他のコマンドを実行するには、単純に「console」コマンドを、実行したいコマンドに書き換えてください。

もし、パラメータを付けずに、あるいは、「-?」を付けて 「wrapper」実行ファイルを実行すると、 以下のように、使い方の出力が表示されます。

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

コンソールアプリケーションとして Wrapper を動かすために、 「wrapper.conf」ファイルに続いて、 ［-c］コマンドを指定する必要があります。 「wrapper.conf」ファイルの配置場所は、絶対パスか相対パスで設定することができます。 もし、相対パスが利用されている場合、そのパスは、カレントディレクトリーではなく、 常に「wrapper.exe」ファイル場所への相対参照です。

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

アプリケーションを Windows サービスとしてインストールするためには、 以下の［-i］コマンドを実行します：

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

一旦インストールされると、そのサービスは、他の Windows サービスと同じようにスタートします。 もし、［wrapper.ntservice.starttype］が 「AUTO_START」（自動スタート）に設定されている場合、 インストールされたとき、次回のマシン再起動時にサービスがスタートします。 サービスコントロールパネル（［コントロールパネル］→［システムとセキュリティ］→［管理ツール］→［サービス］）でサービスを選択し、サービスを開始ボタンをクリックたり、或いは、以下のコマンドを一つ実行することでサービスを開始できます。

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

net start MyApp

Windows でサービスを停止するには、サービスコントロールパネル （［コントロールパネル］→［システムとセキュリティ］→［管理ツール］→［サービス］）で サービスを選択して「サービスの停止」をクリックするか、 あるいは、次のコマンドのどちらかを実行します：

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

net stop MyApp

アプリケーションを Windows サービスからアンインストールするには、次の［-r］コマンドを実行します：

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

もし、サービスのアンインストール時に、そのサービスが実行中であっても、キレイに停止して、サービスからアンインストールされます。

Wrapper に、コマンドラインから、あるいは、バッチファイを使って、 サービス状況の問い合わせをすることができます。 これは、現在のサービス状況を知る必要がある Install スクリプトを利用する際に便利です。

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

もし［-q］コマンドで動かすと、Wrapper は現在のステータスをコンソールに表示します。 ［-qs］コマンドでは静かに動作します。 Wrapper は、次の「終了コード」ビットの組み合わせで終了します：

• 1：サービスがインストールされています。

• 2：サービスが動作中です。

• 4：サービスがインタラクティブ（対話型）です。

• 8：スタートタイプが「自動」です。

• 16：スタートタイプが「手動」です。

• 32：スタートタイプが「無効」です。

• 32768 (2^15)：ステータスを問い合わせする際にエラーが発生しました。

例えば、終了コード「15」（＝1+2+4+8）では、『サービスがインストールされ、動作し、インタラクティブであり、 システムの起動時に、自動的にスタートするように設定されている』ということを示しています。 終了コード「0 (ゼロ)」では、『サービスが現在インストールされていない』という意味を表します。