コンフィギュレーションファイル「wrapper.conf」

Java Service Wrapperは、コンフィギュレーションファイル 「wrapper.conf」を利用して、 様々なWrapperの設定をコントロールしています。 詳しくは、『コンフィギュレーションプロパティ』をご覧ください。

wrapper.confのテンプレート:

wrapper.conf」ファイルのテンプレートは、 Wrapperの「src/conf」ディレクトリーの中にあり、 ファイル名は、「wrapper.conf.in_ja」になっています。 それを各アプリケーションの「conf」ディレクトリーにコピーしてご利用ください。

注意

コンフィギュレーションファイル「wrapper.conf」を操作する前に、 『インテグレーション方法の概要』を必ずご確認ください。 インテグレーション方法の各詳細説明では、お使いのアプリケーションや選択したインテグレーション方法それぞれの変更方法を詳しく説明しています。

「wrapper.conf」の例

コンフィギュレーションファイルwrapper.conf.inのデフォルトテンプレートは、 Wrapper の src/conf ディレクトリ内にあります。 このファイルをアプリケーションの conf ディレクトリにコピーし、名前を wrapper.conf に変更してください。 その後、アプリケーションをインテグレーションするためにコンフィギュレーションを変更します。

下記は、最新リリースに含まれるデフォルトの wrapper.conf.in テンプレートファイルです。 ここには(@ マークで囲まれた)トークンが使用されており、インストール時にアプリケーションの実際の名前、詳細情報へ置き換える必要があります。

  • '@app.name@': 短い名前・名称(例:testwrapper)
  • '@app.long.name@': アプリケーションの正式名称(例:TestWrapper Application)
  • '@app.description@': サービスの内容を説明する短い文章

注意

このテンプレートには、最も一般的に使用されるデフォルトのコンフィギュレーションのみが含まれています。 より高度なシナリオでの 使用には、上級者向けのコンフィギュレーションプロパティをご覧ください。

テンプレートの全文:

@encoding=UTF-8
# 設定ファイルの先頭行にエンコーディングを指定する必要があります。

# ファイル インクルードのデフォルトモード
@include.default_mode=required

# インクルードファイル(カスケード形式)に関連する問題解決には、
#  次の行頭記号「#」を削除することでデバッグできます。
#@include.debug

#********************************************************************
# Wrapper ライセンスプロパティ(コミュニティ版では不要です)
#********************************************************************
# Java Service Wrapper プロフェッショナル版やスタンダード版をご利用に
#  なるには有効なライセンスキーが必要です。以下のページからライセンスの購入、
#  またはトライアルライセンスのリクエストができます。
# https://wrapper.tanukisoftware.com/purchase
# https://wrapper.tanukisoftware.com/trial

# Wrapper では、次のどちらかの任意ファイルを探して、有効なライセンスキーの
#  チェックをします。ライセンスキー プロパティは任意的にこの設定ファイルに直接
#  含めることができます。
@include.optional ../conf/wrapper-license.conf
@include.optional ../conf/wrapper-license-%WRAPPER_HOST_NAME%.conf

# 次のプロパティでは、検出されたライセンスキーの情報を出力して、
#  ライセンスに関する問題解決に役立ちます。
#wrapper.license.debug=TRUE

#********************************************************************
# Wrapper ローカライゼーション
#********************************************************************
# Wrapper が利用する言語とロケールを指定します。
#wrapper.lang=en_US # en_US または ja_JP

# 言語リソース ファイル(*.mo)の保存場所を指定します。
wrapper.lang.folder=../lang

#********************************************************************
# Wrapper Java プロパティ
#********************************************************************
# Java アプリケーション
#  システム PATH 上の Java バイナリの配置場所を指定します。
wrapper.java.command=java
#  特定の Java バイナリを指定します。
#set.JAVA_HOME=/java/path
#wrapper.java.command=%JAVA_HOME%/bin/java

# 生成された Java コマンドライン全体をログに記録するように Wrapper に指示します。
#wrapper.java.command.loglevel=INFO

# Wrapper Jar ファイル
wrapper.jarfile=../lib/wrapper.jar

# 欠落している Java クラスパスエントリに関する通知のログレベルを設定します。
wrapper.java.classpath.missing.loglevel=WARN

# Java クラスパス
#  必要に応じてプロパティ名でクラスパス要素を「1」から順に追加してください。
#wrapper.java.classpath.1=

# Java モジュールパス(Java 9 以降が必要です)
#  必要に応じてプロパティ名でモジュールパス要素を「1」から順に追加してください。
#wrapper.java.module_path.1=

