すぐに使える Eclipse Jetty インテグレーション(Windows)

Eclipse Jetty 12.x.x インテグレーション

こちらでは、Eclipse Jetty 12.0.36 または 12.1.10 をスムーズにセットアップするための手順を説明します。 Jetty 12 シリーズのその他のバージョンでも、同様の手順で動作します。

Jetty をダウンロード

Jetty Downloads から Jetty を zip ファイルとしてダウンロードします。 特定のバージョンについては、Maven Repository からダウンロードすることも可能です。 ここでは jetty-home-12.1.10.zip を使用して作業を進めます。

アーカイブを解凍し jetty-home-12.1.10 ディレクトリを取得します。 必要に応じて、名称を変更してください。

Jetty 12 では、ホームディレクトリ内に対する変更を行わない仕様となっています。 並列(同階層)のディレクトリとして jetty-base-12 を作成し、同ディレクトリへ cd 移動した上で、以下のコマンドを実行してディレクトリの初期化を行ってください。

java -jar ../jetty-home-12.1.19/start.jar --add-modules=server,http,ee10-deploy

Wrapper をダウンロード

以下の手順は、Java Service Wrapper のバージョン 3.7.0 で動作するように設計されています。 これより前のバージョンを使用することも可能ですが、いくつかの変更が必要になる可能性があります。

使用するエディション(プロフェッショナル、スタンダード、または コミュニティ)を決定し、対象のプラットフォーム、ビット数、およびアーキテクチャを選択します。 次にインストーラーまたはアーカイブを ダウンロード して、インストールまたは解凍(展開)を行ってください。 ここでは、Windows x86 上で プロフェッショナル版 64-bit 使用しているものとして進めます。

Wrapper のインテグレーション

必要な Wrapper ファイルの配置を容易にするため、jetty-base-12 ディレクトリ内にupdateWrapper.ps1 という名前で以下のシェルスクリプトを作成します。 上記で Wrapper をインストールまたは解凍(展開)した場所に合わせて、パスを変更してください。

$WRAPPER_HOME = "../wrapper-windows-x86-64-3.7.0-pro"
$JETTY_BASE = "."
$WRAPPER_SCRIPT = "service.bat"

