WebApplication Toolkit リファレンス

このページではサーブレットの構成やコンテンツ作成のためのリファレンスを記述しています。Java でのコーディングは API リファレンスを参照してください。

XSLサーブレット

<!-- web.xml 記述例 -->
<servlet>
  <servlet-name>XSLTServlet</servlet-name>
  <servlet-class>org.koiroha.kwt.xsl.XSLTServlet</servlet-class>
  <init-param>
    <param-name>default-xsl-uri</param-name>
    <param-value>/style/default.xsl</param-value>
  </init-param>
</servlet>
<servlet-mapping>
  <servlet-name>XSLTServlet</servlet-name>
  <url-pattern>*.xhtml</url-pattern>
</servlet-mapping>

サーブレットパラメータ

利用可能なサーブレットパラメータは Config クラスに定義されています。

default-xsl-uri

処理対象の XML ファイル内にスタイルシートが指定されていなかった場合に使用するデフォルトの XSL ファイルです。/foo.xsl のように Web アプリケーションルートからのパスで指定します。値を省略した場合は XSL 変換処理は行われず、変換ハンドラの処理を行った状態の XML が出力されます。

<init-param> <!-- 例 -->
    <param-name>default-xsl-uri</param-name>
    <param-value>/default.xsl</param-value>
</init-param>

dtd-validation-error

XML ファイル読み込み時の DTD 検証に失敗した場合の挙動を指定します。 fail を指定した場合、検証に失敗すると 500 Internal Server Error が発生します。エラーにせず内容をログに出力する場合は logging(level) を指定します (level には severe, warning, info, fine, finer, finest などが使用できます)。値を省略した場合は DTD 検証を行いません。

<init-param> <!-- 例:警告レベルでログに出力するのみの場合 -->
    <param-name>dtd-validation-error</param-name>
    <param-value>logging(warning)</param-value>
</init-param>

xml-schema-validation-error

XML ファイル読み込み時の XML Schema 検証に失敗した場合の挙動を指定します。 fail を指定した場合、検証に失敗すると 500 Internal Server Error が発生します。エラーにせず内容をログに出力する場合は logging(level) を指定します (level には severe, warning, info, fine, finer, finest などが使用できます)。値を省略した場合は XML Schema 検証を行いません。

<init-param> <!-- 例:500 Internal Server Error にする場合 -->
    <param-name>xml-schema-validation-error</param-name>
    <param-value>fail</param-value>
</init-param>

use-compression

クライアントが GZIP 圧縮に対応している場合にレスポンスを圧縮して送信するかどうかを true または false で指定します (圧縮は XSL 変換時に行われます)。デフォルトは true です。

keep-transformed-xml

変換に使用した XML を一時ファイルに保存しておくかどうかを true または false で指定します。この機能は変換ハンドラがどのように XML を加工したかを調べるために用意されています。デフォルトは false です。

transformation-handlers

XML ファイルから構築した DOM を XSL 変換処理前に加工するための変換ハンドラを完全修飾名で列挙します。セパレータには空白かコンマが使用できます。

<init-param> <!-- 例 -->
    <param-name>transformation-handlers</param-name>
    <param-value>
        org.koiroha.kwt.xsl.handler.SourceFormatHandler
        com.foo.handler.MyHandler
    </param-value>
</init-param>

schema-catalog

スキーマカタログの場所を Web アプリケーションルートからのパスで指定します。

<init-param> <!-- 例 -->
    <param-name>schema-catalog</param-name>
    <param-value>/WEB-INF/schema-catalog.xml</param-value>
</init-param>

XSLパラメータ

XSL ファイル内では以下のパラメータを使用することが出来ます (<xsl:param> 宣言が必要)。

日時やリクエストパラメータのような処理ごとに結果がパラメータは変換結果のキャッシュを保証できないため渡されません。動的な内容が必要な場合は Ajax や JSP を使用してください。