# Java モジュールリスト(Java 9 以降が必要です)
#  必要に応じてプロパティ名でモジュール名を「1」から順に追加してください。
#wrapper.java.module.1=

# Java ライブラリパス(「wrapper.dll」あるいは「libwrapper.so」の配置場所)
wrapper.java.library.path.1=../lib

# Java ビット。該当するプラットフォーム上では、
#  動作するビット モード(32ビット/64ビット)を JVM に指示します。
wrapper.java.additional.auto_bits=TRUE

# Java 追加パラメーター
wrapper.java.additional.1=

# Java ヒープの初期サイズ (MB)
#wrapper.java.initmemory=3

# Java ヒープの最大サイズ (in MB)
#wrapper.java.maxmemory=64

# バックエンド経由で渡されるアプリケーション システムプロパティ。
#  コア Java システムプロパティは、[wrapper.java.additional.<n>]を使用して渡す必要があります。
wrapper.app.property.1=

# Java メインクラス
#  このクラスは WrapperListener インターフェイスを実装するか、
#  あるいは、WrapperManager クラスが初期化されることを保証しなければなりません。
#  その手間を省くためにヘルパークラスを利用すると便利です。
#  詳細は次のページをご覧ください。
#  https://wrapper.tanukisoftware.com/doc/english/integrate.html
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp

# アプリケーション パラメーター
#  コマンドラインではなく、バックエンド経由でパラメーターを渡します。
#wrapper.app.parameter.backend=TRUE

#  必要に応じてプロパティ名でパラメーターを「1」から順に追加してください。
wrapper.app.parameter.1=<YourMainClass>

#********************************************************************
# Wrapper ロギング プロパティ
#********************************************************************
# Wrapper からのデバック出力を有効にします。
# wrapper.debug=TRUE

# コンソールの出力形式を設定します。(可能な設定値はサイト解説を参照)
wrapper.console.format=PM

# コンソール出力のログレベルを設定します。(可能な設定値はサイト解説を参照)
wrapper.console.loglevel=INFO

# Wrapper 出力ログに利用するログファイル名を設定します。
wrapper.logfile=../logs/wrapper.log

# ログファイルの出力形式を設定します。(可能な設定値はサイト解説を参照)
wrapper.logfile.format=LPTM

# ログファイル出力のログレベルを設定します。(可能な設定値はサイト解説を参照)
wrapper.logfile.loglevel=INFO

# ログファイルの分割保存モード
#  「SIZE_OR_WRAPPER」は、ログファイルのサイズが[wrapper.logfile.maxsize]によって
#  定義された値を超えるたびに、あるいは、Wrapper が起動するたびに、
#  ログファイルを分割保存します。
wrapper.logfile.rollmode=SIZE_OR_WRAPPER

# ログファイルの最大サイズを設定します。ファイルサイズが設定した値に
#  達するとロール番号を付加してログファイルを分割して保存します。
#  デフォルト値「0」では、ログファイル分割保存を無効にします。
#  サイズはバイト数で指定します。
#  サイズの略語も利用可能:「k」(キロバイト)、「m」(メガバイト)
#  例:「10m」=「10メガバイト」
wrapper.logfile.maxsize=10m

# ログファイルの最大ファイル数を設定します。ログファイルのファイル数が
#  設定した値に達すると古いファイルから削除していきます。
#  デフォルト値「0」では、ログファイル数に制限はありません。
wrapper.logfile.maxfiles=9

# SYS やイベントのログ出力のログレベルを設定します。(可能な設定値はサイト解説を参照)
wrapper.syslog.loglevel=NONE

#********************************************************************
# Wrapper 全般プロパティ
#********************************************************************
# プロパティに記述されたナンバリングで、連続していないギャップ
#  (途切れ)の利用を有効にします。
wrapper.ignore_sequence_gaps=TRUE

# PID ファイルが既に存在している場合は起動しません。
wrapper.pidfile.strict=TRUE

# コンソールとして動作しているときのタイトルを設定します。
wrapper.console.title=@app.long.name@

#********************************************************************
# Wrapper JVM チェック機能
#********************************************************************
# JVM でデッドロックしたスレッドを検知します。(スタンダード版の機能)
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL

# メモリ不足の検知。(スタックトレースのテキストのみ)
#  誤検知を避けるために -verbose:class の出力を無視します。
wrapper.filter.trigger.1000=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1000=NONE
#  誤検知を避けるために -Xlog:class+load=level の出力を無視します。
wrapper.filter.trigger.1001=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1001=NONE
# (単純一致)
wrapper.filter.trigger.1002=java.lang.OutOfMemoryError
# (-XX:+PrintClassHistogram が使用されている場合のみ、スタックトレース内のテキストと一致します。)
#wrapper.filter.trigger.1002=Exception in thread "*" java.lang.OutOfMemoryError
#wrapper.filter.allow_wildcards.1002=TRUE
wrapper.filter.action.1002=RESTART
wrapper.filter.message.1002=The JVM has run out of memory.