[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/bin")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lib")
if (Test-Path "$WRAPPER_HOME/lang" -PathType Container) {
    [void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lang")
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapper_*.mo" -Destination "$JETTY_BASE/lang/"
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapperjni_*.mo" -Destination "$JETTY_BASE/lang/"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/conf")
if (Test-Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -PathType Leaf) {
    Copy-Item -Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -Destination "$JETTY_BASE/conf/wrapper-license.conf"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/logs")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/tmp")

Copy-Item -Path "$WRAPPER_HOME/bin/wrapper.exe" -Destination "$JETTY_BASE/bin/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.jar" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.dll" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/src/bin/AppCommand.bat.in" -Destination "$JETTY_BASE/bin/$WRAPPER_SCRIPT" -Force

スクリプトを実行。

./updateWrapper.ps1

注意

PowerShell でスクリプトの実行が無効になっているというエラーが表示される場合は、以下を実行してください。

powershell.exe -ExecutionPolicy Bypass -File .\updateWrapper.ps1

本バイパス(回避策)処理はその実行時のみ適用されるため、既存の PowerShell 設定が変更されることはありません。


この設定では、インテグレーション方法 1 を使用します。

クラスパス、アプリケーションのメインクラス、およびアプリケーションパラメータは、すべて Wrapper 設定ファイルの後に用意されているスクリプトを使用して動的に生成されます。

注意

JAVA_HOME を設定する必要がありますが、システム環境に定義されている場合はデフォルトでそれが使用されます。 なお、Java 17 以降のバージョンを指定する必要があります。

以下の内容で、Wrapper 設定ファイルを conf/wrapper.conf として作成します。

@encoding=UTF-8
# The configuration file must begin with a line declaring its encoding.

# Default mode for file inclusions
@include.default_mode=required

# Include file problems can be debugged by removing '#' at the beginning
#  of the following line:
#@include.debug

#********************************************************************
# Wrapper License Properties (Ignored by Community Edition)
#********************************************************************
# Professional and Standard Editions of the Wrapper require a valid
#  License Key to start.  Licenses can be purchased or a trial license
#  requested on the following pages:
# https://wrapper.tanukisoftware.com/purchase
# https://wrapper.tanukisoftware.com/trial

# The Wrapper will look for either of the following optional files for a
#  valid License Key.  License Key properties can optionally be included
#  directly in this configuration file.
@include.optional %WRAPPER_CONF_DIR%/wrapper-license.conf
@include.optional %WRAPPER_CONF_DIR%/wrapper-license-%WRAPPER_HOST_NAME%.conf

# The following property will output information about which License Key(s)
#  are being found, and can aid in resolving any licensing problems.
#wrapper.license.debug=TRUE

#********************************************************************
# Environment
#********************************************************************
set.default.JAVA_HOME=(SetMe)

# JETTY_BASE and JETTY_HOME are set in wrapper-generated.conf
@include %WRAPPER_BIN_DIR%/../conf/wrapper-generated.conf

# Change the working dir used by java so Jetty is in its expected location.
#  Setting JETTY_BASE relative to the fixed WRAPPER_BIN_DIR location helps make their meaning clear and avoid confusion when changing the working dir.
wrapper.working.dir=%JETTY_BASE%

#********************************************************************
# Wrapper Localization
#********************************************************************
# Specify the language and locale which the Wrapper should use.
#wrapper.lang=en_US # en_US or ja_JP

# Specify the location of the language resource files (*.mo).
wrapper.lang.folder=%JETTY_BASE%/lang

#********************************************************************
# Wrapper Java Properties
#********************************************************************
# Java Application
wrapper.java.command=%JAVA_HOME%/bin/java

# Tell the Wrapper to log the full generated Java command line.
#wrapper.java.command.loglevel=INFO

# Wrapper Jar file
wrapper.jarfile=%JETTY_BASE%/lib/wrapper.jar

# Log level for notices about missing Java Classpath entries.
wrapper.java.classpath.missing.loglevel=WARN

# Java Version control
wrapper.java.version.output=true
wrapper.java.version.min=17
#wrapper.java.version.max=

# Java Classpath.  Add class path elements as needed starting from 1
# (See wrapper-generated.conf)

# Java Modulepath. (Requires Java 9 or above)
#  Add module path elements as needed starting from 1
#wrapper.java.module_path.1=

# Java Module list. (Requires Java 9 or above)
#  Add module names as needed starting from 1
#wrapper.java.module.1=

# Java Library Path (location of wrapper.dll or libwrapper.so)
wrapper.java.library.path.1=%JETTY_BASE%/lib

# Java Bits.  On applicable platforms, tells the JVM to run in 32 or 64-bit mode.
wrapper.java.additional.auto_bits=TRUE

# Java Additional Parameters
wrapper.java.additional.1=-Djava.io.tmpdir=%JETTY_BASE%/tmp

# Initial Java Heap Size (in MB)
#wrapper.java.initmemory=3

# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=256

# Application System Properties passed via the backend.
#  Core Java System Properties must be passed using wrapper.java.additional.<n>.
wrapper.app.property.1=jetty.home=%JETTY_HOME%
wrapper.app.property.2=jetty.base=%JETTY_BASE%

# Java Main class.  This class must implement the WrapperListener interface
#  or guarantee that the WrapperManager class is initialized.
#  Helper classes are provided to do this for you.
#  See the following page for details:
#  https://wrapper.tanukisoftware.com/doc/english/integrate.html
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp

# Application parameters.
#  Pass parameters via the backend instead of the command line.
#wrapper.app.parameter.backend=TRUE

#  Add parameters as needed starting from 1
# (See wrapper-generated.conf)

#********************************************************************
# Wrapper Logging Properties
#********************************************************************
# Enables Debug output from the Wrapper.
# wrapper.debug=TRUE

# Format of output for the console.  (See docs for formats)
wrapper.console.format=PM

# Log Level for console output.  (See docs for log levels)
wrapper.console.loglevel=INFO

# Log file to use for Wrapper output logging.
wrapper.logfile=%JETTY_BASE%/logs/wrapper.log

# Format of output for the log file.  (See docs for formats)
wrapper.logfile.format=LPTM

# Log Level for log file output.  (See docs for log levels)
wrapper.logfile.loglevel=INFO

# Roll mode of the log file.
#  SIZE_OR_WRAPPER causes the file to be rolled whenever its size exceeds the
#  value defined by wrapper.logfile.maxsize, or whenever the Wrapper is
#  launched.
wrapper.logfile.rollmode=SIZE_OR_WRAPPER

# Maximum size that the log file will be allowed to grow to before
#  the log is rolled. Size is specified in bytes.  The default value
#  of 0 disables log rolling.  May abbreviate with the 'k' (kb) or
#  'm' (mb) suffixes.  For example: 10m = 10 megabytes.
wrapper.logfile.maxsize=10m

# Maximum number of rolled log files which will be allowed before old
#  files are deleted.  The default value of 0 implies no limit.
wrapper.logfile.maxfiles=9

# Log Level for sys/event log output.  (See docs for log levels)
wrapper.syslog.loglevel=NONE

#********************************************************************
# Wrapper General Properties
#********************************************************************
# Allow for the use of non-contiguous numbered properties
wrapper.ignore_sequence_gaps=TRUE

# Do not start if the pid file already exists.
wrapper.pidfile.strict=TRUE

# Title to use when running as a console
wrapper.console.title=Jetty Server

#********************************************************************
# Wrapper JVM Checks
#********************************************************************
# Detect DeadLocked Threads in the JVM. (Requires Standard Edition)
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL

# Out Of Memory detection.
#  Ignore -verbose:class output to avoid false positives.
wrapper.filter.trigger.1000=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1000=NONE
#  Ignore -Xlog:class+load=level output to avoid false positives.
wrapper.filter.trigger.1001=[class,load] java.lang.OutOfMemoryError
wrapper.filter.action.1001=NONE
# (Simple match)
wrapper.filter.trigger.1002=java.lang.OutOfMemoryError
# (Only match text in stack traces if -XX:+PrintClassHistogram is being used.)
#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 Email Notifications. (Requires Professional Edition)
#********************************************************************
# Common Event Email settings.
#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=<Sender email>
#wrapper.event.default.email.recipient=<Recipient email>

# Configure the log attached to event emails.
#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

# Enable specific event emails.
#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

# Specify custom mail content
wrapper.event.jvm_restart.email.body=The JVM was restarted.\n\nPlease check on its status.\n

#********************************************************************
# Wrapper Secure File Properties
#********************************************************************
# To enforce the principle of least privilege for files containing
#  sensitive data, the Wrapper requires that all permissions granted
#  to these files be explicitly allowed in the configuration.
#  Please read the documentation for the full list of properties.

# Allow specific accounts or groups on Windows.
#wrapper.secure_file.check.windows.allowed_account.1=NT AUTHORITY\SYSTEM
#wrapper.secure_file.check.windows.allowed_account.2=BUILTIN\Administrators

# Allow specific groups on Unix systems.
#wrapper.secure_file.check.unix.allowed_group.1=<Group_Of_Users>

# Additional files to check for permissions (Requires Standard Edition)
#wrapper.secure_file.additional.1=<Secured_File>

#********************************************************************
# Wrapper Windows Service Properties
#********************************************************************
# WARNING - Do not modify any of these properties when an application
#  using this configuration file has been installed as a service.
#  Please uninstall the service before modifying this section.
#  The service can then be reinstalled.

# Name of the service
wrapper.name=jetty

# Display name of the service
wrapper.displayname=Jetty

# Description of the service
wrapper.description=Jetty Server

# Service dependencies.  Add dependencies as needed starting from 1
wrapper.ntservice.dependency.1=

# Mode in which the service is installed.
#  AUTO_START, DELAY_START (Requires Standard Edition) or DEMAND_START
wrapper.ntservice.starttype=AUTO_START

# Account to use when running the service.
#  The default blank value will use LocalSystem, which is highly privileged
#  account on Windows. Please read the documentation page for this property to
#  learn about other account types that can be used.
wrapper.ntservice.account=

# Allow the current user to perform certain actions without being prompted for
#  administrator credentials. (Requires Professional Edition)
#wrapper.ntservice.permissions.1.account=CURRENT_USER
#wrapper.ntservice.permissions.1.allow=START, STOP, PAUSE_RESUME

Jetty 12 の start.jar は、Jetty サーバーを直接起動するものではありません。Jetty サーバーを稼働させる子 Java プロセス起動用のコマンドラインを動的に生成するための、ブートストラップアプリケーションとして機能します。 この仕組みは、Jetty を実行する Java インスタンスを直接監視できないため、Java Service Wrapper と連携して運用する場合には適していません。 Jetty には該当コマンドラインの構成要素を抽出する機能が備わっており、以下のスクリプトを実行することで、上述の conf/wrapper.conf 内にインクルードされる設定フラグメント conf/wrapper-generated.conf を生成します。 なお、アプリケーションの設定を大幅に変更した場合は、このスクリプトを再実行する必要があります。それ以外の場合は、設定を変更せずそのまま固定しておいて問題ありません。

jetty-base-12 ディレクトリ内に、以下の PowerShell スクリプトを updateWrapperGeneratedConf.ps1 として作成してください。

$ErrorActionPreference = "Stop"

# Run from script's directory
$ScriptDir = Split-Path -Parent $MyInvocation.MyCommand.Path
Set-Location $ScriptDir

# Jetty home argument check
$JETTY_HOME = if ($args.Count -ge 1) { $args[0] } else { "" }
if ([string]::IsNullOrWhiteSpace($JETTY_HOME)) {
    Write-Error "ERROR: jetty.home directory not specified."
    Write-Output "Usage: .\$($MyInvocation.MyCommand.Name) \path\to\jetty.home"
    Exit 1
}

if (-not (Test-Path -Path $JETTY_HOME -PathType Container)) {
    Write-Error "ERROR: '$JETTY_HOME' does not exist or is not a directory."
    Exit 1
}

$StartJarPath = Join-Path $JETTY_HOME "start.jar"
if (-not (Test-Path -Path $StartJarPath -PathType Leaf)) {
    Write-Error "ERROR: '$StartJarPath' not found."
    Write-Error "Is '$JETTY_HOME' a valid Jetty home directory?"
    Exit 1
}

$JETTY_BASE = "."
$CONF_DIR = Join-Path $JETTY_BASE "conf"
$ABS_JETTY_HOME = (Get-Item $JETTY_HOME).FullName
$ABS_JETTY_BASE = (Get-Item $JETTY_BASE).FullName

Write-Output "ABS_JETTY_HOME=$ABS_JETTY_HOME"
Write-Output "ABS_JETTY_BASE=$ABS_JETTY_BASE"

# Run dry-run from inside ABS_JETTY_BASE
function Invoke-DryRun {
    param([string]$DryRunArg)
    Push-Location $ABS_JETTY_BASE
    try {
        & java -jar "$ABS_JETTY_HOME/start.jar" $DryRunArg
    } finally {
        Pop-Location
    }
}

$OPTS = Invoke-DryRun "--dry-run=opts"
$MAIN_CLASS = Invoke-DryRun "--dry-run=main"
$ARGS_OUTPUT = Invoke-DryRun "--dry-run=args"
$PATH_INFO = Invoke-DryRun "--dry-run=path"
$ENVS = try { Invoke-DryRun "--dry-run=envs" } catch { "" }

$CONF_JETTY_HOME = $ABS_JETTY_HOME -replace '\\', '/'
$CONF_JETTY_BASE = $ABS_JETTY_BASE -replace '\\', '/'

$ConfFile = Join-Path $CONF_DIR "wrapper-generated.conf"
$CurrentDate = Get-Date -Format "g"

# Helper function to sanitize text replacing paths
function Sanitize-Text {
    param([string]$text)
    if ([string]::IsNullOrEmpty($text)) { return "" }

    # Remove any single quotes
    $text = $text -replace "'", ""

    # Escape paths for regex replacement
    $escapedHome = [Regex]::Escape($ABS_JETTY_HOME)
    $escapedBase = [Regex]::Escape($ABS_JETTY_BASE)
    
    $text = $text -replace $escapedHome, "%JETTY_HOME%"
    $text = $text -replace $escapedBase, "%JETTY_BASE%"
    $text = $text -replace "file:///", "file://"
    return $text
}

# Start writing the file
$ConfigContent = @"
# =============================================================
# AUTO-GENERATED Jetty 12 Java Service Wrapper config - $CurrentDate
# Regenerate with: .\$($MyInvocation.MyCommand.Name)
# =============================================================

set.JETTY_HOME=$CONF_JETTY_HOME
set.JETTY_BASE=$CONF_JETTY_BASE

# From --dry-run=path
"@

# Process PATH_INFO
$k = 1
if (-not [string]::IsNullOrWhiteSpace($PATH_INFO)) {
    $cleanPathInfo = $PATH_INFO -replace "^--class-path\s+", ""
    $entries = $cleanPathInfo -split [IO.Path]::PathSeparator
    
    foreach ($entry in $entries) {
        if (-not [string]::IsNullOrWhiteSpace($entry)) {
            $entryClean = Sanitize-Text $entry.Trim()
            $ConfigContent += "`nwrapper.java.classpath.$k=$entryClean"
            $k++
        }
    }
}

$ConfigContent += @"


# App Main Class
wrapper.app.parameter.1=$MAIN_CLASS

# From --dry-run=args (properties + XMLs)
"@

# Process ARGS
$m = 100
if (-not [string]::IsNullOrWhiteSpace($ARGS_OUTPUT)) {
    $argsList = $ARGS_OUTPUT -split "\s+"
    foreach ($arg in $argsList) {
        if (-not [string]::IsNullOrWhiteSpace($arg)) {
            if ($arg -like "*addHiddenClasses*") {
                $ConfigContent += "`nwrapper.app.parameter.$m=jetty.webapp.addHiddenClasses=org.eclipse.jetty.logging.,file://%JETTY_HOME%/lib/logging/,org.slf4j."
            } else {
                $argClean = Sanitize-Text $arg
                $ConfigContent += "`nwrapper.app.parameter.$m=$argClean"
            }
            $m++
        }
    }
}

# Process ENVS
if (-not [string]::IsNullOrWhiteSpace($ENVS)) {
    $ConfigContent += "`n`n# From --dry-run=envs (EEnn)"
    $m = 1000
    $envsList = $ENVS -split "\s+"
    foreach ($arg in $envsList) {
        if (-not [string]::IsNullOrWhiteSpace($arg)) {
            $argClean = Sanitize-Text $arg
            $ConfigContent += "`nwrapper.app.parameter.$m=$argClean"
            $m++
        }
    }
}

# Output to file with UTF8 encoding (standard for config files)
$ConfigContent + "`n" | Out-File -FilePath $ConfFile -Encoding utf8

Write-Output "SUCCESS! Generated -> $ConfFile"

jetty-base-12 ディレクトリ内から、以下のコマンドを実行します。

./updateWrapperGeneratedConf.ps1 ../jetty-home-12.1.10

注意

PowerShell でスクリプトの実行が無効になっているというエラーが表示される場合は、以下を実行してください。

powershell.exe -ExecutionPolicy Bypass -File ./updateWrapperGeneratedConf.ps1 ../jetty-home-12.1.10

本バイパス(回避策)処理はその実行時のみ適用されるため、既存の PowerShell 設定が変更されることはありません。


注意

スタンダード版またはプロフェッショナル版をご利用の場合は、デフォルトの15分ライセンスが conf/wrapper-license.conf としてコピーされます。 それより長く実行するには、トライアルライセンス、サーバーライセンス、または開発用ライセンスで更新する必要があります。

実行

コンソールで実行する場合、

  • bin/service.bat console を実行してください。

Windows Service として実行する場合、下記のコマンドを実行してください。

  • サービスインストール:bin/service.bat install

  • サービス開始:bin/service.bat start

  • サービス停止:bin/service.bat stop

  • サービスアンインストール:bin/service.bat remove

使用可能なコマンドの一覧を表示するには、

  • bin/service.bat を実行してください。

ログファイル logs/wrapper.log を tail コマンド等で監視することで、Wrapper のログ出力と Java からのコンソール出力を併せて確認できます。 また、その他の Jetty ログファイルもこのディレクトリ内に保存されます。

Eclipse Jetty 11.0.x インテグレーション

こちらでは、Eclipse Jetty 11.0.26 をスムーズにセットアップするための手順を説明します。 Jetty 11 シリーズのその他のバージョンでも、同様の手順で動作します。

Jetty をダウンロード

Jetty Downloads から Jetty を zip ファイルとしてダウンロードします。 特定のバージョンについては、Maven Repository からダウンロードすることも可能です。 ここでは、jetty-home-11.0.26.zip を使用して作業を進めます。

アーカイブを解凍し jetty-home-11.0.26 ディレクトリを取得します。 必要に応じて、名称を変更してください。

Jetty 11 では、ホームディレクトリ内に対する変更を行わない仕様となっています。 並列(同階層)のディレクトリとして jetty-base-11 を作成し、同ディレクトリへ cd 移動した上で、以下のコマンドを実行してディレクトリの初期化を行ってください。

java -jar ../jetty-home-11.0.26/start.jar --add-module=server,http,deploy

Wrapper をダウンロード

以下の手順は、Java Service Wrapper のバージョン 3.7.0 で動作するように設計されています。 これより前のバージョンを使用することも可能ですが、いくつかの変更が必要になる可能性があります。

使用するエディション(プロフェッショナル、スタンダード、または コミュニティ)を決定し、対象のプラットフォーム、ビット数、およびアーキテクチャを選択します。 次にインストーラーまたはアーカイブをダウンロードして、インストールまたは解凍(展開)を行ってください。 ここでは、Windows x86 上で プロフェッショナル版 64-bit 使用しているものとして進めます。

Wrapper のインテグレーション

必要な Wrapper ファイルの配置を容易にするため、jetty-base-11 ディレクトリ内にupdateWrapper.ps1 という名前で以下のシェルスクリプトを作成します。 上記で Wrapper をインストールまたは解凍(展開)した場所に合わせて、パスを変更してください。

$WRAPPER_HOME = "../wrapper-windows-x86-64-3.7.0-pro"
$JETTY_BASE = "."
$WRAPPER_SCRIPT = "service.bat"

[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/bin")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lib")
if (Test-Path "$WRAPPER_HOME/lang" -PathType Container) {
    [void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lang")
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapper_*.mo" -Destination "$JETTY_BASE/lang/"
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapperjni_*.mo" -Destination "$JETTY_BASE/lang/"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/conf")
if (Test-Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -PathType Leaf) {
    Copy-Item -Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -Destination "$JETTY_BASE/conf/wrapper-license.conf"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/logs")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/tmp")

Copy-Item -Path "$WRAPPER_HOME/bin/wrapper.exe" -Destination "$JETTY_BASE/bin/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.jar" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.dll" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/src/bin/AppCommand.bat.in" -Destination "$JETTY_BASE/bin/$WRAPPER_SCRIPT" -Force

スクリプトを実行。

./updateWrapper.ps1

注意

PowerShell でスクリプトの実行が無効になっているというエラーが表示される場合は、以下を実行してください。

powershell.exe -ExecutionPolicy Bypass -File .\updateWrapper.ps1

本バイパス(回避策)処理はその実行時のみ適用されるため、既存の PowerShell 設定が変更されることはありません。


この設定では、インテグレーション方法 1 を使用します。 start.jar が実行可能 JAR ファイルとして使用されない理由につきましては、下記の注記を参照ください。

注意

JAVA_HOMEを設定する必要がありますが、システム環境に定義されている場合はデフォルトでそれが使用されます。 なお、Jetty 11 を使用するには、Java 11 以降のバージョンを指定する必要があります。

Jetty の start.jar ファイルは実行可能 JAR ファイルとなっています。 理論上は、本セットアップにおいてインテグレーション方法 4 を用いることも可能ですが、その場合、1番目のアプリケーションプロパティとして wrapper.app.parameter.1=%JETTY_HOME%/start.jar を指定しなければなりません。これを行うと、各マシン環境によって値が異なるようになり、ライセンスキー適用時に正常に動作しなくなってしまいます。 その回避策として、start.jar はクラスパス上の通常の JAR ファイルとして取り扱い、マニフェストファイルから抽出した Main-Class: org.eclipse.jetty.start.Main エントリを直接参照する仕様としています。

以下の内容で、Wrapper 設定ファイルを conf/wrapper.conf として作成します。

@encoding=UTF-8
# The configuration file must begin with a line declaring its encoding.

# Default mode for file inclusions
@include.default_mode=required

# Include file problems can be debugged by removing '#' at the beginning
#  of the following line:
#@include.debug

#********************************************************************
# Wrapper License Properties (Ignored by Community Edition)
#********************************************************************
# Professional and Standard Editions of the Wrapper require a valid
#  License Key to start.  Licenses can be purchased or a trial license
#  requested on the following pages:
# https://wrapper.tanukisoftware.com/purchase
# https://wrapper.tanukisoftware.com/trial

# The Wrapper will look for either of the following optional files for a
#  valid License Key.  License Key properties can optionally be included
#  directly in this configuration file.
@include.optional %WRAPPER_CONF_DIR%/wrapper-license.conf
@include.optional %WRAPPER_CONF_DIR%/wrapper-license-%WRAPPER_HOST_NAME%.conf

# The following property will output information about which License Key(s)
#  are being found, and can aid in resolving any licensing problems.
#wrapper.license.debug=TRUE

#********************************************************************
# Environment
#********************************************************************
set.default.JAVA_HOME=(SetMe)
# Setting all relative paths next to the fixed WRAPPER_BIN_DIR location helps make their meaning clear.
set.JETTY_HOME=%WRAPPER_BIN_DIR%/../../jetty-home-11.0.26
set.JETTY_BASE=%WRAPPER_BIN_DIR%/..

# Change the working dir used by java so Jetty is in its expected location.
#  Setting JETTY_BASE relative to the fixed WRAPPER_BIN_DIR location helps make their meaning clear and avoid confusion when changing the working dir.
wrapper.working.dir=%JETTY_BASE%

#********************************************************************
# Wrapper Localization
#********************************************************************
# Specify the language and locale which the Wrapper should use.
#wrapper.lang=en_US # en_US or ja_JP

# Specify the location of the language resource files (*.mo).
wrapper.lang.folder=%JETTY_BASE%/lang

#********************************************************************
# Wrapper Java Properties
#********************************************************************
# Java Application
wrapper.java.command=%JAVA_HOME%/bin/java

# Tell the Wrapper to log the full generated Java command line.
#wrapper.java.command.loglevel=INFO

# Wrapper Jar file
wrapper.jarfile=%JETTY_BASE%/lib/wrapper.jar

# Log level for notices about missing Java Classpath entries.
wrapper.java.classpath.missing.loglevel=WARN

# Java Version control
wrapper.java.version.output=true
wrapper.java.version.min=11
#wrapper.java.version.max=

# Java Classpath.  Add class path elements as needed starting from 1
wrapper.java.classpath.1=%JETTY_HOME%/start.jar

# Java Modulepath. (Requires Java 9 or above)
#  Add module path elements as needed starting from 1
#wrapper.java.module_path.1=

# Java Module list. (Requires Java 9 or above)
#  Add module names as needed starting from 1
#wrapper.java.module.1=

# Java Library Path (location of wrapper.dll or libwrapper.so)
wrapper.java.library.path.1=%JETTY_BASE%/lib

# Java Bits.  On applicable platforms, tells the JVM to run in 32 or 64-bit mode.
wrapper.java.additional.auto_bits=TRUE

# Java Additional Parameters
wrapper.java.additional.1=-Djava.io.tmpdir=%JETTY_BASE%/tmp

# Initial Java Heap Size (in MB)
#wrapper.java.initmemory=3

# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=256

# Application System Properties passed via the backend.
#  Core Java System Properties must be passed using wrapper.java.additional.<n>.
wrapper.app.property.1=jetty.home=%JETTY_HOME%
wrapper.app.property.2=jetty.base=%JETTY_BASE%

# Java Main class.  This class must implement the WrapperListener interface
#  or guarantee that the WrapperManager class is initialized.
#  Helper classes are provided to do this for you.
#  See the following page for details:
#  https://wrapper.tanukisoftware.com/doc/english/integrate.html
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp

# Application parameters.
#  Pass parameters via the backend instead of the command line.
#wrapper.app.parameter.backend=TRUE

#  Add parameters as needed starting from 1
wrapper.app.parameter.1=org.eclipse.jetty.start.Main

#********************************************************************
# Wrapper Logging Properties
#********************************************************************
# Enables Debug output from the Wrapper.
# wrapper.debug=TRUE

# Format of output for the console.  (See docs for formats)
wrapper.console.format=PM

# Log Level for console output.  (See docs for log levels)
wrapper.console.loglevel=INFO

# Log file to use for Wrapper output logging.
wrapper.logfile=%JETTY_BASE%/logs/wrapper.log

# Format of output for the log file.  (See docs for formats)
wrapper.logfile.format=LPTM

# Log Level for log file output.  (See docs for log levels)
wrapper.logfile.loglevel=INFO

# Roll mode of the log file.
#  SIZE_OR_WRAPPER causes the file to be rolled whenever its size exceeds the
#  value defined by wrapper.logfile.maxsize, or whenever the Wrapper is
#  launched.
wrapper.logfile.rollmode=SIZE_OR_WRAPPER

# Maximum size that the log file will be allowed to grow to before
#  the log is rolled. Size is specified in bytes.  The default value
#  of 0 disables log rolling.  May abbreviate with the 'k' (kb) or
#  'm' (mb) suffixes.  For example: 10m = 10 megabytes.
wrapper.logfile.maxsize=10m

# Maximum number of rolled log files which will be allowed before old
#  files are deleted.  The default value of 0 implies no limit.
wrapper.logfile.maxfiles=9

# Log Level for sys/event log output.  (See docs for log levels)
wrapper.syslog.loglevel=NONE

#********************************************************************
# Wrapper General Properties
#********************************************************************
# Allow for the use of non-contiguous numbered properties
wrapper.ignore_sequence_gaps=TRUE

# Do not start if the pid file already exists.
wrapper.pidfile.strict=TRUE

# Title to use when running as a console
wrapper.console.title=Jetty Server

#********************************************************************
# Wrapper JVM Checks
#********************************************************************
# Detect DeadLocked Threads in the JVM. (Requires Standard Edition)
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL

# Out Of Memory detection.
#  Ignore -verbose:class output to avoid false positives.
wrapper.filter.trigger.1000=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1000=NONE
#  Ignore -Xlog:class+load=level output to avoid false positives.
wrapper.filter.trigger.1001=[class,load] java.lang.OutOfMemoryError
wrapper.filter.action.1001=NONE
# (Simple match)
wrapper.filter.trigger.1002=java.lang.OutOfMemoryError
# (Only match text in stack traces if -XX:+PrintClassHistogram is being used.)
#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 Email Notifications. (Requires Professional Edition)
#********************************************************************
# Common Event Email settings.
#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=<Sender email>
#wrapper.event.default.email.recipient=<Recipient email>

# Configure the log attached to event emails.
#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

# Enable specific event emails.
#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

# Specify custom mail content
wrapper.event.jvm_restart.email.body=The JVM was restarted.\n\nPlease check on its status.\n

#********************************************************************
# Wrapper Secure File Properties
#********************************************************************
# To enforce the principle of least privilege for files containing
#  sensitive data, the Wrapper requires that all permissions granted
#  to these files be explicitly allowed in the configuration.
#  Please read the documentation for the full list of properties.

# Allow specific accounts or groups on Windows.
#wrapper.secure_file.check.windows.allowed_account.1=NT AUTHORITY\SYSTEM
#wrapper.secure_file.check.windows.allowed_account.2=BUILTIN\Administrators

# Allow specific groups on Unix systems.
#wrapper.secure_file.check.unix.allowed_group.1=<Group_Of_Users>

# Additional files to check for permissions (Requires Standard Edition)
#wrapper.secure_file.additional.1=<Secured_File>

#********************************************************************
# Wrapper Windows Service Properties
#********************************************************************
# WARNING - Do not modify any of these properties when an application
#  using this configuration file has been installed as a service.
#  Please uninstall the service before modifying this section.
#  The service can then be reinstalled.

# Name of the service
wrapper.name=jetty

# Display name of the service
wrapper.displayname=Jetty

# Description of the service
wrapper.description=Jetty Server

# Service dependencies.  Add dependencies as needed starting from 1
wrapper.ntservice.dependency.1=

# Mode in which the service is installed.
#  AUTO_START, DELAY_START (Requires Standard Edition) or DEMAND_START
wrapper.ntservice.starttype=AUTO_START

# Account to use when running the service.
#  The default blank value will use LocalSystem, which is highly privileged
#  account on Windows. Please read the documentation page for this property to
#  learn about other account types that can be used.
wrapper.ntservice.account=

# Allow the current user to perform certain actions without being prompted for
#  administrator credentials. (Requires Professional Edition)
#wrapper.ntservice.permissions.1.account=CURRENT_USER
#wrapper.ntservice.permissions.1.allow=START, STOP, PAUSE_RESUME

注意

スタンダード版またはプロフェッショナル版をご利用の場合は、デフォルトの15分ライセンスが conf/wrapper-license.conf としてコピーされます。 それより長く実行するには、トライアルライセンス、サーバーライセンス、または開発用ライセンスで更新する必要があります。

実行

コンソールで実行する場合、

  • bin/service.bat console を実行してください。

Windows Service として実行する場合、下記のコマンドを実行してください。

  • サービスインストール:bin/service.bat install

  • サービス開始:bin/service.bat start

  • サービス停止:bin/service.bat stop

  • サービスアンインストール:bin/service.bat remove

使用可能なコマンドの一覧を表示するには、

  • bin/service.bat を実行してください。

ログファイル logs/wrapper.log を tail コマンド等で監視することで、Wrapper のログ出力と Java からのコンソール出力を併せて確認できます。 また、その他の Jetty ログファイルもこのディレクトリ内に保存されます。

Eclipse Jetty 10.0.x インテグレーション

こちらでは、Eclipse Jetty 10.0.26 をスムーズにセットアップするための手順を説明します。 Jetty 10 シリーズのその他のバージョンでも、同様の手順で動作します。

Jetty をダウンロード

Jetty Downloads から Jetty を zip ファイルとしてダウンロードします。 特定のバージョンについては、Maven Repository からダウンロードすることも可能です。 ここでは jetty-home-10.0.26.zip を使用して作業を進めます。

アーカイブを解凍し jetty-home-10.0.26 ディレクトリを取得します。 必要に応じて、名称を変更してください。

Jetty 10 では、ホームディレクトリ内に対する変更を行わない仕様となっています。 並列(同階層)のディレクトリとして jetty-base-10 を作成し、同ディレクトリへ cd 移動した上で、以下のコマンドを実行してディレクトリの初期化を行ってください。

java -jar ../jetty-home-10.0.26/start.jar --add-module=server,http,deploy

Wrapper をダウンロード

以下の手順は、Java Service Wrapper のバージョン 3.7.0 で動作するように設計されています。 これより前のバージョンを使用することも可能ですが、いくつかの変更が必要になる可能性があります。

使用するエディション(プロフェッショナル、スタンダード、または コミュニティ)を決定し、対象のプラットフォーム、ビット数、およびアーキテクチャを選択します。 次にインストーラーまたはアーカイブをダウンロードして、インストールまたは解凍(展開)を行ってください。 ここでは、Windows x86 上で プロフェッショナル版 64-bit 使用しているものとして進めます。

Wrapper のインテグレーション

必要な Wrapper ファイルの配置を容易にするため、jetty-base-10 ディレクトリ内にupdateWrapper.ps1 という名前で以下のシェルスクリプトを作成します。 上記で Wrapper をインストールまたは解凍(展開)した場所に合わせて、パスを変更してください。

$WRAPPER_HOME = "../wrapper-windows-x86-64-3.7.0-pro"
$JETTY_BASE = "."
$WRAPPER_SCRIPT = "service.bat"

[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/bin")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lib")
if (Test-Path "$WRAPPER_HOME/lang" -PathType Container) {
    [void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lang")
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapper_*.mo" -Destination "$JETTY_BASE/lang/"
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapperjni_*.mo" -Destination "$JETTY_BASE/lang/"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/conf")
if (Test-Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -PathType Leaf) {
    Copy-Item -Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -Destination "$JETTY_BASE/conf/wrapper-license.conf"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/logs")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/tmp")

Copy-Item -Path "$WRAPPER_HOME/bin/wrapper.exe" -Destination "$JETTY_BASE/bin/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.jar" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.dll" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/src/bin/AppCommand.bat.in" -Destination "$JETTY_BASE/bin/$WRAPPER_SCRIPT" -Force

スクリプトを実行。

./updateWrapper.ps1

注意

PowerShell でスクリプトの実行が無効になっているというエラーが表示される場合は、以下を実行してください。

powershell.exe -ExecutionPolicy Bypass -File .\updateWrapper.ps1

本バイパス(回避策)処理はその実行時のみ適用されるため、既存の PowerShell 設定が変更されることはありません。


この設定では、インテグレーション方法 1 を使用します。 start.jar が実行可能 JAR ファイルとして使用されない理由につきましては、下記の注記を参照ください。

注意

JAVA_HOMEを設定する必要がありますが、システム環境に定義されている場合はデフォルトでそれが使用されます。 なお、Jetty 10 を使用するには、Java 11 以降のバージョンを指定する必要があります。

Jetty の start.jar ファイルは実行可能 JAR ファイルとなっています。 理論上は、本セットアップにおいてインテグレーション方法 4 を用いることも可能ですが、その場合、1番目のアプリケーションプロパティとして wrapper.app.parameter.1=%JETTY_HOME%/start.jar を指定しなければなりません。これを行うと、各マシン環境によって値が異なるようになり、ライセンスキー適用時に正常に動作しなくなってしまいます。 その回避策として、start.jar はクラスパス上の通常の JAR ファイルとして取り扱い、マニフェストファイルから抽出した Main-Class: org.eclipse.jetty.start.Main エントリを直接参照する仕様としています。

以下の内容で、Wrapper 設定ファイルを conf/wrapper.conf として作成します。

@encoding=UTF-8
# The configuration file must begin with a line declaring its encoding.

# Default mode for file inclusions
@include.default_mode=required

# Include file problems can be debugged by removing '#' at the beginning
#  of the following line:
#@include.debug

#********************************************************************
# Wrapper License Properties (Ignored by Community Edition)
#********************************************************************
# Professional and Standard Editions of the Wrapper require a valid
#  License Key to start.  Licenses can be purchased or a trial license
#  requested on the following pages:
# https://wrapper.tanukisoftware.com/purchase
# https://wrapper.tanukisoftware.com/trial

# The Wrapper will look for either of the following optional files for a
#  valid License Key.  License Key properties can optionally be included
#  directly in this configuration file.
@include.optional %WRAPPER_CONF_DIR%/wrapper-license.conf
@include.optional %WRAPPER_CONF_DIR%/wrapper-license-%WRAPPER_HOST_NAME%.conf

# The following property will output information about which License Key(s)
#  are being found, and can aid in resolving any licensing problems.
#wrapper.license.debug=TRUE

#********************************************************************
# Environment
#********************************************************************
set.default.JAVA_HOME=(SetMe)
# Setting all relative paths next to the fixed WRAPPER_BIN_DIR location helps make their meaning clear.
set.JETTY_HOME=%WRAPPER_BIN_DIR%/../../jetty-home-10.0.26
set.JETTY_BASE=%WRAPPER_BIN_DIR%/..

# Change the working dir used by java so Jetty is in its expected location.
#  Setting JETTY_BASE relative to the fixed WRAPPER_BIN_DIR location helps make their meaning clear and avoid confusion when changing the working dir.
wrapper.working.dir=%JETTY_BASE%

#********************************************************************
# Wrapper Localization
#********************************************************************
# Specify the language and locale which the Wrapper should use.
#wrapper.lang=en_US # en_US or ja_JP

# Specify the location of the language resource files (*.mo).
wrapper.lang.folder=%JETTY_BASE%/lang

#********************************************************************
# Wrapper Java Properties
#********************************************************************
# Java Application
wrapper.java.command=%JAVA_HOME%/bin/java

# Tell the Wrapper to log the full generated Java command line.
#wrapper.java.command.loglevel=INFO

# Wrapper Jar file
wrapper.jarfile=%JETTY_BASE%/lib/wrapper.jar

# Log level for notices about missing Java Classpath entries.
wrapper.java.classpath.missing.loglevel=WARN

# Java Version control
wrapper.java.version.output=true
wrapper.java.version.min=11
#wrapper.java.version.max=

# Java Classpath.  Add class path elements as needed starting from 1
wrapper.java.classpath.1=%JETTY_HOME%/start.jar

# Java Modulepath. (Requires Java 9 or above)
#  Add module path elements as needed starting from 1
#wrapper.java.module_path.1=

# Java Module list. (Requires Java 9 or above)
#  Add module names as needed starting from 1
#wrapper.java.module.1=

# Java Library Path (location of wrapper.dll or libwrapper.so)
wrapper.java.library.path.1=%JETTY_BASE%/lib

# Java Bits.  On applicable platforms, tells the JVM to run in 32 or 64-bit mode.
wrapper.java.additional.auto_bits=TRUE

# Java Additional Parameters
wrapper.java.additional.1=-Djava.io.tmpdir=%JETTY_BASE%/tmp

# Initial Java Heap Size (in MB)
#wrapper.java.initmemory=3

# Maximum Java Heap Size (in MB)
wrapper.java.maxmemory=256

# Application System Properties passed via the backend.
#  Core Java System Properties must be passed using wrapper.java.additional.<n>.
wrapper.app.property.1=jetty.home=%JETTY_HOME%
wrapper.app.property.2=jetty.base=%JETTY_BASE%

# Java Main class.  This class must implement the WrapperListener interface
#  or guarantee that the WrapperManager class is initialized.
#  Helper classes are provided to do this for you.
#  See the following page for details:
#  https://wrapper.tanukisoftware.com/doc/english/integrate.html
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp

# Application parameters.
#  Pass parameters via the backend instead of the command line.
#wrapper.app.parameter.backend=TRUE

#  Add parameters as needed starting from 1
wrapper.app.parameter.1=org.eclipse.jetty.start.Main

#********************************************************************
# Wrapper Logging Properties
#********************************************************************
# Enables Debug output from the Wrapper.
# wrapper.debug=TRUE

# Format of output for the console.  (See docs for formats)
wrapper.console.format=PM

# Log Level for console output.  (See docs for log levels)
wrapper.console.loglevel=INFO

# Log file to use for Wrapper output logging.
wrapper.logfile=%JETTY_BASE%/logs/wrapper.log

# Format of output for the log file.  (See docs for formats)
wrapper.logfile.format=LPTM

# Log Level for log file output.  (See docs for log levels)
wrapper.logfile.loglevel=INFO

# Roll mode of the log file.
#  SIZE_OR_WRAPPER causes the file to be rolled whenever its size exceeds the
#  value defined by wrapper.logfile.maxsize, or whenever the Wrapper is
#  launched.
wrapper.logfile.rollmode=SIZE_OR_WRAPPER

# Maximum size that the log file will be allowed to grow to before
#  the log is rolled. Size is specified in bytes.  The default value
#  of 0 disables log rolling.  May abbreviate with the 'k' (kb) or
#  'm' (mb) suffixes.  For example: 10m = 10 megabytes.
wrapper.logfile.maxsize=10m

# Maximum number of rolled log files which will be allowed before old
#  files are deleted.  The default value of 0 implies no limit.
wrapper.logfile.maxfiles=9

# Log Level for sys/event log output.  (See docs for log levels)
wrapper.syslog.loglevel=NONE

#********************************************************************
# Wrapper General Properties
#********************************************************************
# Allow for the use of non-contiguous numbered properties
wrapper.ignore_sequence_gaps=TRUE

# Do not start if the pid file already exists.
wrapper.pidfile.strict=TRUE

# Title to use when running as a console
wrapper.console.title=Jetty Server

#********************************************************************
# Wrapper JVM Checks
#********************************************************************
# Detect DeadLocked Threads in the JVM. (Requires Standard Edition)
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL

# Out Of Memory detection.
#  Ignore -verbose:class output to avoid false positives.
wrapper.filter.trigger.1000=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1000=NONE
#  Ignore -Xlog:class+load=level output to avoid false positives.
wrapper.filter.trigger.1001=[class,load] java.lang.OutOfMemoryError
wrapper.filter.action.1001=NONE
# (Simple match)
wrapper.filter.trigger.1002=java.lang.OutOfMemoryError
# (Only match text in stack traces if -XX:+PrintClassHistogram is being used.)
#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 Email Notifications. (Requires Professional Edition)
#********************************************************************
# Common Event Email settings.
#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=<Sender email>
#wrapper.event.default.email.recipient=<Recipient email>

# Configure the log attached to event emails.
#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

# Enable specific event emails.
#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

# Specify custom mail content
wrapper.event.jvm_restart.email.body=The JVM was restarted.\n\nPlease check on its status.\n

#********************************************************************
# Wrapper Secure File Properties
#********************************************************************
# To enforce the principle of least privilege for files containing
#  sensitive data, the Wrapper requires that all permissions granted
#  to these files be explicitly allowed in the configuration.
#  Please read the documentation for the full list of properties.

# Allow specific accounts or groups on Windows.
#wrapper.secure_file.check.windows.allowed_account.1=NT AUTHORITY\SYSTEM
#wrapper.secure_file.check.windows.allowed_account.2=BUILTIN\Administrators

# Allow specific groups on Unix systems.
#wrapper.secure_file.check.unix.allowed_group.1=<Group_Of_Users>

# Additional files to check for permissions (Requires Standard Edition)
#wrapper.secure_file.additional.1=<Secured_File>

#********************************************************************
# Wrapper Windows Service Properties
#********************************************************************
# WARNING - Do not modify any of these properties when an application
#  using this configuration file has been installed as a service.
#  Please uninstall the service before modifying this section.
#  The service can then be reinstalled.

# Name of the service
wrapper.name=jetty

# Display name of the service
wrapper.displayname=Jetty

# Description of the service
wrapper.description=Jetty Server

# Service dependencies.  Add dependencies as needed starting from 1
wrapper.ntservice.dependency.1=

# Mode in which the service is installed.
#  AUTO_START, DELAY_START (Requires Standard Edition) or DEMAND_START
wrapper.ntservice.starttype=AUTO_START

# Account to use when running the service.
#  The default blank value will use LocalSystem, which is highly privileged
#  account on Windows. Please read the documentation page for this property to
#  learn about other account types that can be used.
wrapper.ntservice.account=

# Allow the current user to perform certain actions without being prompted for
#  administrator credentials. (Requires Professional Edition)
#wrapper.ntservice.permissions.1.account=CURRENT_USER
#wrapper.ntservice.permissions.1.allow=START, STOP, PAUSE_RESUME

注意

スタンダード版またはプロフェッショナル版をご利用の場合は、デフォルトの15分ライセンスが conf/wrapper-license.conf としてコピーされます。 それより長く実行するには、トライアルライセンス、サーバーライセンス、または開発用ライセンスで更新する必要があります。

実行

コンソールで実行する場合、

  • bin/service.bat console を実行してください。

Windows Service として実行する場合、下記のコマンドを実行してください。

  • サービスインストール:bin/service.bat install

  • サービス開始:bin/service.bat start

  • サービス停止:bin/service.bat stop

  • サービスアンインストール:bin/service.bat remove

使用可能なコマンドの一覧を表示するには、

  • bin/service.bat を実行してください。

ログファイル logs/wrapper.log を tail コマンド等で監視することで、Wrapper のログ出力と Java からのコンソール出力を併せて確認できます。 また、その他の Jetty ログファイルもこのディレクトリ内に保存されます。

Eclipse Jetty 9.4.x インテグレーション

こちらでは、Eclipse Jetty 9.4.58.v20250814 をスムーズにセットアップするための手順を説明します。 Jetty 9 シリーズのその他のバージョンでも、同様の手順で動作します。

Jetty をダウンロード

Jetty Downloads から Jetty を zip ファイルとしてダウンロードします。特定のバージョンについては、Archives Page からダウンロードすることも可能です。ここでは、jetty-distribution-9.4.58.v20250814.zip を使用して作業を進めます。

アーカイブを解凍し jetty-distribution-9.4.58.v20250814 ディレクトリを取得します。必要に応じて、名称を変更してください。

Jetty 9 では、ホームディレクトリ内に対する変更を行わない仕様となっています。 並列(同階層)のディレクトリとして jetty-base-9 を作成し、同ディレクトリへ cd 移動した上で、以下のコマンドを実行してディレクトリの初期化を行ってください。

java -jar ../jetty-distribution-9.4.58.v20250814/start.jar --add-to-start=http,deploy

Wrapper をダウンロード

以下の手順は、Java Service Wrapper のバージョン 3.7.0 で動作するように設計されています。 これより前のバージョンを使用することも可能ですが、いくつかの変更が必要になる可能性があります。

使用するエディション(プロフェッショナル、スタンダード、または コミュニティ)を決定し、対象のプラットフォーム、ビット数、およびアーキテクチャを選択します。 次にインストーラーまたはアーカイブをダウンロードして、インストールまたは解凍(展開)を行ってください。 ここでは、Windows x86 上で プロフェッショナル版 64-bit 使用しているものとして進めます。

Wrapper のインテグレーション

必要な Wrapper ファイルの配置を容易にするため、jetty-base-9 ディレクトリ内にupdateWrapper.ps1 という名前で以下のシェルスクリプトを作成します。 上記で Wrapper をインストールまたは解凍(展開)した場所に合わせて、パスを変更してください。

$WRAPPER_HOME = "../wrapper-windows-x86-64-3.7.0-pro"
$JETTY_BASE = "."
$WRAPPER_SCRIPT = "service.bat"

[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/bin")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lib")
if (Test-Path "$WRAPPER_HOME/lang" -PathType Container) {
    [void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/lang")
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapper_*.mo" -Destination "$JETTY_BASE/lang/"
    Copy-Item -Path "$WRAPPER_HOME/lang/wrapperjni_*.mo" -Destination "$JETTY_BASE/lang/"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/conf")
if (Test-Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -PathType Leaf) {
    Copy-Item -Path "$WRAPPER_HOME/src/conf/wrapper-license-time.conf" -Destination "$JETTY_BASE/conf/wrapper-license.conf"
}
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/logs")
[void](New-Item -ItemType Directory -Force -Path "${JETTY_BASE}/tmp")

Copy-Item -Path "$WRAPPER_HOME/bin/wrapper.exe" -Destination "$JETTY_BASE/bin/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.jar" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/lib/wrapper.dll" -Destination "$JETTY_BASE/lib/" -Force
Copy-Item -Path "$WRAPPER_HOME/src/bin/AppCommand.bat.in" -Destination "$JETTY_BASE/bin/$WRAPPER_SCRIPT" -Force

スクリプトを実行。

./updateWrapper.ps1

注意

PowerShell でスクリプトの実行が無効になっているというエラーが表示される場合は、以下を実行してください。

powershell.exe -ExecutionPolicy Bypass -File .\updateWrapper.ps1

本バイパス(回避策)処理はその実行時のみ適用されるため、既存の PowerShell 設定が変更されることはありません。


この設定では、インテグレーション方法 1 を使用します。 start.jar が実行可能 JAR ファイルとして使用されない理由につきましては、下記の注記を参照ください。

注意

JAVA_HOMEを設定する必要がありますが、システム環境に定義されている場合はデフォルトでそれが使用されます。 なお、Jetty 9 を使用するには、Java 8 以降のバージョンを指定する必要があります。

Jetty の start.jar ファイルは実行可能 JAR ファイルとなっています。 理論上は、本セットアップにおいてインテグレーション方法 4 を用いることも可能ですが、その場合、1番目のアプリケーションプロパティとして wrapper.app.parameter.1=%JETTY_HOME%/start.jar を指定しなければなりません。これを行うと、各マシン環境によって値が異なるようになり、ライセンスキー適用時に正常に動作しなくなってしまいます。 その回避策として、start.jar はクラスパス上の通常の JAR ファイルとして取り扱い、マニフェストファイルから抽出した Main-Class: org.eclipse.jetty.start.Main エントリを直接参照する仕様としています。

以下の内容で、Wrapper 設定ファイルを conf/wrapper.conf として作成します。

@encoding=UTF-8
# The configuration file must begin with a line declaring its encoding.

# Default mode for file inclusions
@include.default_mode=required

# Include file problems can be debugged by removing '#' at the beginning
#  of the following line:
#@include.debug

#********************************************************************
# Wrapper License Properties (Ignored by Community Edition)
#********************************************************************
# Professional and Standard Editions of the Wrapper require a valid
#  License Key to start.  Licenses can be purchased or a trial license
#  requested on the following pages:
# https://wrapper.tanukisoftware.com/purchase
# https://wrapper.tanukisoftware.com/trial

# The Wrapper will look for either of the following optional files for a
#  valid License Key.  License Key properties can optionally be included
#  directly in this configuration file.
@include.optional ../conf/wrapper-license.conf
@include.optional ../conf/wrapper-license-%WRAPPER_HOST_NAME%.conf

# The following property will output information about which License Key(s)
#  are being found, and can aid in resolving any licensing problems.
#wrapper.license.debug=TRUE

#********************************************************************
# Environment
#********************************************************************
set.default.JAVA_HOME=(SetMe)
# Setting all relative paths next to the fixed WRAPPER_BIN_DIR location helps make their meaning clear.
set.JETTY_HOME=%WRAPPER_BIN_DIR%/../../jetty-distribution-9.4.58.v20250814
set.JETTY_BASE=%WRAPPER_BIN_DIR%/..

# Change the working dir used by java so Jetty is in its expected location.
#  Setting JETTY_BASE relative to the fixed WRAPPER_BIN_DIR location helps make their meaning clear and avoid confusion when changing the working dir.
wrapper.working.dir=%JETTY_BASE%

#********************************************************************
# Wrapper Localization
#********************************************************************
# Specify the language and locale which the Wrapper should use.
#wrapper.lang=en_US # en_US or ja_JP

# Specify the location of the language resource files (*.mo).
wrapper.lang.folder=%JETTY_BASE%/lang

#********************************************************************
# Wrapper Java Properties
#********************************************************************
# Java Application
wrapper.java.command=%JAVA_HOME%/bin/java

# Tell the Wrapper to log the full generated Java command line.
#wrapper.java.command.loglevel=INFO

# Wrapper Jar file
wrapper.jarfile=%JETTY_BASE%/lib/wrapper.jar

# Log level for notices about missing Java Classpath entries.
wrapper.java.classpath.missing.loglevel=WARN

# Java Version control
wrapper.java.version.output=true
wrapper.java.version.min=8
#wrapper.java.version.max=

# Java Classpath.  Add class path elements as needed starting from 1
wrapper.java.classpath.1=%JETTY_HOME%/start.jar

# Java Modulepath. (Requires Java 9 or above)
#  Add module path elements as needed starting from 1
#wrapper.java.module_path.1=

# Java Module list. (Requires Java 9 or above)
#  Add module names as needed starting from 1
#wrapper.java.module.1=

# Java Library Path (location of wrapper.dll or libwrapper.so)
wrapper.java.library.path.1=%JETTY_BASE%/lib

# Java Bits.  On applicable platforms, tells the JVM to run in 32 or 64-bit mode.
wrapper.java.additional.auto_bits=TRUE

# Java Additional Parameters
wrapper.java.additional.1=-Djava.io.tmpdir=%JETTY_BASE%/tmp

# Initial Java Heap Size (in MB)
#wrapper.java.initmemory=3

# Maximum Java Heap Size (in MB)
#wrapper.java.maxmemory=64

# Application System Properties passed via the backend.
#  Core Java System Properties must be passed using wrapper.java.additional.<n>.
wrapper.app.property.1=jetty.home=%JETTY_HOME%
wrapper.app.property.2=jetty.base=%JETTY_BASE%

# Java Main class.  This class must implement the WrapperListener interface
#  or guarantee that the WrapperManager class is initialized.
#  Helper classes are provided to do this for you.
#  See the following page for details:
#  https://wrapper.tanukisoftware.com/doc/english/integrate.html
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp

# Application parameters.
#  Pass parameters via the backend instead of the command line.
#wrapper.app.parameter.backend=TRUE

#  Add parameters as needed starting from 1
wrapper.app.parameter.1=org.eclipse.jetty.start.Main
wrapper.app.parameter.2=jetty.state=%JETTY_BASE%/jetty-echo.state
wrapper.app.parameter.3=jetty-started.xml

#********************************************************************
# Wrapper Logging Properties
#********************************************************************
# Enables Debug output from the Wrapper.
# wrapper.debug=TRUE

# Format of output for the console.  (See docs for formats)
wrapper.console.format=PM

# Log Level for console output.  (See docs for log levels)
wrapper.console.loglevel=INFO

# Log file to use for Wrapper output logging.
wrapper.logfile=%JETTY_BASE%/logs/wrapper.log

# Format of output for the log file.  (See docs for formats)
wrapper.logfile.format=LPTM

# Log Level for log file output.  (See docs for log levels)
wrapper.logfile.loglevel=INFO

# Roll mode of the log file.
#  SIZE_OR_WRAPPER causes the file to be rolled whenever its size exceeds the
#  value defined by wrapper.logfile.maxsize, or whenever the Wrapper is
#  launched.
wrapper.logfile.rollmode=SIZE_OR_WRAPPER

# Maximum size that the log file will be allowed to grow to before
#  the log is rolled. Size is specified in bytes.  The default value
#  of 0 disables log rolling.  May abbreviate with the 'k' (kb) or
#  'm' (mb) suffixes.  For example: 10m = 10 megabytes.
wrapper.logfile.maxsize=10m

# Maximum number of rolled log files which will be allowed before old
#  files are deleted.  The default value of 0 implies no limit.
wrapper.logfile.maxfiles=9

# Log Level for sys/event log output.  (See docs for log levels)
wrapper.syslog.loglevel=NONE

#********************************************************************
# Wrapper General Properties
#********************************************************************
# Allow for the use of non-contiguous numbered properties
wrapper.ignore_sequence_gaps=TRUE

# Do not start if the pid file already exists.
wrapper.pidfile.strict=TRUE

# Title to use when running as a console
wrapper.console.title=Jetty Server

#********************************************************************
# Wrapper JVM Checks
#********************************************************************
# Detect DeadLocked Threads in the JVM. (Requires Standard Edition)
wrapper.check.deadlock=TRUE
wrapper.check.deadlock.interval=60
wrapper.check.deadlock.action=RESTART
wrapper.check.deadlock.output=FULL

# Out Of Memory detection.
#  Ignore -verbose:class output to avoid false positives.
wrapper.filter.trigger.1000=[Loaded java.lang.OutOfMemoryError
wrapper.filter.action.1000=NONE
#  Ignore -Xlog:class+load=level output to avoid false positives.
wrapper.filter.trigger.1001=[class,load] java.lang.OutOfMemoryError
wrapper.filter.action.1001=NONE
# (Simple match)
wrapper.filter.trigger.1002=java.lang.OutOfMemoryError
# (Only match text in stack traces if -XX:+PrintClassHistogram is being used.)
#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 Email Notifications. (Requires Professional Edition)
#********************************************************************
# Common Event Email settings.
#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=<Sender email>
#wrapper.event.default.email.recipient=<Recipient email>

# Configure the log attached to event emails.
#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

# Enable specific event emails.
#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

# Specify custom mail content
wrapper.event.jvm_restart.email.body=The JVM was restarted.\n\nPlease check on its status.\n

#********************************************************************
# Wrapper Secure File Properties
#********************************************************************
# To enforce the principle of least privilege for files containing
#  sensitive data, the Wrapper requires that all permissions granted
#  to these files be explicitly allowed in the configuration.
#  Please read the documentation for the full list of properties.

# Allow specific accounts or groups on Windows.
#wrapper.secure_file.check.windows.allowed_account.1=NT AUTHORITY\SYSTEM
#wrapper.secure_file.check.windows.allowed_account.2=BUILTIN\Administrators

# Allow specific groups on Unix systems.
#wrapper.secure_file.check.unix.allowed_group.1=<Group_Of_Users>

# Additional files to check for permissions (Requires Standard Edition)
#wrapper.secure_file.additional.1=<Secured_File>

#********************************************************************
# Wrapper Windows Service Properties
#********************************************************************
# WARNING - Do not modify any of these properties when an application
#  using this configuration file has been installed as a service.
#  Please uninstall the service before modifying this section.
#  The service can then be reinstalled.

# Name of the service
wrapper.name=jetty

# Display name of the service
wrapper.displayname=Jetty

# Description of the service
wrapper.description=Jetty Server

# Service dependencies.  Add dependencies as needed starting from 1
wrapper.ntservice.dependency.1=

# Mode in which the service is installed.
#  AUTO_START, DELAY_START (Requires Standard Edition) or DEMAND_START
wrapper.ntservice.starttype=AUTO_START

# Account to use when running the service.
#  The default blank value will use LocalSystem, which is highly privileged
#  account on Windows. Please read the documentation page for this property to
#  learn about other account types that can be used.
wrapper.ntservice.account=

# Allow the current user to perform certain actions without being prompted for
#  administrator credentials. (Requires Professional Edition)
#wrapper.ntservice.permissions.1.account=CURRENT_USER
#wrapper.ntservice.permissions.1.allow=START, STOP, PAUSE_RESUME

注意

スタンダード版またはプロフェッショナル版をご利用の場合は、デフォルトの15分ライセンスが conf/wrapper-license.conf としてコピーされます。 それより長く実行するには、トライアルライセンス、サーバーライセンス、または開発用ライセンスで更新する必要があります。

実行

コンソールで実行する場合、

  • bin/service.bat console を実行してください。

Windows Service として実行する場合、下記のコマンドを実行してください。

  • サービスインストール:bin/service.bat install

  • サービス開始:bin/service.bat start

  • サービス停止:bin/service.bat stop

  • サービスアンインストール:bin/service.bat remove

使用可能なコマンドの一覧を表示するには、

  • bin/service.bat を実行してください。

ログファイル logs/wrapper.log を tail コマンド等で監視することで、Wrapper のログ出力と Java からのコンソール出力を併せて確認できます。 また、その他の Jetty ログファイルもこのディレクトリ内に保存されます。

フィードバックのお願い

Jetty のパワーユーザーの方で、本ドキュメントの改善点等のご提案がございましたら、ぜひ support@tanukisoftware.com までご連絡いただけますと幸いです。