コンフィギュレーションファイル「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