#********************************************************************
# Wrapper メール通知機能(プロフェッショナル版の機能)
#********************************************************************
# 一般的なイベントメール(イベントに応じたメール)設定
#wrapper.event.default.email.debug=TRUE
#wrapper.event.default.email.smtp.host=<SMTP_Host>
#wrapper.event.default.email.smtp.port=25
#wrapper.event.default.email.subject=[%WRAPPER_HOSTNAME%:%WRAPPER_NAME%:%WRAPPER_EVENT_NAME%] Event Notification
#wrapper.event.default.email.sender=<送信元メールアドレスl>
#wrapper.event.default.email.recipient=<送信先メールアドレス>

# イベントメールにログファイルを添付する際の設定
#wrapper.event.default.email.maillog=ATTACHMENT
#wrapper.event.default.email.maillog.lines=50
#wrapper.event.default.email.maillog.format=LPTM
#wrapper.event.default.email.maillog.loglevel=INFO

# 特定のイベント時に反応するメール機能を有効にします。
#wrapper.event.wrapper_start.email=TRUE
#wrapper.event.jvm_prelaunch.email=TRUE
#wrapper.event.jvm_start.email=TRUE
#wrapper.event.jvm_started.email=TRUE
#wrapper.event.jvm_deadlock.email=TRUE
#wrapper.event.jvm_stop.email=TRUE
#wrapper.event.jvm_stopped.email=TRUE
#wrapper.event.jvm_restart.email=TRUE
#wrapper.event.jvm_failed_invocation.email=TRUE
#wrapper.event.jvm_max_failed_invocations.email=TRUE
#wrapper.event.jvm_kill.email=TRUE
#wrapper.event.jvm_killed.email=TRUE
#wrapper.event.jvm_unexpected_exit.email=TRUE
#wrapper.event.wrapper_stop.email=TRUE

# メール本文のカスタマイズ設定
wrapper.event.jvm_restart.email.body=JVM が再起動されました。\n\nそのステータスを確認してください。\n

#********************************************************************
# Wrapper セキュアファイル プロパティ
#********************************************************************
# 機密データを含むファイルに対して最小特権の原則を適用するために、
#  Wrapper では、これらのファイルに付与されるすべてのアクセス許可が
#  コンフィギュレーションで明示的に許可されている必要があります。
#  プロパティの完全なリストについては、ドキュメンテーションページをお読みください。

# Windows 上の特定のアカウントまたはグループを許可します。
#wrapper.secure_file.check.windows.allowed_account.1=NT AUTHORITY\SYSTEM
#wrapper.secure_file.check.windows.allowed_account.2=BUILTIN\Administrators

# Unix システム上で特定のグループを許可します。
#wrapper.secure_file.check.unix.allowed_group.1=<Group_Of_Users>

# アクセス許可を確認すべき追加ファイル(スタンダード版の機能)
#wrapper.secure_file.additional.1=<Secured_File>

#********************************************************************
# Wrapper Windows サービス関連のプロパティ
#********************************************************************
# 警告 - この設定ファイルを利用してアプリケーションをサービスとして
#  インストールして動作している場合、以下のプロパティを変更しないでください。
#  これらのプロパティを変更する前に、サービスをアンインストールして
#  変更後に再インストールしてください。

# サービス名
wrapper.name=@app.name@

# サービスの表示名
wrapper.displayname=@app.long.name@

# サービスの説明
wrapper.description=@app.description@

# サービスの依存関係
#  必要に応じてプロパティ名で依存関係を「1」から順に追加してください。
wrapper.ntservice.dependency.1=

# サービスがインストールされるモードを設定します。
#  設定可能な値:「AUTO_START」、「DELAY_START」(スタンダード版の機能)、「DEMAND_START」
wrapper.ntservice.starttype=AUTO_START

# サービスを実行するときに使用するアカウント
#  デフォルトの空白値は、Windows で高い権限を持つアカウントである LocalSystem を使用します。
#  他の使用可能なアカウントの種類については、このプロパティの解説ページをお読みください。
wrapper.ntservice.account=

# 現在のユーザーが管理者の資格情報の入力を要求されずに
#  特定のアクションを実行できるようにします。(プロフェッショナル版の機能)
#wrapper.ntservice.permissions.1.account=CURRENT_USER
#wrapper.ntservice.permissions.1.allow=START, STOP, PAUSE_RESUME